在线文档  >   Golang练习   >   命令行标志

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

package main

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

func main() {

    // 可以为字符串、整数和布尔型选项提供基本的标志声明。
    // 在这里,我们声明了一个字符串标志 `word`,其默认值为 `"foo"`,并提供了一个短描述。
    // `flag.String` 函数返回一个字符串指针(而不是字符串值);我们将看到如何使用该指针。
    wordPtr := flag.String("word", "foo", "a string")

    // 这里使用了与 `word` 标志类似的方法来声明 `numb` 和 `fork` 标志。
    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:
...