Go flag 包最简使用教程

本文介绍 Go 语言中解析命名命令行参数（如 -port=8080 或 --verbose）的最简洁、标准且健壮的方式——使用内置的 flag 包，替代手动切分 os.Args，实现类型安全、自动帮助生成与参数校验。

本文介绍 Go 语言中解析命名命令行参数（如 `-port=8080` 或 `--verbose`）的最简洁、标准且健壮的方式——使用内置的 `flag` 包，替代手动切分 `os.Args`，实现类型安全、自动帮助生成与参数校验。

在 Go 中，直接操作 os.Args（如 strings.Split(os.Args[3], "=")）虽能临时提取键值对，但存在严重缺陷：缺乏类型检查、无法处理布尔/整型等原生类型、不支持短选项（-v）与长选项（--verbose）混合、无自动错误提示和 --help 支持，且易因索引越界或格式错误导致 panic。

推荐方案：使用标准库 flag 包
flag 是 Go 官方维护、零依赖、开箱即用的命令行参数解析工具。它支持：

• 命名参数（-name=value、--name value、-n value）
• 多种数据类型（string、int、bool、duration 等）
• 默认值设定与必填校验
• 自动生成 -h / --help 文档
• 参数别名与环境变量回退（需配合 pflag 等第三方包，但基础功能已足够精简）

✅ 示例：构建一个支持 -host、-port 和 -debug 的工具

package main

import (
    "flag"
    "fmt"
    "log"
)

func main() {
    // 定义参数变量（自动绑定类型与默认值）
    var (
        host  = flag.String("host", "localhost", "server hostname")
        port  = flag.Int("port", 8080, "server port number")
        debug = flag.Bool("debug", false, "enable debug mode")
    )

    // 解析命令行（必须在定义后、使用前调用）
    flag.Parse()

    // 使用解析后的值（类型安全，无需手动转换）
    fmt.Printf("Connecting to %s:%d\n", *host, *port)
    if *debug {
        log.Println("Debug mode enabled")
    }

    // 可选：打印未被 flag 解析的额外参数（如子命令或文件路径）
    fmt.Printf("Non-flag args: %v\n", flag.Args())
}

编译并运行：

go build -o mytool .
./mytool -host=api.example.com -port=3000 -debug
# 输出：
# Connecting to api.example.com:3000
# Debug mode enabled
# Non-flag args: []

还可支持多种等效写法：

./mytool --host db.local --port 5432     # 长选项 + 空格
./mytool -h localhost -p 8080            # 短选项（需显式注册，见下文）
./mytool -debug=true                     # 显式布尔赋值（可省略 `=true`）

? 进阶技巧（保持简洁前提下增强可用性）

• 注册短选项：在定义时调用 flag.String("h", ...) 并在文档中说明 -h 是 -host 的别名；
• 必需参数检查：

  if *host == "" {
      log.Fatal("error: -host is required")
  }

• 自定义用法提示：通过 flag.Usage = func(){...} 覆盖默认 help 输出。

⚠️ 注意事项：

• flag.Parse() 必须在所有 flag.Xxx() 调用之后、首次读取参数值之前执行；
• 所有 flag.Xxx() 返回的是指针，使用时需解引用（如 *host）；
• flag.Args() 返回未被 flag 拦截的剩余参数（常用于文件路径、子命令）；
• 不要混用 flag 与手动 os.Args 解析——flag.Parse() 会重置 os.Args，导致后续索引失效。

总结：flag 包是 Go 生态中最简洁、最标准、最可靠的命名参数解决方案。它以极少代码（通常 3–5 行定义 + 1 行解析）提供工业级健壮性，远优于手动字符串分割。对于绝大多数 CLI 工具，无需引入任何第三方依赖，开箱即用，即学即用。