Go 的 flag 包轻量但易踩坑:需手动处理 -h 支持、未知 flag 错误抑制、必需参数校验;flag.String() 返回 *string 以便 Parse 时写入值,取值须解引用;帮助和错误体验需自行完善。
Go 的 flag 包足够轻量,但默认行为容易让人踩坑——比如不加 -h 或 --help 就看不到用法,或者忘记调用 flag.Parse() 导致参数始终为空。
为什么 flag.String() 返回的是 *string 而不是 string
因为 flag.String() 需要将解析结果写入内存地址,它内部会把命令行值赋给一个局部变量,并返回该变量的指针。这样后续调用 flag.Parse() 时才能直接修改这个值。
- 如果你写
var name = flag.String("name", "default", "user name"),name是*string类型,取值必须用*name - 不能写成
name := *flag.String(...),这会导致编译错误:无法在函数调用中取地址 - 如果想直接拿到 string 值,得等
flag.Parse()执行完再解引用:fmt.Println(*name)
如何让 -h / –help 自动生效且不报错
flag 默认不支持 -h,只认 -help;而且一旦传入未知 flag(比如拼错的 -nmae),程序会打印错误并直接退出——这对 CLI 工具很不友好。
- 启用短选项支持:在
flag.Parse()前加flag.CommandLine.Init(os.Args[0], flag.ContinueOnError),但这还不够 - 更稳妥的做法是手动注册
-h:flag.Bool("h", false, "show help"),然后在flag.Parse()后检查:if *helpFlag || *hFlag { flag.Usage(); os.Exit(0) } - 避免因未知 flag 退出:用
flag.CommandLine.SetOutput(io.Discard)抑制默认错误输出,再自己处理flag.ErrHelp和其他错误
如何区分必需参数和可选参数
flag 本身不提供“必需”语义,所有 flag 都是可选的。是否必需,完全由你解析后校验逻辑决定。