go语言 从命令行获取参数解析

Posted 2021-11-29

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

os.Args

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

package main
import "fmt"
import "os"
func main(){
    if len(os.Args)>0 {
        for index , value := range os.Args {
            fmt.Println(index, value)
        }
    }
}

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

0 ./args_demo
1 a
2 b
3 c
4 d

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

flag包的基本使用

本文介绍了flag包的常用函数以及基本用法，更详细的内容请参考官方文档。

导入flag包

import flag

flag参数类型

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

flag.Type()

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

    name := flag.String("name","ali","姓名")
    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.Duration(&delay,"d",0,"时间间隔")

flag.Parse()

通过以上两种方法定义命令行flag参数后，需要通过调用flag.Parse()来对命令行参数进行解析。
支持的命令行参数格式有一下几种：

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

其中，布尔类型的参数必须用等号的方式指定。
flag在解析第一个非flag参数之前停止，或者在终止符"-"之后停止。

flag其他函数

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

完整示例

package main
import (
    "fmt"
    "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()
    fmt.Println(name,age,married,delay)
    fmt.Println(flag.Args())
    fmt.Println(flag.NArg())
    fmt.Println(flag.NFlag())

}

正常使用命令行flag参数:

 ./args_demo --name 霍帅兵 --age 18 --married=false -d 1h30m
霍帅兵 18 false 1h30m0s
[]
0
4

使用非flag命令行参数：

./args_demo a b c
张三 18 false 0s
[a b c]
3
0