Go Flag使用教程

Flag库

flag库是Go语言标准库之一，提供了命令行参数解析的能力。

官方库文档翻译

参数类型

Go Flag 接受的参数类型

• bool
• int
• int64
• uint
• uint64
• string
• float64
• duration

除了以上8个类型外，flag允许用户自定义数据类型，但是该类型必须实现value接口。

使用

flag 会尝试解析绑定的参数，如果发生参数类型不匹配、无法解析等问题，将会导致执行停止。

绑定参数

flag包提供了两种绑定参数的方法

• type(…args) typePoint

• typeVar(typePoint, …args)

  type为基本参数类型

但是对用用户自定义的类型没有type()和typeVar()方法，而是Var方法.

type函数

type函数支持: bool int int64 uint uint64 string float64 duration

八种类型的函数定义除了类型不一样外，其他参数都是一样的，具体定义如下：

func Bool(name string, value bool, usage string) *bool
func Int(name string, value int, usage string) *int
func Int64(name string, value int64, usage string) *int64
func Uint(name string, value uint, usage string) *uint
func Uint64(name string, value uint64, usage string) *uint64
func String(name string, value string, usage string) *string
func Float64(name string, value float64, usage string) *float64
func Duration(name string, value time.Duration, usage string) *time.Duration    

函数参数说明：

• name: 参数名称
• value: 默认值
• usage: 使用方法、帮助文档

示例

func main(){
	boolVal := flag.Bool("testBool", false, "testBool is bool type.")
	flag.Parse()
	
	// 如果使用 -testBool作为参数，控制台将会打印 true, 否则打印 false
	fmt.println(boolVal)
}

typeVar函数

typeVar函数支持: bool int int64 uint uint64 string float64 duration

typeVar函数还另外包含了一种特殊的函数Var()，没有类型修饰。该函数用于绑定用户自定义的参数类型。

具体请看示例：

func main(){
    flag.BoolVar(&config.BoolValue, "bool", false, "This is bool value.")
	flag.IntVar(&config.IntValue, "int", 0, "This is int value.")
	flag.Int64Var(&config.Int64Value, "int64", 0, "This is int64 value.")
	flag.UintVar(&config.UintValue, "uint", 0, "This is uint value.")
	flag.Uint64Var(&config.Uint64Value, "uint64", 0, "This is uint64 value.")
	flag.StringVar(&config.StringValue, "string", "", "This is string value.")
	flag.Float64Var(&config.Float64Value, "float64", 0, "This is float64 value")
	flag.DurationVar(&config.DurationValue, "duration", time.Second * 0, "This is duration value.")
	flag.Var(&config.MyValue, "myValue", "This is my value.")
}

更完整的示例请看GoFlag.GO

参数语法

布尔类型

布尔类型为开关类型，后面可以不加参数。

如果不加参数，则一旦出现，默认为true，如果没有出现，则为用户定义的默认数据。

flag.BoolVar(&config.BoolValue, "bool", false, "This is bool value.")

• 如果使用指令: go run main.go -bool,则config.BoolValue被赋值为:true
• 如果使用指令: go run main.go，则config.BoolValue为默认值:false
• 如果修改代码为:

  flag.BoolVar(&config.BoolValue, "bool", true, "This is bool value.")
  

  则使用: go run main.go, config.BoolValue为默认值:true

布尔类型也可以显示声明，格式为-bool=t,t表示true。

bool类型可以接受的值包括：1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False

即go run GoFlag.go -bool=t等效于go run GoFlag.go -bool

Int Int64 Uint Uint64类型

四种类型区别不大，可以根据场景决定使用。

对于int int64类型来说，可以接受有效数据包括负数,而uint uint64则不支持负数。

这四种类型可以接受 123, 0x46等数据，但是不支持浮点类型，flag不会对数据进行转换。

同样，如果数据超出了类型的取值返回，数据也会被认为是无效的。

Go int8,16,32,64, uint8,16,32,64取值范围

int8: -128 ~ 127
int16: -32768 ~ 32767
int32: -2147483648 ~ 2147483647
int64: -9223372036854775808 ~ 9223372036854775807
uint8: 0 ~ 255
uint16: 0 ~ 65535
uint32: 0 ~ 4294967295
uint64: 0 ~ 18446744073709551615

不同平台中，int\uint的具体数据不一样，如64位系统中，int = int64, uint = uint64

浮点类型

flag 仅支持一种浮点类型：float64。

float参数 示例

$ go run GoFlag.go -float64 123.123
$ go run GoFlag.go -float64=123.123
$ go run GoFlag.go -float64 123e10

字符串类型

flag 包通过空格（没有被"标记的）进行参数切割，所以如果使用字符串，则在必要的情况下使用"

• 参数数据中存在空格情况则使用双引号: go run GoFlag.go -string "test 123 ", 此时string的值为test 123
• 参数数据种没有存在空格，则凭个人喜好使用: go run GoFlag.go -string test 123, 此时string的值为test

时间段类型

flag 可以将time.Duration支持的字符串转换为time.Duration类型。
如：300ms -1.5h 2h45m

有效的时间单位包括：ns, us (or µs), ms, s, m, h.

有关此部分的详细说明请查阅time.ParseDuration相关文档。

自定义类型

自定义的接口体实现了Value的Set(String)error方法，所以在检测到相关绑定数据后，flag包会传入一个字符串，进行解析。

同时，在使用的时候，该参数为数值类型（不是开关类型），需要指定数据。

子命令

flag 包提供了 FlagSet 结构体，用来封装更多形式的参数、命令。

默认使用flag时将会创建一个空的FlagSet。

使用：

func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet

该函数返回一个FlagSet，如果希望使用该FlagSet，需要手动调用该FlagSet的Parse()方法进行解析。

示例代码请看GoFlagSet.go