14.Go语言标准库flag基本使用

Posted 2021-03-11

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

1.os.Args

如果你只是简单的想要获取命令行参数，可以像下面的代码示例一样使用os.Args来获取命令行参数。
os.Args十一个存储命令行参数的字符串切片，它的第一个元素是执行文件的名称。

package main

import (
    "fmt"
    "os"
)

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

结果：
?  test go build -o "args_demo"
?  test ./args_demo a b c d
args[0]=./args_demo
args[1]=a
args[2]=b
args[3]=c
args[4]=d

2.flag包基本使用

2.1flag参数类型

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

2.2定义命令行flag参数

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

2.2.1flag.Type()

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

package main

import (
    "flag"
    "fmt"
)

func main() {
    name := flag.String("name", "张三", "姓名")
    age := flag.Int("age", 18, "年龄")
    married := flag.Bool("married", false, "婚否")
    delay := flag.Duration("d", 0, "时间间隔")
    //注意：name,age,married,delay为对应类型的指针
    fmt.Println(*name,*age,*married,*delay)

}

结果：
张三 18 false 0s

Process finished with exit code 0

2.2.2flag.TypeVar()

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

package main

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

func main() {
    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, "时间间隔")
    fmt.Println(name,age,married,delay)

}

结果：
张三 18 false 0s

Process finished with exit code 0

2.2.3flag.Parse()

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

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

-flag xxx （使用空格，一个-符号）
--flag xxx （使用空格，两个-符号）
-flag=xxx （使用等号，一个-符号）
--flag=xxx （使用等号，两个-符号）
其中，布尔类型的参数必须使用等号的方式指定。

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

package main

import (
    "flag"
    "time"
)

func main() {
    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()

}

结果：
?  test go build -o "args_demo"
?  test ./args_demo -help      
Usage of ./args_demo:
  -age int
        年龄 (default 18)
  -d duration
        时间间隔
  -married
        婚否
  -name string
        姓名 (default "张三")
?  test 

2.2.4flag其他函数

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

2.3完整示例

package main

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

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())

}

命令行蚕食使用提示：
?  test go build -o "args_demo"
?  test ./args_demo -help      
Usage of ./args_demo:
  -age int
        年龄 (default 18)
  -d duration
        延迟的时间间隔
  -married
        婚否
  -name string
        姓名 (default "张三")

正常使用命令行glag参数
?  test ./args_demo -name lili --age 27 -married=false -d=1h30m
lili 27 false 1h30m0s
[]
0
4

使用非flag命令行参数
?  test ./args_demo a b c                                      
张三 18 false 0s
[a b c]
3
0
?  test ./args_demo -a l -b l
flag provided but not defined: -a
Usage of ./args_demo:
  -age int
        年龄 (default 18)
  -d duration
        延迟的时间间隔
  -married
        婚否
  -name string
        姓名 (default "张三")
?  test