flag.Parse()必须在所有flag定义之后调用,否则flag值保持默认零值;自定义类型需实现flag.Value接口;短选项需用Var系列函数复用变量;解析失败会调用Usage并退出。

flag.Parse() 必须在所有 flag 定义之后调用
Go 的 flag 包是惰性解析:它不会自动扫描 os.Args,必须显式调用 flag.Parse() 才真正读取参数。如果在定义 flag.String 之前就调用 flag.Parse(),会导致所有 flag 值为零值(如空字符串、0、false),且不报错——这是最常被忽略的逻辑顺序错误。
正确顺序是:定义 flag → 调用 flag.Parse() → 使用 flag 变量。
package main
import (
"flag"
"fmt"
)
func main() {
port := flag.String("port", "8080", "server port")
debug := flag.Bool("debug", false, "enable debug mode")
flag.Parse() // ✅ 必须放在这里
fmt.Printf("port=%s, debug=%t\n", *port, *debug)
}
- 命令行执行
go run main.go -port=3000 -debug输出:port=3000, debug=true - 若把
flag.Parse()移到两个flag.String和flag.Bool之前,*port永远是"8080"(默认值),*debug永远是false,哪怕传了-debug
自定义 flag 类型需实现 flag.Value 接口
当需要解析非内置类型(如逗号分隔的字符串切片、自定义结构体、时间范围等)时,不能直接用 flag.StringSlice 硬凑——它只按空格或引号分割,不支持逗号语法。此时必须实现 flag.Value 接口,即包含 Set(string) error 和 String() string 两个方法。
例如,解析 -tags=a,b,c 为 []string{"a","b","c"}:
立即学习“go语言免费学习笔记(深入)”;
type stringSlice []string
func (s *stringSlice) Set(value string) error {
*s = strings.Split(value, ",")
return nil
}
func (s *stringSlice) String() string {
return strings.Join(*s, ",")
}
func main() {
var tags stringSlice
flag.Var(&tags, "tags", "comma-separated list of tags")
flag.Parse()
fmt.Println(tags) // 如传 -tags=x,y,z → [x y z]
}
-
flag.Var是注册自定义 flag 的唯一入口,第一个参数是指针,第二个是 flag 名,第三个是帮助文本 - 注意
Set方法里必须解引用*s赋值,否则修改的是局部副本 - 如果
Set返回非 nil error,flag.Parse()会打印错误并退出程序
短选项(-h)和长选项(--help)共存需手动处理
flag 包默认不支持单字符短选项(如 -h),只支持长选项(如 --help)。若要同时支持两者,不能靠重命名 flag,而应分别定义两个 flag 并指向同一变量。
常见做法是用指针共享存储位置:
func main() {
help := flag.Bool("help", false, "show help message")
flag.BoolVar(help, "h", false, "show help message") // -h 绑定到同一 bool 指针
flag.Parse()
if *help {
flag.Usage()
return
}
}
-
flag.BoolVar第一个参数是已有变量的指针,第二、三、四个参数分别是 flag 名、默认值、说明 - 这样
-h和--help都能触发帮助输出 - 注意:不能对同一个变量多次调用
flag.Bool(会 panic:“flag redefined”),必须用Var系列函数复用
flag 解析失败时不自动退出,但 Usage 默认打印到 os.Stderr
flag.Parse() 在遇到未知 flag 或参数格式错误(如 -port=abc)时,会调用 flag.Usage() 并调用 os.Exit(2)。这个行为不可禁用,但可以重写 flag.Usage 来控制输出内容和目标位置。
例如,把错误提示重定向到 os.Stdout 并添加自定义前缀:
func main() {
flag.Usage = func() {
fmt.Fprint(os.Stdout, "Usage: myapp [flags]\n")
flag.PrintDefaults()
}
port := flag.String("port", "8080", "server port")
flag.Parse()
}
- 一旦重写了
flag.Usage,所有解析失败(包括-h、--help、无效参数)都会走这个函数 -
flag.PrintDefaults()会按定义顺序打印所有 flag 的默认值和说明,建议保留 - 如果你希望解析失败后不退出(比如嵌入到更大 CLI 中),无法绕过
os.Exit(2);此时应考虑用第三方库如spf13/cobra或手动解析os.Args










