go的解析命令行库flag

简介

flag和log一样是Go的标准库。flag用于解析命令行的选项，例如命令ls -al列出当前目录下所有文件和目录的详细信息，其中-al就是命令行选项。

命令行选项在实际开发中很常用，特别是在一起命令行工具当中：

• redis指定配置文件的路径：redis-server ./redis.conf以当前目录下的redis.conf文件启动redis服务器。
• curl发起请求：curl -X POST https://www.baidu.com对https://www.baidu.com发起POST请求。

快速使用

var (
	name   string
	age    int
	gender bool
)

func main() {
	flag.Parse()

	fmt.Println("name :", name)
	fmt.Println("age :", age)
	fmt.Println("gender :", gender)
}

func init() {
	flag.StringVar(&name, "name", "", "name")
	flag.IntVar(&age, "age", 0, "age")
	flag.BoolVar(&gender, "gender", false, "gender: false is man")
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

可以使用先使用go build编译程序，然后再执行可执行文件，或者直接使用go run编译并执行程序，这里演示go run

$ go run main.go -name admin
1

输出：

name : admin
age : 0
gender : false
1
2
3

flag.TypeVar()的Type可以为基本的数据类型，如Int、String、Bool等。4个参数分别是：

1. 变量的地址
2. 选项名，也就是-后面需要跟的字符
3. 默认值。
4. 帮助信息，也就是在使用-h或者--help的时候输出的该选项的帮助信息。

最后在使用flag.Parse()完成解析，也就是说在flag.Parse()调用之后不能再定义选项了。众所周知，由于init()函数执行顺序是要早于main()函数的，所以建议在init()里定义选项，在main()中完成解析。总之就是选项的定义flag.TypeVar()一定要早于flag.Parse()。

选项格式

flag库支持三种命令行选项格式：

-flag
-flag=x
-flag x
1
2
3

第一种只支持Bool类型的选项。如，指定了-flag，那么该Bool类型的选项就是true。

高级用法

解析时间间隔time.duration

时间间隔支持的格式非常之多，例如"300ms"、“-1.5h”、“2h45m"等等等等。 时间单位可以是 ns/us/ms/s/m/h/day 等。实际上flag内部会调用time.ParseDuration。具体支持的格式可以参见time库的文档。

var (
	duration time.Duration
)

func main() {
	flag.Parse()

	fmt.Println("duration :", duration.String())
}

func init() {
	flag.DurationVar(&duration, "duration", time.Second, "duration of time")
}
1
2
3
4
5
6
7
8
9
10
11
12
13

参考

每日一库之flag