在写命令行程序时,对命令参数进行解析是常见的需求。各种语言一般都会提供解析命令行参数的方法或库,以方便程序员使用。如果命令行参数纯粹自己写代码解析,对于比较复杂的,还是挺费劲的。在Go标准库中提供了一个包:flag,方便进行命令行解析。
1、读取命令行参数
见如下 command-line-arguments.go 文件
package main
import "os"
import "fmt"
func main() {
//os.Args 提供原始命令行参数访问功能。注意,切片中的第一个参数是该程序的路径,
//并且 os.Args[1:]保存所有程序的的参数。
argsWithProg := os.Args
argsWithoutProg := os.Args[1:]
//你可以使用标准的索引位置方式取得单个参数的值。
arg := os.Args[3]
fmt.Println(argsWithProg)
fmt.Println(argsWithoutProg)
fmt.Println(arg)
}
/*
要实验命令行参数,最好先使用 go build 编译一个可执行二进制文件
$ go build command-line-arguments.go
$ ./command-line-arguments a b c d
[./command-line-arguments a b c d]
[a b c d]
c
*/
2、命令行标志的基本实现
令行标志是命令行程序指定选项的常用方式。例如,在 wc -l 中,这个 -l 就是一个命令行标志。
package main
// Go 提供了一个 flag 包,支持基本的命令行标志解析。我们将用这个包来实现我们的命令行程序示例。
import "flag"
import "fmt"
func main() {
//基本的标记声明仅支持字符串、整数和布尔值选项。这里我们声明一个默认值为 "foo" 的字符串标志 word并带有一个简短的描述。这里的 flag.String 函数返回一个字符串指针(不是一个字符串值),在下面我们会看到是如何使用这个指针的。
wordPtr := flag.String("word", "foo", "a string")
//使用和声明 word 标志相同的方法来声明 numb 和 fork 标志。
numbPtr := flag.Int("numb", 42, "an int")
//Bool类型的标志有点特别,在命令行中 使用 -fork 即可设置值为true
boolPtr := 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:", *boolPtr)
fmt.Println("svar:", svar)
fmt.Println("tail:", flag.Args())
}
/*
测试这个程序前,最好将这个程序编译成二进制文件,然后再运行这个程序。
$ go build command-line-flags.go
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
trailing: [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:
...
*/
3、命令行参数的进阶实现
package main
import (
"flag"
"os"
"log"
"fmt"
)
func printUsage() {
fmt.Println("Usage:")
fmt.Println("\taddblock -data DATA -- 交易数据.")
fmt.Println("\tprintchain -- 输出区块信息.")
}
func isValidArgs() {
if len(os.Args) < 2 {
printUsage()
os.Exit(1)
}
}
func main() {
isValidArgs()
addBlockCmd := flag.NewFlagSet("addBlock",flag.ExitOnError)
printChainCmd := flag.NewFlagSet("printchain",flag.ExitOnError)
flagAddBlockData := addBlockCmd.String("data","http://liyuechun.org","交易数据......")
switch os.Args[1] {
case "addBlock":
err := addBlockCmd.Parse(os.Args[2:])
if err != nil {
log.Panic(err)
}
case "printchain":
err := printChainCmd.Parse(os.Args[2:])
if err != nil {
log.Panic(err)
}
default:
printUsage()
os.Exit(1)
}
if addBlockCmd.Parsed() {
if *flagAddBlockData == "" {
printUsage()
os.Exit(1)
}
fmt.Println(*flagAddBlockData)
}
if printChainCmd.Parsed() {
fmt.Println("输出所有区块的数据........")
}
}
//go build -o bc main.go
//bc
// ./bc addBlock -data "liyuechun.org"
// ./bc printchain
// 即将输出所有block