Go 语言 flag 包是轻量级命令行参数解析工具,支持字符串/整数/布尔等类型声明、短长选项、自定义 Value 接口、帮助信息定制及错误处理。
Go 语言内置的 flag 包是解析命令行参数最常用、最轻量的方式,适合大多数 CLI 工具开发场景。它不依赖第三方库,语法简洁,且能自动生成帮助信息。
基础用法:定义并解析字符串、整数等常见类型
通过 flag.String、flag.Int、flag.Bool 等函数声明参数变量,再调用 flag.Parse() 解析命令行输入。
-
flag.String("name", "default", "help message")返回一个指向字符串的指针,值为用户传入的参数或默认值 - 参数名(如
"name")对应命令行中的-name value或--name=value - 若未提供该参数,自动使用默认值;若必须提供,可在解析后检查是否为空或为零值
支持短选项与长选项:提升用户体验
flag 默认支持短选项(如 -f)和长选项(如 --file),只需分别调用两次声明即可:
filePtr := flag.String("f", "", "input file (short form)")flag.StringVar(filePtr, "file", "", "input file (long form)")- 这样
./app -f config.yaml和./app --file=config.yaml效果一致
自定义类型与动作:处理复杂输入逻辑
当需要校验格式(如邮箱、端口号)、累加多个值(如 -v -v -v 表示 debug 级别),可实现 flag.Value 接口或使用 flag.Var() 注册自定义变量。
立即学习“go语言免费学习笔记(深入)”;
- 例如实现一个支持多次出现的字符串切片:
var files []string,配
合自定义 Set方法追加值 - 也可在
flag.Parse()后手动遍历flag.Args()获取非标志位参数(如文件路径列表)
显示帮助与错误处理:让工具更友好
调用 flag.Usage = func() { ... } 可自定义帮助输出;默认情况下,传入 -h 或 --help 会触发 flag.PrintDefaults()。
- 解析失败时(如类型不匹配),
flag.Parse()会自动打印错误并调用os.Exit(2) - 若需捕获错误自行处理,可用
flag.CommandLine.SetOutput(ioutil.Discard)拦截输出,再手动检查 - 建议在
main()开头尽早调用flag.Parse(),避免逻辑错乱

合自定义 





