Golang中命令行參數(shù)解析工具Flag包詳解
flag包作用
Golang中的flag包用于解析命令行參數(shù),提供了一個(gè)方便的接口來接收命令行參數(shù),并將其轉(zhuǎn)換為Go語言中的值。
使用方法
先看段示例代碼:
package main
import (
"flag"
"fmt"
)
func main() {
var name string
flag.StringVar(&name, "name", "luduoxin", "請(qǐng)輸入名稱:")
flag.Parse()
fmt.Printf("name: %s\n", name)
}
運(yùn)行一下看下效果。
$ go run ./main.go -name xiaoming
name: xiaoming
在命令行通過-name參數(shù)傳入xiaoming后,name這個(gè)變量獲取到了這個(gè)值。StringVar方法將參數(shù)綁定到指定的變量,該方法有四個(gè)參數(shù):
- 第一個(gè)是綁定的變量,指針類型。
- 第二個(gè)是參數(shù)名稱。
- 第三個(gè)是默認(rèn)值。
- 第四個(gè)是提示信息。
$ go run ./main.go -h
-name string
請(qǐng)輸入名稱: (default "luduoxin")
這里只是使用StringVar方法來舉例,還有很多和StringVar功能類似的方法,只是類型不同,如BoolVar、DurationVar、Float64Var、IntVar、Int64Var、UintVar和Uint64Var。這8個(gè)方法分別對(duì)應(yīng)著不帶Var的方法,如下String、Bool、Duration、Float64、Int、Int64、Uint和Uint64,以String為例:
package main
import (
"flag"
"fmt"
)
func main() {
name := flag.String("name", "luduoxin", "請(qǐng)輸入名稱:")
flag.Parse()
fmt.Printf("age: %T\n", name)
fmt.Printf("age: %s\n", *name)
}
運(yùn)行看下效果:
$ go run ./main.go -name xiaoming
age: *string
age: xiaoming
String規(guī)范法有三個(gè)參數(shù):
- 第一個(gè)參數(shù)是參數(shù)名稱
- 第二個(gè)參數(shù)是默認(rèn)值
- 第三個(gè)參數(shù)是提示信息
返回的是對(duì)應(yīng)的指針類型,獲取參數(shù)結(jié)果需要使用*name。
上面兩個(gè)實(shí)例中都調(diào)用了flag.Parse(),這個(gè)方法用來解析參數(shù),如果不調(diào)用該方法,參數(shù)不會(huì)被解析,但是可以獲得默認(rèn)值。注釋此方法運(yùn)行看下效果:
go run ./chan.go -name xiaoming
age: *string
age: luduoxin
雖然傳入了xiaoming,但值依然是默認(rèn)值luduoxin。
命令行參數(shù)語法
命令行傳參的語法有如下三種形式:
-flag 只支持bool類型
-flag=x
-flag x // 僅限非布爾類型的flag
例如如下示例:
package main
import (
"flag"
"fmt"
)
func main() {
var name string
flag.StringVar(&name, "name", "luduoxin", "請(qǐng)輸入名稱:")
flag.Parse()
fmt.Println(name)
}
可以使用如下方式傳參:
$ go run ./main.go -name=xiaoming
也可以使用如下方式傳參:
$ go run ./main.go -name xiaoming
自定義幫助信息
以上面的示例代碼為例,來看一下默認(rèn)幫助信息:
$ go run ./chan.go --help
Usage of xxx/main:
-name string
請(qǐng)輸入名稱: (default "luduoxin")
如果想改變幫助信息可以通過重寫Usage來實(shí)現(xiàn)。示例代碼如下:
package main
import (
"flag"
"fmt"
)
func main() {
var name string
flag.StringVar(&name, "name", "luduoxin", "請(qǐng)輸入名稱:")
flag.Usage = customUsage
flag.Parse()
flag.Usage()
fmt.Println(name)
}
func customUsage() {
fmt.Fprintf(flag.CommandLine.Output(), `nginx version: nginx/1.10.0
使用方法: nginx -v`)
flag.PrintDefaults()
}
運(yùn)行看下效果:
$ go run ./chan.go --help
nginx version: nginx/1.10.0
使用方法: nginx -v -name string
請(qǐng)輸入名稱: (default "luduoxin")
幫助信息已經(jīng)變成了自定義的了。
小結(jié)
關(guān)于flag的文章主要講了flag包中常用的功能,其他不太常用的功能需要自己去探索,借助flag包可以實(shí)現(xiàn)非常強(qiáng)大的命令行工具。如果項(xiàng)目需要使用到更復(fù)雜或更高級(jí)的命令行解析方式,可以自己借助flag包來封裝,也可以直接使用優(yōu)秀的三方包,例如https://github.com/urfave/cli和https://github.com/spf13/cobra。