Golang標準庫之flag包
阿新 • • 發佈:2022-05-20
Go語言內建flag包實現了命令列引數的解析,flag包使得開發命令列工具更為簡單。
os.Args
如果你只是簡單的想要獲取命令列引數,可以像下main的程式碼示例一樣使用os.Args來獲取命令引數。
package main import ( "fmt" "os" ) //os.Args demo func main() { //os.Args是一個[]string if len(os.Args) > 0 { for index, arg := range os.Args { fmt.Printf("args[%d]=%v\n", index, arg) } } }
將上面的程式碼執行go build -o "args_demo"編譯後,執行
$ ./args_demo a b c d
args[0]=./args_demo
args[1]=a
args[2]=b
args[3]=c
args[4]=d
os.Args是一個儲存命令列引數的字串切片,它的第一個元素是執行檔案的名稱。
flag包基本使用
本文介紹了flag包的常用函式和基本用法,更詳細的內容請檢視官方文件。
一、匯入flag包
import flag
二、flag引數型別
flag包支援的命令列引數型別有bool、int、int64、uint、uint64、float float64、string、duration。
三、定義命令列flag引數
在以下兩種常用的定義命令列flag引數的方法。
3.1 flag.Type()
基本格式如下:
flag.Type(flag名, 預設值, 幫助資訊)*Type 例如我們要定義姓名、年齡、婚否三個命令列引數,我們可以按如下方式定義:
name := flag.String("name", "張三", "姓名")
age := flag.Int("age", 18, "年齡")
married := flag.Bool("married", false, "婚否")
delay := flag.Duration("d", 0, "時間間隔")
需要注意的是,此時name、age、married、delay均為對應型別的指標。
3.2 flag.TypeVar()
基本格式如下: flag.TypeVar(Type指標, flag名, 預設值, 幫助資訊) 例如我們要定義姓名、年齡、婚否三個命令列引數,我們可以按如下方式定義:
var name string
var age int
var married bool
var delay time.Duration
flag.StringVar(&name, "name", "張三", "姓名")
flag.IntVar(&age, "age", 18, "年齡")
flag.BoolVar(&married, "married", false, "婚否")
flag.DurationVar(&delay, "d", 0, "時間間隔")
四、flag.Parse()
通過以上兩種方法定義好命令列flag引數後,需要通過呼叫flag.Parse()來對命令列引數進行解析。
支援的命令列引數格式有以下幾種:
- -flag xxx (使用空格,一個-符號)
- --flag xxx (使用空格,兩個-符號)
- -flag=xxx (使用等號,一個-符號)
- --flag=xxx (使用等號,兩個-符號)
其中,布林型別的引數必須使用等號的方式指定。
Flag解析在第一個非flag引數(單個”-“不是flag引數)之前停止,或者在終止符”–“之後停止。
五、flag其他函式
flag.Args() ////返回命令列引數後的其他引數,以[]string型別
flag.NArg() //返回命令列引數後的其他引數個數
flag.NFlag() //返回使用的命令列引數個數
六、完整示例
6.1 定義
func main() {
//定義命令列引數方式1
var name string
var age int
var married bool
var delay time.Duration
flag.StringVar(&name, "name", "張三", "姓名")
flag.IntVar(&age, "age", 18, "年齡")
flag.BoolVar(&married, "married", false, "婚否")
flag.DurationVar(&delay, "d", 0, "延遲的時間間隔")
//解析命令列引數
flag.Parse()
fmt.Println(name, age, married, delay)
//返回命令列引數後的其他引數
fmt.Println(flag.Args())
//返回命令列引數後的其他引數個數
fmt.Println(flag.NArg())
//返回使用的命令列引數個數
fmt.Println(flag.NFlag())
}
6.2 使用
命令列引數使用提示:
$ ./flag_demo -help
Usage of ./flag_demo:
-age int
年齡 (default 18)
-d duration
時間間隔
-married
婚否
-name string
姓名 (default "張三")
正常使用命令列flag引數:
$ ./flag_demo -name 沙河娜扎 --age 28 -married=false -d=1h30m
沙河娜扎 28 false 1h30m0s
[]
0
4
使用非flag命令列引數:
$ ./flag_demo a b c
張三 18 false 0s
[a b c]
3
0