如何使用Golang flag解析命令行参数_命令行工具开发基础

flag.Parse()必须在所有flag定义之后调用，否则未注册的flag无法被解析；flag.String返回指针，flag.StringVar绑定已有变量；自定义flag.Value可支持CSV等复杂类型解析。

flag.Parse() 必须在所有 flag 定义之后调用

很多新手会在定义 flag.String 之前就调用 flag.Parse()，结果得到空值或 panic。Go 的 flag 包是“注册式”设计：所有 flag.Xxx() 调用只是向全局 FlagSet 注册参数，真正解析发生在 flag.Parse() 执行时。

• 错误写法：

  flag.Parse()
  name := flag.String("name", "", "user name")

• 正确顺序：

  name := flag.String("name", "", "user name")
  age := flag.Int("age", 0, "user age")
  flag.Parse() // 必须放最后

• 如果提前调用，flag.Parse() 会解析空参数列表，后续注册的 flag 不会被识别，*name 始终为 ""

区分 flag.String 和 flag.StringVar 的使用场景

flag.String 返回 **指针**，适合快速声明+解引用；flag.StringVar 直接绑定已有变量，更适合结构体字段或需复用变量名的场景。

• 用 flag.String：适合简单脚本，变量生命周期短

  host := flag.String("host", "localhost", "server host")
  port := flag.Int("port", 8080, "server port")
  flag.Parse()
  fmt.Printf("connect to %s:%d", *host, *port)

• 用 flag.StringVar：适合与 struct 字段对齐、避免重复声明

  type Config struct {
      Host string
      Port int
  }
  var cfg Config
  flag.StringVar(&cfg.Host, "host", "localhost", "server host")
  flag.IntVar(&cfg.Port, "port", 8080, "server port")
  flag.Parse()

• 注意：传入 StringVar 的必须是指针，否则编译报错 cannot use cfg.Host (type string) as type *string

自定义 flag.Value 实现复杂类型解析（如 CSV 列表）

内置 flag 不支持直接解析逗号分隔的字符串切片（如 -tags=a,b,c），但可通过实现 flag.Value 接口解决。

• 核心是实现 Set(string) error 和 String() string 方法

  type StringList []string
  func (s *StringList) Set(value string) error {
      *s = strings.Split(value, ",")
      return nil
  }
  func (s *StringList
  ) String() string {
      return strings.Join(*s, ",")
  }
  
  var tags StringList
  flag.Var(&tags, "tags", "comma-separated list of tags")
  flag.Parse()

• 调用示例：./app -tags=dev,api,debug → tags 变量值为 []string{"dev","api","debug"}
• 容易漏掉：忘记在 Set 中做 trim 或去重，导致空字符串混入切片（如 -tags=a,,b 会生成 ["a", "", "b"]）

flag.Parse() 后如何检测未识别参数和帮助信息

flag.Parse() 默认遇到未知 flag 会自动退出并打印 usage，但有时需要捕获错误或自定义提示逻辑。

• 默认行为：输入 ./app -unknown 会输出错误 + usage 并 exit(2)，无法拦截
• 启用宽松模式（跳过未知 flag）：

  flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ContinueOnError)
  // 然后定义 flag、调用 Parse()
  err := flag.Parse()
  if err == flag.ErrHelp {
      // 用户显式传了 -h 或 --help
  } else if err != nil && err != flag.ErrHelp {
      // 其他解析错误，如类型不匹配
  }

• 检查是否还有剩余参数（非 flag 参数）：

  flag.Parse()
  args := flag.Args() // 返回命令行中 flag 之后的所有字符串
  if len(args) > 0 {
      fmt.Println("positional args:", args)
  }

• 注意：flag.Args() 不包含命令本身（os.Args[0]），只从第一个非 flag token 开始取

命令行参数解析看似简单，但 flag 初始化顺序、指针/值语义、自定义类型边界处理，三处最容易出 silent bug —— 尤其在多人协作或后期加新参数时。