Go语言标准库flag基本使用

Go语言内置的`flag`包实现了命令行参数的解析，`flag`包使得开发命令行工具更为简单。

os.Args

如果只是简单的想要获取命令行参数，可以像下面的代码示例一样使用os.Args来获取命令行参数。

package main

import (
	"fmt"
	"os"
)

func main() {
	if len(os.Args) > 0 {
		for index, arg := range os.Args {
			fmt.Println(index, arg)
			fmt.Printf("args[%d]=%v\n", index, arg)
		}
	}
	/*
		$ go run osArgs.go name shuke
		0 /var/folders/6v/nkxqpbk544g1w7qcd2__5w_h0000gn/T/go-build171479563/b001/exe/osArgs
		args[0]=/var/folders/6v/nkxqpbk544g1w7qcd2__5w_h0000gn/T/go-build171479563/b001/exe/osArgs
		1 name
		args[1]=name
		2 shuke
		args[2]=shuke
	*/
}

os.Args是一个用来存储命令行参数的字符切片，它的第一个元素是执行文件的名称。

flag包基本使用

下面主要介绍flag包的常用函数和基本使用，更详细的内容请查看官方文档

1. 导入flag包

1	import flag

1.1 flag参数类型

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

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

1.2 定义命令行flag参数

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

Flag.Type()

基本格式如下:

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

name := flag.String("name", "zhangsan", "姓名")
age := flag.Int("age", 18, "年龄")
married := flag.Bool("married", flase, "婚否")
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.Duration(&delay, "d", 0, "时间间隔")

flag.Parse()

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

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

flag xxx (使用空格，一个 -符号)
–flag xxx (使用空格，两个 – 符号)
-flag=xxx (使用等号，一个-符号)
–flag=xxx (使用等号，两个-符号)

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

Flag解析在第一个非flag参数(单个“-”不是flag参数)之前停止，或者在终止符’-‘之后停止

flag其他函数

1
2
3

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

example

定义

package main

import (
	"flag"
	"fmt"
	"os"
	"time"
)

func main() {
	if len(os.Args) > 0 {
		for index, arg := range os.Args {
			fmt.Println(index, arg)
			fmt.Printf("args[%d]=%v\n", index, arg)
		}
	}
	/*
		$ go run osArgs.go name shuke
		0 /var/folders/6v/nkxqpbk544g1w7qcd2__5w_h0000gn/T/go-build171479563/b001/exe/osArgs
		args[0]=/var/folders/6v/nkxqpbk544g1w7qcd2__5w_h0000gn/T/go-build171479563/b001/exe/osArgs
		1 name
		args[1]=name
		2 shuke
		args[2]=shuke
	*/

	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()
	fmt.Println(name, age, married, delay)
	// 返回命令行参数后的其他参数
	fmt.Println(flag.Args())
	// 返回命令行参数后的其他参数个数
	fmt.Println(flag.NArg())
	// 返回使用的命令行参数个数
	fmt.Println(flag.NFlag())
}

张三 18 false 0s
[]
0
0
```


>   使用

命令行参数使用提示:

```go
(base) ➜  LearGo go build osArgs.go 

LearGo ./osArgs -help
0 ./osArgs
args[0]=./osArgs
1 -help
args[1]=-help
Usage of ./osArgs:
  -age int
        年龄 (default 18)
  -d duration
        延迟加载的时间间隔
  -married
        婚否
  -name string
        姓名 (default "张三")

正常使用命令行flag参数:

(base) ➜  LearGo ./osArgs -name shke --age 19 -married=false -d=1h30m
shke 19 false 1h30m0s
[]
0
4

使用非flag命令行参数:

(base) ➜  LearGo ./osArgs a b c d                                    
张三 18 false 0s
[a b c d]
4
0