GO标准库之flag的基本使用

flag包实现了命令行参数的解析，让我们使用命令行参数更加方便。

这里并不会牵涉到flag包的源码，仅仅总结其常见用法以及注意事项，想更深了解flag解析的原理，自己查看文档https://studygolang.com/static/pkgdoc/pkg/flag.htm 或者ide直接进入源码查看。

导入flag包

import flag

flag支持的参数类型

flag包支持的命令行参数类型有bool、int、int64、uint、uint64、float float64、string、duration。

flag参数	有效值
字符串flag	合法字符串
整数flag	1234、0664、0x1234等类型，也可以是负数。
浮点数flag	合法浮点数
bool类型flag	1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False。
时间段flag	任何合法的时间段字符串。如”300ms“、”-1.5h“、“2h45m”。合法的单位有”ns“、“us” /“µs”、“ms”、“s”、“m”、“h”。

定义命令行flag参数

有以下两种常用的定义命令行flag参数的方法。

flag.Type()

基本格式如下：

flag.Type(flag名, 默认值, 帮助信息)*Type 例如我们要定义姓名、年龄、婚否三个命令行参数，我们可以按如下方式定义：

name := flag.String("name", "张三", "姓名")
age := flag.Int("age", 18, "年龄")
married := flag.Bool("married", false, "婚否")
delay := flag.Duration("d", 0, "时间间隔")

需要注意的是，此时name、age、married、delay均为对应类型的指针。

flag.TypeVar()

基本格式如下： flag.TypeVar(Type指针, flag名, 默认值, 帮助信息) 例如我们要定义姓名、年龄、婚否三个命令行参数，我们可以按如下方式定义：

var name string
var age int
var married bool
var delay time.Duration
flag.StringVar(&name, "name", "张三", "姓名")
flag.IntVar(&age, "age", 18, "年龄")
flag.BoolVar(&married, "married", false, "婚否")
flag.DurationVar(&delay, "d", 0, "时间间隔")

flag.Parse()

通过以上两种方法定义好命令行flag参数后，需要通过调用flag.Parse()来对命令行参数进行解析。

支持的命令行参数格式有以下几种：

• -flag xxx （使用空格，一个-符号）
• --flag xxx （使用空格，两个-符号）
• -flag=xxx （使用等号，一个-符号）
• --flag=xxx （使用等号，两个-符号）

其中，布尔类型的参数必须使用等号的方式指定。

Flag解析在第一个非flag参数（单个”-“不是flag参数）之前停止，或者在终止符”–“之后停止。

flag其他函数

flag.Args()  ////返回命令行参数后的其他参数，以[]string类型
flag.NArg()  //返回命令行参数后的其他参数个数
flag.NFlag() //返回使用的命令行参数个数

完整示例

定义

func main() {
	//使用Type方式定义flag参数(返回类型为指针)
	username := flag.String("username", "张三", "姓名")
	age := flag.Int("age", 18, "年龄")
	active := flag.Bool("active", true, "状态")
	onlineTime := flag.Duration("d", 0, "在线时长")

	//使用TypeVar方式定义flag参数
	var fans int64
	flag.Int64Var(&fans, "fans", 0, "粉丝数量")

	//解析命令行参数
	flag.Parse()

	//打印对应参数值
	fmt.Println(*username, *age, *active, *onlineTime, fans)

	fmt.Println("返回命令行参数后的其他参数:", flag.Args())
	fmt.Println("返回命令行参数后的其他参数个数:", flag.NArg())
	fmt.Println("返回使用的命令行参数个数:", flag.NFlag())
}

使用

命令行参数使用提示：

>main.exe -help
Usage of main.exe:
  -active
        状态 (default true)
  -age int
        年龄 (default 18)
  -d duration
        在线时长
  -fans int
        粉丝数量
  -username string
        姓名 (default "张三")

注意：win下编译的exe，linux下直接main -help即可

正常使用命令行flag参数：

>main.exe --username 张翠山 -age 22 --active=false -d=39m -fans=999
张翠山 22 false 39m0s 999
返回命令行参数后的其他参数: []
返回命令行参数后的其他参数个数: 0
返回使用的命令行参数个数: 5

注意：上述参数中有一个参数为d的，其原始定义里使用的是onlineTime := flag.Duration("d", 0, "在线时长") 参数名与变量名并不一致，实际携带参数名应为flag定义的参数名，即d

非法使用命令行flag参数1：

>main.exe --username 张翠山 -age 22 --active=false -d=39m -aa=cc bb=dd ee ff
flag provided but not defined: -aa
Usage of main.exe:
  -active
        状态 (default true)
  -age int
        年龄 (default 18)
  -d duration
        在线时长
  -fans int
        粉丝数量
  -username string
        姓名 (default "张三")

我们携带了未定义的参数aa，所以直接报错。

非法使用命令行flag参数2：

>main.exe --username 张翠山 -age 22 --active=false -d=39m aa=bb cc dd
张翠山 22 false 39m0s 0
返回命令行参数后的其他参数: [aa=bb cc dd]
返回命令行参数后的其他参数个数: 3
返回使用的命令行参数个数: 4

上述未携带fans，故fans使用了默认值：0；aa=bb、cc、dd都当成了一个独立的参数，且因为不管aa=bb还是cc、dd都不是我们正确使用flag参数的方式，所以这里把他当成了其他参数。

非法使用命令行flag参数3：

>main.exe --username 张翠山 -age 22 --active=false aa=bb  -d=39m cc -fans 999
张翠山 22 false 0s 0
返回命令行参数后的其他参数: [aa=bb -d=39m cc -fans 999]
返回命令行参数后的其他参数个数: 5
返回使用的命令行参数个数: 3

上述使用方式，将不合格的参数使用aa=bb和cc，导致非法参数前的flag参数都能正常解析，收个非法参数之后的所有合法参数也不会正常解析了，都当成一个其他参数来处理了

综上所述：使用flag，就要合法的使用flag规定的参数定义方式才能够正常解析。

突然发现之前系列文档里有这个的使用说明：【Go入门指南系列-XII-IV-从命令行读取参数】，汗汗汗……

文献来源：https://liwenzhou.com/posts/Go/flag/