14.Go語言標準庫flag基本使用

Go語言內置的flag包實現了命令行參數的解析，flag包使得開發命令行工具更爲簡單。

1.os.Args

如果你只是簡單的想要獲取命令行參數，可以像下面的代碼示例一樣使用os.Args來獲取命令行參數。
os.Args十一個存儲命令行參數的字符串切片，它的第一個元素是執行文件的名稱。

package main

import (
    "fmt"
    "os"
)

func main() {
    //os.Args是一個[]string
    if len(os.Args)>0{
        for index,arg := range os.Args{
            fmt.Printf("args[%d]=%v\n",index,arg)
        }
    }
}

結果：
➜  test go build -o "args_demo"
➜  test ./args_demo a b c d
args[0]=./args_demo
args[1]=a
args[2]=b
args[3]=c
args[4]=d

2.flag包基本使用

2.1flag參數類型

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

2.2定義命令行flag參數

有以下兩種定義命令行flag參數的方法。

2.2.1flag.Type()

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

package main

import (
    "flag"
    "fmt"
)

func main() {
    name := flag.String("name", "張三", "姓名")
    age := flag.Int("age", 18, "年齡")
    married := flag.Bool("married", false, "婚否")
    delay := flag.Duration("d", 0, "時間間隔")
    //注意：name,age,married,delay爲對應類型的指針
    fmt.Println(*name,*age,*married,*delay)

}

結果：
張三 18 false 0s

Process finished with exit code 0

2.2.2flag.TypeVar()

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

package main

import (
    "flag"
    "fmt"
    "time"
)

func main() {
    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, "時間間隔")
    fmt.Println(name,age,married,delay)

}

結果：
張三 18 false 0s

Process finished with exit code 0

2.2.3flag.Parse()

通過以上兩種方法定義好命令行flag參數後，需要通過調用flag.Parse()來對命令行參數進行解析。

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

-flag xxx （使用空格，一個-符號）
--flag xxx （使用空格，兩個-符號）
-flag=xxx （使用等號，一個-符號）
--flag=xxx （使用等號，兩個-符號）
其中，布爾類型的參數必須使用等號的方式指定。

Flag解析在第一個非flag參數（單個”-“不是flag參數）之前停止，或者在終止符”–“之後停止。

package main

import (
    "flag"
    "time"
)

func main() {
    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()

}

結果：
➜  test go build -o "args_demo"
➜  test ./args_demo -help      
Usage of ./args_demo:
  -age int
        年齡 (default 18)
  -d duration
        時間間隔
  -married
        婚否
  -name string
        姓名 (default "張三")
➜  test 

2.2.4flag其他函數

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

2.3完整示例

package main

import (
    "flag"
    "fmt"
    "time"
)

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())

}

命令行蠶食使用提示：
➜  test go build -o "args_demo"
➜  test ./args_demo -help      
Usage of ./args_demo:
  -age int
        年齡 (default 18)
  -d duration
        延遲的時間間隔
  -married
        婚否
  -name string
        姓名 (default "張三")

正常使用命令行glag參數
➜  test ./args_demo -name lili --age 27 -married=false -d=1h30m
lili 27 false 1h30m0s
[]
0
4

使用非flag命令行參數
➜  test ./args_demo a b c                                      
張三 18 false 0s
[a b c]
3
0
➜  test ./args_demo -a l -b l
flag provided but not defined: -a
Usage of ./args_demo:
  -age int
        年齡 (default 18)
  -d duration
        延遲的時間間隔
  -married
        婚否
  -name string
        姓名 (default "張三")
➜  test