Go 命令行参数

在终端运行程序时,我们经常会在命令后面附加上文件名或端口号等启动参数。但在 Go 语言中,作为程序入口的 main() 函数小括号里并不接收任何参数,那我们应该怎么在代码里获取这些启动参数呢?

在 Go 标准库中,获取命令行参数主要有 2 种常用方式:一种是使用 os 包的 os.Args 直接读取原始参数列表,另一种是使用 flag 包解析带名称的命令行选项。

使用 os.Args 获取原始参数

在 os 包中,os.Args 本质上是一个全局的字符串切片 []string,其中 Args 是英文 “arguments(参数)” 的缩写。程序启动时,操作系统会自动把命令行里以空格分隔的各个词按顺序装进这个切片中。

语法:

progPath := os.Args[0]
userArgs := os.Args[1:]

说明:

在使用 os.Args 时,我们需要分清下标 0 和后续下标的区别。下标为 0 的 os.Args[0] 固定保存当前运行程序自身的路径,而从下标 1 开始通过切片截取得到的 os.Args[1:] 才是我们在命令行里真正传入的参数。

示例 1:读取原始命令行参数

package main

import (
    "fmt"
    "os"
)

func main() {
    fmt.Println("参数总个数 =", len(os.Args))
    fmt.Println("程序路径 =", os.Args[0])

    // 遍历传入的实际参数
    for i, arg := range os.Args[1:] {
        fmt.Printf("参数 %d = %s\n", i+1, arg)
    }
}

运行结果如下。

参数总个数 = 1
程序路径 = /tmp/go-build/main

分析:

当我们不传任何额外参数直接运行程序时,os.Args 里只有表示程序路径的 os.Args[0]。此时 len(os.Args) 为 1,os.Args[1:] 则为空切片。

由于 go run 每次都会把代码临时编译到系统目录运行,不同系统看到的路径会不一样(Windows 下会带 .exe 后缀),这属于正常现象。

对于这个例子来说,如果我们在本地终端执行 go run main.go apple banana 命令传入两个参数,此时运行结果如下。

参数总个数 = 3
程序路径 = /tmp/go-build/main
参数 1 = apple
参数 2 = banana

从结果可以看出,传入的 apple 和 banana 依次保存在 os.Args[1] 和 os.Args[2] 中。通过 os.Args[1:] 正好跳过了开头的程序路径,把实际传入的参数全部遍历了出来。

注意: 如果运行程序时没有附带任何参数,os.Args 的长度就只有 1。因此,当我们想直接通过下标读取 os.Args[1] 时,必须先判断 len(os.Args) > 1,否则在未传参时会直接触发切片下标越界报错。

使用 flag 包解析命令行选项

如果程序只需要接收一两个文件名,按位置读取 os.Args 就够用了。但如果程序需要接收监听地址、端口号、调试开关等多个配置,靠位置顺序传参不仅容易记混顺序,也没法设置默认值。

在实际开发中,我们通常会采用 -host 127.0.0.1 -port 9000 -debug 这样带名称的选项格式。Go 标准库中的 flag 包专门用于解析这类命令行选项,主要有 “返回指针” 和 “绑定已有变量” 两种用法。

1. 定义选项并返回指针

在 flag 包中,我们可以直接调用 flag.String()、flag.Int() 和 flag.Bool() 来定义不同数据类型的命令行选项。

语法:

strPtr := flag.String("选项名", "默认字符串", "帮助说明")
intPtr := flag.Int("选项名", 默认整数, "帮助说明")
boolPtr := flag.Bool("选项名", 默认布尔值, "帮助说明")
flag.Parse()

说明:

这 3 个函数都接收 3 个参数,依次为:① 选项名称,注意前面不要加横杠(-);② 未传该选项时的默认值;③ 选项的用途说明。

需要特别注意的是,这 3 个函数返回的都是对应类型的指针,即 *string、*int 和 *bool。定义完所有选项后,我们必须调用一次 flag.Parse() 执行解析,随后通过星号解引用(如 *intPtr)就能读取到最终的参数值。

示例 2:定义并解析命令行选项

package main

import (
    "flag"
    "fmt"
)

func main() {
    // 1. 定义命令行选项并返回指针
    host := flag.String("host", "127.0.0.1", "服务器监听地址")
    port := flag.Int("port", 8080, "服务器监听端口")
    debug := flag.Bool("debug", false, "是否开启调试模式")

    // 2. 解析命令行参数
    flag.Parse()

    // 3. 通过解引用读取参数值
    fmt.Println("host =", *host)
    fmt.Println("port =", *port)
    fmt.Println("debug =", *debug)
}

