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