golang flag 命令行参数解析

基础例子

// 注册参数
port := flag.Int("p", 8080, "server Port")
// 解析参数, 模块方法将使用 os.Args[1:] 做参数解析 
flag.Parse()
fmt.Printf("server port:%d", port)

基础类型

• Flag 单条flag信息 type Flag struct { Name string // flag在命令行中的名字 Usage string // 帮助信息 Value Value // 要设置的值 DefValue string // 默认值（文本格式），用于使用信息 }
• FlagSet flag 设置对象 type FlagSet struct { // Usage函数在解析flag出现错误时会被调用 // 该字段为一个函数（而非采用方法），以便修改为自定义的错误处理函数 Usage func() // 内含隐藏或非导出字段 }

创建flagSet 对象

• NewFlagSet 创建命令参数配置对象 func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet // 之后文档中的 f 调用都指代该命令配置 f := flag.NewFlagSet("server commond", 0) p := f.Int("p", 8080, "server port") f.Parse(os.Args[1:]) fmt.Printf("prot: %d", *p)

flagSet 对象属性方法

• func Init 初始化 flagSet func (f *FlagSet) Init(name string, errorHandling ErrorHandling)
• func NFlag 获取解析的参数数量 func (f *FlagSet) NFlag() int fmt.Printf("args nubmer: %d", f.NFlag()) // shell // go run main.go -p 8080 // args number: 1
• func Lookup 获取指定命令参数信息 func (f *FlagSet) Lookup(name string) *Flag
• func NArg 获取解析后剩余参数的数量 func (f *FlagSet) NArg() int fmt.printf(">>> %d", f.NArg()) // shell // go run main.go -p 9001 8081 // >>> 1 // 这里 9001 将被解析到 flag 中，8081 为剩余参数
• func Args 获取剩余参数集合 func (f *FlagSet) Args() []string
• func Arg 获取指定位置的剩余参数 func (f *FlagSet) Arg(i int) string

打印信息

• func PrintDefaults 打印已注册的flag信息 func (f *FlagSet) PrintDefaults()
• func SetOutput 设置使用或错误信息的输出流 func (f *FlagSet) SetOutput(output io.Writer)

注册参数

• 布尔类型 bool
  • func Bool func (f *FlagSet) Bool(name string, value bool, usage string) *bool b := f.Bool("open", false, "open file")
  • func BoolVar func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string) var b bool f.BoolVar(&b, "open", false, "open file")
• 整型 int
  • func Int func (f *FlagSet) Int(name string, value int, usage string) *int
  • func IntVar func (f *FlagSet) IntVar(p *int, name string, value int, usage string)
  • Int64 / int64Var
• 无符号整型 Unit
  • Unit / UnitVar
  • Unit64 / Unit64Var
• 浮点型
  • Float64 / Float64Var
• 字符
  • String / StringVar
• time.Duration
  • func Duration func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration
  • func DurationVar func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string)
• 自定义参数
  • func Var func (f *FlagSet) Var(value Value, name string, usage string)

处理方法

• func Set 设置已注册参数值 func (f *FlagSet) Set(name, value string) error
• func Parse 解析参数 func (f *FlagSet) Parse(arguments []string) error // 解析命令参数 f.Parse(os.Args[1:])
• func Parsed 判断 Parse 是否被调用 func (f *FlagSet) Parsed() bool
• func Visit 遍历已注册参数 func (f *FlagSet) Visit(fn func(*Flag))
• func VisitAll 遍历所有参数，包括未设置 func (f *FlagSet) VisitAll(fn func(*Flag))

模块方法

除去新建和初始化，模块方法基本与对象方法一致， 部分方法配有默认值

• Parse 模块的Parse 将调用os.Args[1:] 作为函数参数， 既该函数调用时不需要传参 func Parse()

总结

1. flag 主要提供了一种参数解析方式，可以根据以注册命令参数， 解析不同的输出对象， 以获取所需信息。
2. flag 主要包含
   1. 对象的定义及工厂函数
   2. 各类型参数注册方法
   3. 信息获取函数

模块默认提供命令行的快捷方法。