运行结果如下。

host = 127.0.0.1
port = 8080
debug = false

分析:

当我们不传任何参数直接运行程序时,各项配置都会直接采用预设的默认值。如果我们在本地终端传入自定义选项,比如执行 go run main.go -host 0.0.0.0 -port 9000 -debug,此时运行结果如下。

host = 0.0.0.0
port = 9000
debug = true

在 flag 包中,命令行里写单横杠 -port 和双横杠 --port 效果完全一样。对于字符串和整数选项,使用空格或等号连接都可以,写 -port 9000 或 -port=9000 都能正常识别。

但对于布尔选项 -debug,规则略有不同:只要写上 -debug 就代表将其设为 true。如果我们想显式设为 false,就必须使用等号写成 -debug=false,不能用空格写成 -debug false。

为什么布尔选项不能用空格传 false 呢?因为在 flag 包的规则里,一旦遇到第一个不带横杠的普通词,flag.Parse() 就会立刻停止解析选项,并把后面的内容全部归入 flag.Args() 普通参数切片中。

如果误写成 -debug false -port 9000,中间的 false 就会被当成普通参数,导致后面的 -port 9000 完全失效。这一点小伙伴们在传参时要特别留意。

此外,初学者在使用 flag 包时,还容易把横杠写进选项名里,或者在调用 flag.Parse() 之前就去读取变量。

// 正确方式
port := flag.Int("port", 8080, "监听端口")
flag.Parse()
fmt.Println(*port)

// 错误方式
port := flag.Int("-port", 8080, "监听端口")
fmt.Println(*port)
flag.Parse()

在上面的错误方式中,定义选项时第 1 个参数只写纯名称 "port" 即可,不能把横杠带进去写成 "-port"。同时,我们必须在调用完 flag.Parse() 后再去读取 *port,否则无论命令行怎么传参,读出来的永远都是默认值 8080。

提示: 使用 flag 包还有一个很省心的功能:它会自动生成 -h(或 --help)帮助说明。我们不需要编写额外代码,只要在终端执行 go run main.go -h,程序就会自动把已定义的选项名称、类型、默认值和用途说明打印出来。

2. 绑定已有的普通变量

使用 flag.String() 和 flag.Int() 时,由于返回的是指针,后面每次读取都要在变量名前加星号,比如 *host、*port。如果小伙伴们希望直接把命令行选项解析到普通的 string 或 int 变量里,可以使用带 Var 后缀的绑定函数。

语法:

var 变量名 数据类型
flag.StringVar(&变量名, "选项名", "默认字符串", "帮助说明")
flag.IntVar(&变量名, "选项名", 默认整数, "帮助说明")
flag.BoolVar(&变量名, "选项名", 默认布尔值, "帮助说明")
flag.Parse()

说明:

flag.StringVar()、flag.IntVar() 和 flag.BoolVar() 没有返回值,我们只需把提前声明好的普通变量地址 &变量名 作为第 1 个参数传进去即可。调用 flag.Parse() 后,解析结果会直接写入该变量中,剩余未带横杠的位置参数则可以通过 flag.Args() 一并取出。

示例 3:将选项绑定到普通变量

package main

import (
    "flag"
    "fmt"
)

func main() {
    var env string
    var workers int

    // 绑定命令行选项到普通变量地址
    flag.StringVar(&env, "env", "dev", "运行环境")
    flag.IntVar(&workers, "w", 4, "工作协程数量")
    flag.Parse()

    fmt.Println("env =", env)
    fmt.Println("workers =", workers)
    fmt.Println("其他参数 =", flag.Args())
}

运行结果如下。

env = dev
workers = 4
其他参数 = []

分析:

在这个例子中,我们先声明了普通变量 env 和 workers,再通过 flag.StringVar(&env, ...) 和 flag.IntVar(&workers, ...) 把它们的地址传了进去。如果我们在本地终端执行 go run main.go -env prod -w 8 a.txt b.txt,此时运行结果如下。

env = prod
workers = 8
其他参数 = [a.txt b.txt]

解析完成后,后续代码直接读取 env 和 workers 即可,不用每次都在变量名前面写星号了。同时,跟在选项后面的 a.txt 和 b.txt 会被完整收进 flag.Args() 切片中,方便我们在处理完配置选项后再继续读取目标文件列表。

平时我们使用 go build 命令将程序编译成可执行文件后,可以根据参数复杂度来挑选写法。如果只需要传一两个固定顺序的文件名,直接用 os.Args[1:] 最轻便。如果包含多个配置项、需要默认值和 -h 帮助说明,我们就优先使用 flag 包。

上一篇:

下一篇:

给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号