快捷導(dǎo)航

深入解析golang中的標(biāo)準(zhǔn)庫flag

更新時(shí)間：2021年11月29日 14:47:53 作者：專職

Go語言內(nèi)置的flag包實(shí)現(xiàn)了命令行參數(shù)的解析，flag包使得開發(fā)命令行工具更為簡單，下面通過本文給大家詳細(xì)介紹下golang中的標(biāo)準(zhǔn)庫flag相關(guān)知識(shí)，感興趣的朋友一起看看吧

Go語言內(nèi)置的flag包實(shí)現(xiàn)了命令行參數(shù)的解析，flag包使得開發(fā)命令行工具更為簡單。

os.Args

如果你只是簡單的想要獲取命令行參數(shù)，可以像下面的代碼示例一樣使用os.Args來獲取命令行參數(shù)。

func main() {
	// 獲取命令行參數(shù)
	// os.Args：[]string
	if len(os.Args) > 0 {
		for i, v := range os.Args {
			fmt.Println(i, v)
		}
	}
}

執(zhí)行命令：go run .\main.go host:127.0.0.1 port:8080
輸出結(jié)果：

?C:\Users\mayanan\AppData\Local\Temp\go-build3549800423\b001\exe\main.exe

?host:127.0.0.1

?port:8080

os.Args是一個(gè)存儲(chǔ)命令行參數(shù)的字符串切片，它的第一個(gè)元素是執(zhí)行文件的名稱。

flag包基本使用

1.flag參數(shù)類型

flag包支持的命令行參數(shù)類型有bool、int、int64、uint、uint64、float float64、string、duration。

flag參數(shù)	有效值
字符串flag	合法字符串
整數(shù)flag	1234、0664、0x1234等類型，也可以是負(fù)數(shù)。
浮點(diǎn)數(shù)flag	合法浮點(diǎn)數(shù)
bool類型flag	1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False。
時(shí)間段flag	任何合法的時(shí)間段字符串。如”300ms”、”-1.5h”、”2h45m”。合法的單位有”ns”、”us” /“μs”、”ms”、”s”、”m”、”h”。

定義命令行flag參數(shù)

flag.Type()

基本格式如下：
flag.Type(flag名, 默認(rèn)值, 幫助信息)*Type例如我們要定義姓名、年齡、婚否三個(gè)命令行參數(shù)，我們可以按如下方式定義：

func main() {
	// flag.Type() 的使用
	name := flag.String("name", "張三", "姓名")
	age := flag.Int("age", 18, "年齡")
	married := flag.Bool("married", false, "婚否")
	delay := flag.Duration("d", 0, "時(shí)間間隔")

	flag.Parse()

	fmt.Println(*name, *age, *married, *delay)
}

終端輸入：
go run .\main.go -name lisi --age 88 -married=true --d=15s

輸出：
lisi 88 true 15s

flag.TypeVar()

基本格式如下： flag.TypeVar(Type指針, flag名, 默認(rèn)值, 幫助信息) 例如我們要定義姓名、年齡、婚否三個(gè)命令行參數(shù)，我們可以按如下方式定義：

func main() {
	var name string
	var age uint
	var married bool
	var d time.Duration

	flag.StringVar(&name, "name", "王五", "姓名")
	flag.UintVar(&age, "age", 18, "年齡")
	flag.BoolVar(&married, "m", false, "婚否")
	flag.DurationVar(&d, "duration", 0, "時(shí)間間隔")

	flag.Parse()

	fmt.Println(name, age, married, d)

}

輸入：
go run .\main.go -name lisi --age 35 -m=true --duration=1h15m36s

輸出：
lisi 35 true 1h15m36s

flag.Parse()

通過以上兩種方法定義好命令行flag參數(shù)后，需要通過調(diào)用flag.Parse()來對(duì)命令行參數(shù)進(jìn)行解析。

支持的命令行參數(shù)格式有以下幾種：

-flag xxx （使用空格，一個(gè)-符號(hào)）
--flag xxx （使用空格，兩個(gè)-符號(hào)）
-flag=xxx （使用等號(hào)，一個(gè)-符號(hào)）
--flag=xxx （使用等號(hào)，兩個(gè)-符號(hào)）
其中，布爾類型的參數(shù)必須使用等號(hào)的方式指定。

Flag解析在第一個(gè)非flag參數(shù)（單個(gè)”-“不是flag參數(shù)）之前停止，或者在終止符”–“之后停止。

flag其他函數(shù)

flag.Args() ////返回命令行參數(shù)后的其他參數(shù)，以[]string類型
flag.NArg() //返回命令行參數(shù)后的其他參數(shù)個(gè)數(shù)
flag.NFlag() //返回使用的命令行參數(shù)個(gè)數(shù)

完整示例

func main() {
	var name string
	var age uint
	var married bool
	var d time.Duration

	flag.StringVar(&name, "name", "王五", "姓名")
	flag.UintVar(&age, "age", 18, "年齡")
	flag.BoolVar(&married, "m", false, "婚否")
	flag.DurationVar(&d, "duration", 0, "時(shí)間間隔")

	flag.Parse()

	fmt.Println(name, age, married, d)  // lisi 35 true 1h15m36s

	fmt.Println(flag.Args())  // [abc true 123]
	fmt.Println(flag.NArg())  // 3
	fmt.Println(flag.NFlag())  //  4

}

輸入：
go run .\main.go -name lisi --age 35 -m=true --duration=1h15m36s abc true 123

輸出：