Go语言系列之标准库flag

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

os.Args

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

package main

import (
	"fmt"
	"os"
)

//os.Args demo
func main() {
	//os.Args是一个[]string
	if len(os.Args) > 0 {
		for index, arg := range os.Args {
			fmt.Printf("args[%d]=%vn", index, arg)
		}
	}
}

将上面的代码执行go build -o "args_demo"编译之后，执行：

$ ./args_demo a b c d
args[0]=./args_demo
args[1]=a
args[2]=b
args[3]=c
args[4]=d

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

flag包基本使用

本文介绍了flag包的常用函数和基本用法，更详细的内容请查看官方文档。

导入flag包

import flag

flag参数类型

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

定义命令行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() {
	//定义命令行参数方式1
	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())
}

使用

命令行参数使用提示：

E:goprojectsrcgo_devgo_flag>go build -o flag.exe main.go

E:goprojectsrcgo_devgo_flag>flag.exe --help
Usage of flag.exe:
  -age int
        年龄 (default 18)
  -d duration
        延迟的时间间隔
  -married
        婚否
  -name string
        姓名 (default "张三")

正常使用命令行flag参数：

E:goprojectsrcgo_devgo_flag>flag.exe -name 张亚飞 -age 25 --married=false -d=1h30m
张亚飞 25 false 1h30m0s
[]
0
4

使用非flag命令行参数：

E:goprojectsrcgo_devgo_flag>flag.exe a b c
张三 18 false 0s
[a b c]
3
0

示例

package main
import (
  "flag"
  "fmt"
)
//声明变量用于接收命令行传入的参数值
var (
  name string
  age int
  address *string
  id *int
)
func init() {
  //通过传入变量地址的方式，绑定命令行参数到string变量
  flag.StringVar(&name,   //第一个参数：存放值的参数地址
                 "name",  //第二个参数：命令行参数的名称
                "匿名",    //第三个参数：命令行不输入时的默认值
                "您的姓名") //第四个参数：该参数的描述信息，help命令时会显示

  //通过传入变量地址的方式，绑定命令行参数到int变量
  flag.IntVar(&age,        //第一个参数：存放值的参数地址
              "age",       //第二个参数：命令行参数的名称
              -1,          //第三个参数：命令行不输入时的默认值
              "您的年龄")   //第四个参数：该参数的描述信息，help命令时会显示

  //和前面两个变量的获取方式不同，这个api没有传入变量地址，而是把命令行参数值的地址返回了
  address = flag.String("address", //第一个参数：命令行参数的名称
                           "未知",     //第二个参数：命令行不输入时的默认值
                          "您的住址")   //第三个参数：该参数的描述信息，help命令时会显示
  id = flag.Int("id", //第一个参数：命令行参数的名称
                           -1,     //第二个参数：命令行不输入时的默认值
                          "身份ID")   //第三个参数：该参数的描述信息，help命令时会显示
}
func main() {
  //处理入参
  flag.Parse()
  //入参已经被赋值给各个变量，可以使用了
  fmt.Printf("%s您好, 您的年龄:%d, 您的住址:%s, 您的ID:%dnn", name, age, *address, *id)
  fmt.Println("---遍历有输入的参数（开始）---")
  //Visit方法会遍历有输入的参数，flag.Flag可以将参数的名称、值、默认值、描述等内容取到
  flag.Visit(func(f *flag.Flag){
    fmt.Printf("参数名[%s], 参数值[%s], 默认值[%s], 描述信息[%s]n", f.Name, f.Value, f.DefValue, f.Usage)
  })
  fmt.Println("---遍历有输入的参数（结束）---n")
  fmt.Println("---遍历所有的参数（开始）---")
  //VisitAll方法会遍历所有定义的参数(包括没有在命令行输入的)，flag.Flag可以将参数的名称、值、默认值、描述等内容取到
  flag.VisitAll(func(f *flag.Flag){
    fmt.Printf("参数名[%s], 参数值[%s], 默认值[%s], 描述信息[%s]n", f.Name, f.Value, f.DefValue, f.Usage)
  })
  fmt.Println("---遍历所有的参数（结束）---n")
}