Golang 命令行参数解析工具 argparse 使用指南

argparse 是一个受 Python 同名模块启发的 Go 语言命令行参数解析库，提供了简单易用的 API 来定义和解析命令行参数。

安装

go get github.com/akamensky/argparse

基础用法

1. 创建解析器

package main

import (
	"fmt"
	"github.com/akamensky/argparse"
	"os"
)

func main() {
	// 创建解析器
	parser := argparse.NewParser("myprogram", "这是一个示例程序")
	
	// 添加参数
	name := parser.String("n", "name", &argparse.Options{
		Required: true,
		Help:    "用户姓名",
	})
	
	age := parser.Int("a", "age", &argparse.Options{
		Help:    "用户年龄",
		Default: 18,
	})
	
	// 解析参数
	err := parser.Parse(os.Args)
	if err != nil {
		fmt.Print(parser.Usage(err))
		return
	}
	
	fmt.Printf("你好, %s! 年龄: %d\n", *name, *age)
}

2. 参数类型

argparse 支持多种参数类型：

// 字符串参数
strArg := parser.String("s", "string", &argparse.Options{
	Help: "字符串参数",
})

// 整数参数
intArg := parser.Int("i", "int", &argparse.Options{
	Help: "整数参数",
})

// 布尔参数
boolArg := parser.Flag("b", "bool", &argparse.Options{
	Help: "布尔参数",
})

// 浮点数参数
floatArg := parser.Float("f", "float", &argparse.Options{
	Help: "浮点数参数",
})

// 列表参数
listArg := parser.List("l", "list", &argparse.Options{
	Help: "列表参数",
})

3. 位置参数

file := parser.StringPositional(&argparse.Options{
	Help: "要处理的文件",
})

4. 子命令

// 创建主解析器
parser := argparse.NewParser("git", "版本控制工具")

// 添加子命令
cloneCmd := parser.NewCommand("clone", "克隆仓库")
pullCmd := parser.NewCommand("pull", "拉取更新")

// 为子命令添加参数
repo := cloneCmd.String("r", "repo", &argparse.Options{
	Required: true,
	Help:    "仓库地址",
})

// 解析
err := parser.Parse(os.Args)
if err != nil {
	fmt.Print(parser.Usage(err))
	return
}

if cloneCmd.Happened() {
	fmt.Printf("正在克隆仓库: %s\n", *repo)
} else if pullCmd.Happened() {
	fmt.Println("正在拉取更新...")
}

高级特性

1. 参数验证

port := parser.Int("p", "port", &argparse.Options{
	Help:    "端口号",
	Default: 8080,
	Validate: func(arg int) error {
		if arg < 1 || arg > 65535 {
			return fmt.Errorf("端口号必须在1-65535之间")
		}
		return nil
	},
})

2. 互斥参数

group := parser.Mutex()
inputFile := group.String("i", "input", &argparse.Options{Help: "输入文件"})
inputText := group.String("t", "text", &argparse.Options{Help: "输入文本"})

3. 环境变量支持

apiKey := parser.String("", "api-key", &argparse.Options{
	Help:    "API密钥",
	EnvVar:  "API_KEY", // 从环境变量读取
	Default: "",        // 默认值
})

完整示例

package main

import (
	"fmt"
	"github.com/akamensky/argparse"
	"os"
)

func main() {
	parser := argparse.NewParser("fileprocessor", "处理文件的工具")

	// 添加参数
	input := parser.String("i", "input", &argparse.Options{
		Required: true,
		Help:    "输入文件路径",
	})

	output := parser.String("o", "output", &argparse.Options{
		Help:    "输出文件路径",
		Default: "output.txt",
	})

	verbose := parser.Flag("v", "verbose", &argparse.Options{
		Help:    "显示详细输出",
	})

	workers := parser.Int("w", "workers", &argparse.Options{
		Help:    "工作线程数",
		Default: 4,
		Validate: func(arg int) error {
			if arg < 1 || arg > 16 {
				return fmt.Errorf("工作线程数必须在1-16之间")
			}
			return nil
		},
	})

	// 解析参数
	err := parser.Parse(os.Args)
	if err != nil {
		fmt.Print(parser.Usage(err))
		return
	}

	// 使用参数
	if *verbose {
		fmt.Printf("开始处理文件: %s\n", *input)
		fmt.Printf("工作线程数: %d\n", *workers)
	}

	// 模拟文件处理
	fmt.Printf("处理完成，结果保存到: %s\n", *output)
}

对比其他库

argparse 相比标准库 flag 包有以下优势：

1. 更接近 Python 的 argparse 风格，对熟悉 Python 的开发者更友好
2. 支持更丰富的参数类型和验证
3. 自动生成帮助信息
4. 支持子命令

相比 cobra 等更复杂的 CLI 库，argparse 更加轻量级，适合中小型项目。

总结

argparse 是一个简单易用的 Go 命令行参数解析库，特别适合需要快速构建命令行工具的场景。它提供了清晰的 API 和自动生成的帮助信息，能够满足大多数命令行参数处理需求。