Golang使用flag包实现命令行参数解析

flag.String 返回新分配字符串指针,每次调用新建内存;flag.StringVar 直接写入已有变量地址,不额外分配,更安全易调试。

flag.String 和 flag.StringVar 的核心区别在哪

区别在于变量绑定时机和内存管理方式。flag.String 返回一个指向新分配字符串的指针,每次调用都新建存储;flag.StringVar 直接将命令行值写入你已声明的变量地址,不额外分配。

实际开发中优先用 flag.StringVar,避免指针解引用出错,也更易调试:

var (
    configFile string
    verbose    bool
)
flag.StringVar(&configFile, "config", "config.yaml", "path to config file")
flag.BoolVar(&verbose, "v", false, "enable verbose output")

如果误用 flag.String 并忘记解引用,比如写成 if configFile == "xxx"(此时 configFile*string),编译会直接报错:invalid operation: == (mismatched types string and *string)

为什么 flag.Parse() 必须在所有 flag.Xxx 调用之后执行

flag.Parse() 不是“开始解析”,而是“触发解析并填充之前注册的所有变量”。它内部遍历全局 flag.FlagSet,逐个匹配 os.Args[1:] 中的参数并赋值。如果提前调用,后续注册的 flag 就不会被识别。

立即学习“go语言免费学习笔记(深入)”;

常见错误写法:

flag.Parse() // ❌ 错:此时还没注册任何 flag
flag.StringVar(&port, "port", "8080", "")

正确顺序必须是:

  • 先调用所有 flag.String/flag.IntVar 等注册函数
  • 再调用 flag.Parse()
  • 最后使用变量(或检查 flag.NArg()flag.Args() 获取非 flag 参数)

如何支持子命令(如 git commit / git push)

flag 包原生不支持子命令,强行用 flag.CommandLine 做二次解析容易混乱。推荐方案是:在 flag.Parse() 后手动提取第一个非 flag 参数作为子命令名,再用独立的 flag.NewFlagSet 解析其后续参数。

例如实现 mytool serve --port 3000mytool migrate --down

func main() {
    flag.Parse()
    args := flag.Args()
    if len(args) == 0 {
        log.Fatal("no subcommand specified")
    }

    switch args[0] {
    case "serve":
        serveCmd := flag.NewFlagSet("serve", flag.ContinueOnError)
        port := serveCmd.String("port", "8080", "server port")
        serveCmd.Parse(args[1:])
        fmt.Printf("starting server on port %s\n", *port)

    case "migrate":
        migrateCmd := flag.NewFlagSet("migrate", flag.ContinueOnError)
        down := migrateCmd.Bool("down", false, "roll back migration")
        migrateCmd.Parse(args[1:])
        if *down {
            fmt.Println("rolling back...")
        }
    }
}

注意 flag.ContinueOnError 防止子命令解析失败时整个程序退出;args[1:] 是关键——跳过子命令名本身。

自定义类型解析(比如把 "1d", "2h" 转成 time.Duration)

需要实现 flag.Value 接口,重点是 Set(string) 方法。Go 标准库的 time.Duration 已自带该实现,但很多自定义结构体需要手写。

例如支持 --timeout 5s--timeout 1m30s

type durationFlag time.Duration

func (d *durationFlag) Set(s string) error {
    dur, err := time.ParseDuration(s)
    if err != nil {
        return err
    }
    *d = durationFlag(dur)
    return nil
}

func (d *durationFlag) String() string {
    return time.Duration(*d).String()
}

// 使用:
var timeout durationFlag
flag.Var(&timeout, "timeout", "timeout duration (e.g. 30s, 2m)")

容易踩的坑:Set 方法必须修改接收者指向的值(即 *d),不能只改局部变量;String() 返回的字符串会出现在 -h 帮助里,建议返回用户友好的格式。

flag 包对类型安全很严格,一旦 Set 返回非 nil error,flag.Parse() 就会终止并打印错误——这是验证输入合法性最直接的方式。