Go 示例: 命令行标志

命令行标志 是为命令行程序指定选项的常用方法。例如,在 wc -l 中,-l 是一个命令行标志。

package main

Go 提供了一个 flag 包,支持基本的命令行标志解析。我们将使用此包来实现我们的示例命令行程序。

import (
    "flag"
    "fmt"
)
func main() {

基本标志声明可用于字符串、整数和布尔选项。这里我们声明一个字符串标志 word,其默认值为 "foo",并附带简短说明。此 flag.String 函数返回一个字符串指针(而不是字符串值);我们将在下面看到如何使用此指针。

    wordPtr := flag.String("word", "foo", "a string")

这声明了 numbfork 标志,使用与 word 标志类似的方法。

    numbPtr := flag.Int("numb", 42, "an int")
    forkPtr := flag.Bool("fork", false, "a bool")

还可以声明一个使用程序中其他地方声明的现有变量的选项。请注意,我们需要将指针传递给标志声明函数。

    var svar string
    flag.StringVar(&svar, "svar", "bar", "a string var")

声明完所有标志后,调用 flag.Parse() 执行命令行解析。

    flag.Parse()

这里我们将只转储解析后的选项和任何尾随位置参数。请注意,我们需要使用例如 *wordPtr 对指针进行解引用,以获取实际的选项值。

    fmt.Println("word:", *wordPtr)
    fmt.Println("numb:", *numbPtr)
    fmt.Println("fork:", *forkPtr)
    fmt.Println("svar:", svar)
    fmt.Println("tail:", flag.Args())
}

要试验命令行标志程序,最好先将其编译,然后直接运行生成的二进制文件。

$ go build command-line-flags.go

尝试使用构建的程序,首先为所有标志提供值。

$ ./command-line-flags -word=opt -numb=7 -fork -svar=flag
word: opt
numb: 7
fork: true
svar: flag
tail: []

请注意,如果省略标志,它们将自动采用其默认值。

$ ./command-line-flags -word=opt
word: opt
numb: 42
fork: false
svar: bar
tail: []

可以在任何标志之后提供尾随位置参数。

$ ./command-line-flags -word=opt a1 a2 a3
word: opt
...
tail: [a1 a2 a3]

请注意,flag 包要求所有标志都出现在位置参数之前(否则标志将被解释为位置参数)。

$ ./command-line-flags -word=opt a1 a2 a3 -numb=7
word: opt
numb: 42
fork: false
svar: bar
tail: [a1 a2 a3 -numb=7]

使用 -h--help 标志获取命令行程序的自动生成的帮助文本。

$ ./command-line-flags -h
Usage of ./command-line-flags:
  -fork=false: a bool
  -numb=42: an int
  -svar="bar": a string var
  -word="foo": a string

如果提供未指定给 flag 包的标志,程序将打印错误消息并再次显示帮助文本。

$ ./command-line-flags -wat
flag provided but not defined: -wat
Usage of ./command-line-flags:
...

下一个示例:命令行子命令.