大部分Go程序都是没有UI的,运行在纯命令行的模式下,该干什么全靠运行参数。
这里介绍下Go语言命令行程序和他们的参数。
一、os.args
程序获取运行他时给出的参数,可以通过os包来实现。先看代码:
package main
import (
"fmt"
"os"
"strconv"
)
func main () {
for idx, args := range os.Args {
fmt.Println("参数" + strconv.Itoa(idx) + ":", args)
}
}
运行起来得到的如下:
$go run main.go 1 3 -X ?
参数0: /tmp/go-build116558042/command-line-arguments/_obj/exe/main
参数1: 1
参数2: 3
参数3: -X
参数4: ?
可以看到,命令行参数包括了程序路径本身,以及通常意义上的参数。 程序中os.Args的类型是 []string ,也就是字符串切片。所以可以在for循环的range中遍历,还可以用 len(os.Args) 来获取其数量。
二、flags
flag包相比单纯的通过os.Args切片分析命令行参数,提供了更强的能力,同时也是风复杂的用法。
来看个例子:
package main
import (
"fmt"
"flag"
)
var b = flag.Bool("b", false, "bool类型参数")
var s = flag.String("s", "", "string类型参数")
func main() {
flag.Parse()
fmt.Println("-b:", *b)
fmt.Println("-s:", *s)
fmt.Println("其他参数:", flag.Args())
}
------------------------------------
$ go run main.go
-b: false
-s:
其他参数: []
------------------------------------
$ go run main.go -b
-b: true
-s:
其他参数: []
------------------------------------
$ go run main.go -b -s test others
-b: true
-s: test
其他参数: [others]
------------------------------------
$ go run main.go -help
Usage of /tmp/go-build080353851/command-line-arguments/_obj/exe/main:
-b bool类型参数
-s string
string类型参数
exit status 2
1.定义参数
使用flag包,首先定义待解析命令行参数,也就是以”-“开头的参数,比如这里的 -b -s -help等。-help不需要特别指定,可以自动处理。 这里指定了两个参数,-b和-s:
var b = flag.Bool("b", false, "bool类型参数")
var s = flag.String("s", "", "string类型参数")
-----------------
原型:
func Bool(name string, value bool, usage string) *bool
func String(name string, value string, usage string) *string
通过flag.Bool和flag.String,建立了2个指针b和s,分别指向bool类型和string类型的变量。所以后续要通过 *b 和 *s 使用变量值。
flag.Bool和flag.String的参数有3个,分别是命令行参数名称,默认值,提示字符串。
2.解析参数
flag使用前,必须首先解析:flag.Parse()
3.使用参数
上文已经说明,通过flag方法定义好的参数变量指针,通过间接引用操作即可使用其内容:
fmt.Println("-b:", *b)
fmt.Println("-s:", *s)
4.未解析参数
参数中没有能够按照预定义的参数解析的部分,通过flag.Args()即可获取,是一个字符串切片。fmt.Println("其他参数:", flag.Args())
需要注意的是,从第一个不能解析的参数开始,后面的所有参数都是无法解析的。即使后面的参数中含有预定义的参数:
$ go run main.go -b stop -s test others
-b: true
-s:
其他参数: [stop -s test others]
上面例子中,解析到stop,就已经无法继续解析了,即使后面给出了预定义好的-s,也是不能获取出来的。
5.推荐使用=号这种清晰写法
当我们这样传:-b true -s abc def waw
会发生什么?
b arg: true
s arg::
other arg: [true -s abc def waw]
原因是命令行语法主要有以下几种形式
-flag //只支持bool类型
-flag=x
-flag x //只支持非bool类型
所以上面那种写法,因为第三条-flag x //只支持非bool类型
,从true开始往后就是其他参数了。true之前的-b仍会按第一种-flag //只支持bool类型
解析为true。这么一看,还是第二种更规范易懂啊:
-b=true -s=abc def waw
6.更详细用法,可以参考1. 13.1 flag - 命令行参数解析