golang flag包使用筆記

本文原文地址：

在寫命令列程式（工具、server）時，對命令引數進行解析是常見的需求。各種語言一般都會提供解析命令列引數的方法或庫，以方便程式設計師使用。如果命令列引數純粹自己寫程式碼來解析，對於比較複雜的，還是挺費勁的。在 go 標準庫中提供了一個包：flag，方便進行命令列解析。

首先，我們看flag包可以做什麼，它具有什麼樣的能力。

1.1 使用示例：

• 我們以 nginx 為例，執行 nginx -h，輸出如下：

nginx version: nginx/1.10.0
Usage: nginx [-?hvVtTq] [-s signal] [-c filename] [-p prefix] [-g directives]

Options:
  -?,-h         : this help
  -v            : show version and exit
  -V            : show version and configure options then exit
  -t            : test configuration and exit
  -T            : test configuration, dump it and exit
  -q            : suppress non-error messages during configuration testing
  -s signal     : send signal to a master process: stop, quit, reopen, reload
  -p prefix     : set prefix path (default: /usr/local/nginx/)
  -c filename   : set configuration file (default: conf/nginx.conf)
  -g directives : set global directives out of configuration file

後續我們會利用flag包實現一個併發測試介面的程式。
現在我們來利用flag包簡單實現一下nginx -h這個功能：

package mainimport (    "flag"
    "fmt"
    "os")// 實際中應該用更好的變數名var (
    h bool

    v, V bool
    t, T bool
    q    *bool

    s string
    p string
    c string
    g string)func init() {
    flag.BoolVar(&h, "h", false, "this help")

    flag.BoolVar(&v, "v", false, "show version and exit")
    flag.BoolVar(&V, "V", false, "show version and configure options then exit")

    flag.BoolVar(&t, "t", false, "test configuration and exit")
    flag.BoolVar(&T, "T", false, "test configuration, dump it and exit")    // 另一種繫結方式
    q = flag.Bool("q", false, "suppress non-error messages during configuration testing")    // 注意 `signal`。預設是 -s string，有了 `signal` 之後，變為 -s signal
    flag.StringVar(&s, "s", "", "send `signal` to a master process: stop, quit, reopen, reload")
    flag.StringVar(&p, "p", "/usr/local/nginx/", "set `prefix` path")
    flag.StringVar(&c, "c", "conf/nginx.conf", "set configuration `file`")
    flag.StringVar(&g, "g", "conf/nginx.conf", "set global `directives` out of configuration file")    // 改變預設的 Usage，flag包中的Usage 其實是一個函式型別。這裡是覆蓋預設函式實現，具體見後面Usage部分的分析
    flag.Usage = usage
}func main() {
    flag.Parse()    if h {
        flag.Usage()
    }
}func usage() {
    fmt.Fprintf(os.Stderr, `nginx version: nginx/1.10.0
Usage: nginx [-hvVtTq] [-s signal] [-c filename] [-p prefix] [-g directives]

Options:
`)
    flag.PrintDefaults()
}

nginx功能用go實現結果

看不懂以上的程式碼實現沒關係，先明確flag的能力，看完下面的講解回過頭來看就可以看懂了。

1.2 flag 包概述

flag 包實現了命令列引數的解析。

1.2.1 定義 flags 有兩種方式

1）flag.Xxx()，其中 Xxx 可以是 Int、String，Bool 等；返回一個相應型別的指標，如：
var ip = flag.Int("flagname", 1234, "help message for flagname")

• 第一個引數 ：flag名稱為flagname

• 第二個引數 ：flagname預設值為1234

• 第三個引數 ：flagname的提示資訊

返回的ip是指標型別，所以這種方式獲取ip的值應該fmt.Println(*ip)

2）flag.XxxVar()，將 flag 繫結到一個變數上，如：

var flagValue intflag.IntVar(&flagValue, "flagname", 1234, "help message for flagname")

• 第一個引數 ：接收flagname的實際值的

• 第二個引數 ：flag名稱為flagname

• 第三個引數 ：flagname預設值為1234

• 第四個引數 ：flagname的提示資訊
  這種方式獲取ip的值fmt.Println(ip)就可以了：

1.2.2  自定義 Value

另外，還可以建立自定義 flag，只要實現 flag.Value 介面即可（要求 receiver 是指標），這時候可以透過如下方式定義該 flag：

flag.Var(&flagVal, "name", "help message for flagname")

例如，解析我喜歡的程式語言，我們希望直接解析到 slice 中，我們可以定義如下 sliceValue型別，然後實現Value介面：

package mainimport (    "flag"
    "fmt"
    "strings")//定義一個型別，用於增加該型別方法type sliceValue []string//new一個存放命令列引數值的slicefunc newSliceValue(vals []string, p *[]string) *sliceValue {
    *p = vals    return (*sliceValue)(p)
}/*
Value介面：
type Value interface {
    String() string
    Set(string) error
}
實現flag包中的Value介面，將命令列接收到的值用,分隔存到slice裡
*/func (s *sliceValue) Set(val string) error {
    *s = sliceValue(strings.Split(val, ","))    return nil
}//flag為slice的預設值default is me,和return返回值沒有關係func (s *sliceValue) String() string {
    *s = sliceValue(strings.Split("default is me", ","))    return "It's none of my business"}/*
可執行檔名 -slice="java,go"  最後將輸出[java,go]
可執行檔名 最後將輸出[default is me]
 */func main(){    var languages []string
    flag.Var(newSliceValue([]string{}, &languages), "slice", "I like programming `languages`")
    flag.Parse()    //列印結果slice接收到的值
    fmt.Println(languages)
}

這樣透過 -slice "go,php" 這樣的形式傳遞引數，languages 得到的就是 [go, php]。如果不加-slice引數則列印預設值[default is me]

flag 中對 Duration 這種非基本型別的支援，使用的就是類似這樣的方式，即同樣實現了Value介面。

1.2.3 解析 flag

在所有的 flag 定義完成之後，可以透過呼叫 flag.Parse() 進行解析。

命令列 flag 的語法有如下三種形式：

-flag // 只支援bool型別-flag=x
-flag x // 只支援非bool型別

以上語法對於一個或兩個‘－’號，效果是一樣的，但是要注意對於第三種情況，只能用於非 bool 型別的 flag。原因是：如果支援，那麼對於這樣的命令 cmd -x *，如果有一個檔名字是：0或false等，則命令的原意會改變（bool 型別可以和其他型別一樣處理，其次 bool 型別支援 -flag 這種形式，因為Parse()中，對 bool 型別進行了特殊處理）。預設的，提供了 -flag，則對應的值為 true，否則為 flag.Bool/BoolVar 中指定的預設值；如果希望顯示設定為 false 則使用 -flag=false。

int 型別可以是十進位制、十六進位制、八進位制甚至是負數；bool 型別可以是1, 0, t, f, true, false, TRUE, FALSE, True, False。Duration 可以接受任何 time.ParseDuration 能解析的型別。

• 注：如果bool型別的引數在命令列中用了-flag false這種形式時，其後的引數都會被當做非flag（non-flag）引數，non-flag 引數後面解釋。

1.3 型別和函式

在看型別和函式之前，先看一下變數。

ErrHelp：該錯誤型別用於當命令列指定了 ·-help` 引數但沒有定義時。

例如1.2.2例子中：如果執行時用了-help或者-h時就會輸出help message：

Usage of myflag.exe:
  -slice languages
        I like programming languages

Usage：這是一個函式，用於輸出所有定義了的命令列引數和幫助資訊（usage message）。一般，當命令列引數解析出錯時，該函式會被呼叫。我們可以指定自己的 Usage 函式，即：flag.Usage = func(){}

例如1.1示例中：如果執行時用了-help時就會輸出和-h一樣的usage message。

1.3.1 函式

go標準庫中，經常這麼做：

定義了一個型別，提供了很多方法；為了方便使用，會例項化一個該型別的例項（通用），這樣便可以直接使用該例項呼叫方法。比如：encoding/base64 中提供了 StdEncoding 和 URLEncoding 例項，使用時：base64.StdEncoding.Encode()

在 flag 包使用了有類似的方法，比如 CommandLine 變數，只不過 flag 進行了進一步封裝：將 FlagSet 的方法都重新定義了一遍，也就是提供了一系列函式，而函式中只是簡單的呼叫已經例項化好了的 FlagSet 例項：CommandLine 的方法。這樣，使用者是這麼呼叫：flag.Parse() 而不是 flag. CommandLine.Parse()。（Go 1.2 起，將 CommandLine 匯出，之前是非匯出的）

這裡不詳細介紹各個函式，其他函式介紹可以參考

1.3.2 型別（資料結構）

1）ErrorHandling

type ErrorHandling int

該型別定義了在引數解析出錯時錯誤處理方式。定義了三個該型別的常量：

const (
    ContinueOnError ErrorHandling = iota
    ExitOnError
    PanicOnError
)

三個常量在原始碼的 FlagSet 的方法 parseOne() 中使用了。

2）Flag

// A Flag represents the state of a flag.type Flag struct {
    Name     string // name as it appears on command line
    Usage    string // help message
    Value    Value  // value as set
    DefValue string // default value (as text); for usage message}

Flag 型別代表一個 flag 的狀態。

比如，對於命令：./nginx -c /etc/nginx.conf，相應程式碼是：

flag.StringVar(&c, "c", "conf/nginx.conf", "set configuration `file`")

則該 Flag 例項（可以透過 flag.Lookup("c") 獲得）相應各個欄位的值為：

&Flag{    Name: c,
    Usage: set configuration file,
    Value: /etc/nginx.conf,
    DefValue: conf/nginx.conf,
}

Lookup函式：獲取flag集合中名稱為name值的flag指標，如果對應的flag不存在，返回nil
示例：

package mainimport (    "flag"
    "fmt")//定義一個全域性變數的命令列接收引數var testFlag = flag.String("test", "default value", "help message.")//列印值的函式func print(f *flag.Flag) {    if f != nil {
        fmt.Println(f.Value)
    } else {
        fmt.Println(nil)
    }
}func main() {    //沒有用flag.Parse()解析前
    fmt.Print("test:")    print(flag.Lookup("test"))
    fmt.Print("test1:")    print(flag.Lookup("test1"))    //用flag.Parse()解析後
    flag.Parse()
    fmt.Print("test:")    print(flag.Lookup("test"))
    fmt.Print("test1:")    print(flag.Lookup("test1"))
}

執行結果：

//  ./testlookup -test "12345"      test:default value
test1:test:12345
test1:

3）FlagSet

// A FlagSet represents a set of defined flags.type FlagSet struct {    // Usage is the function called when an error occurs while parsing flags.
    // The field is a function (not a method) that may be changed to point to
    // a custom error handler.
    Usage func()

    name string // FlagSet的名字。CommandLine 給的是 os.Args[0]
    parsed bool // 是否執行過Parse()
    actual map[string]*Flag // 存放實際傳遞了的引數（即命令列引數）
    formal map[string]*Flag // 存放所有已定義命令列引數
    args []string // arguments after flags // 開始存放所有引數，最後保留 非flag（non-flag）引數
    exitOnError bool // does the program exit if there's an error?
    errorHandling ErrorHandling // 當解析出錯時，處理錯誤的方式
    output io.Writer // nil means stderr; use out() accessor}

4）Value 介面

// Value is the interface to the dynamic value stored in a flag.// (The default value is represented as a string.)type Value interface {
    String() string    Set(string) error
}

所有引數型別需要實現 Value 介面，flag 包中，為int、float、bool等實現了該介面。藉助該介面，我們可以自定義flag。（上文已經給了具體的例子）

1.4 主要型別的方法（包括型別例項化）

flag 包中主要是 FlagSet 型別。

1.4.1 例項化方式

NewFlagSet() 用於例項化 FlagSet。預定義的 FlagSet 例項 CommandLine 的定義方式：

// The default set of command-line flags, parsed from os.Args.
var CommandLine = NewFlagSet(os.Args[0], ExitOnError)

可見，預設的 FlagSet 例項在解析出錯時會退出程式。

由於 FlagSet 中的欄位沒有 export，其他方式獲得 FlagSet例項後，比如：FlagSet{} 或 new(FlagSet)，應該呼叫Init() 方法，以初始化 name 和 errorHandling，否則 name 為空，errorHandling 為 ContinueOnError（errorHandling預設為0）。

1.4.2  定義 flag 引數的方法

這一系列的方法都有兩種形式，在一開始已經說了兩種方式的區別。這些方法用於定義某一型別的 flag 引數。

1.4.3 解析引數（Parse）

func (f *FlagSet) Parse(arguments []string) error

從引數列表中解析定義的 flag。方法引數 arguments 不包括命令名，即應該是os.Args[1:]。事實上，flag.Parse() 函式就是這麼做的：

// Parse parses the command-line flags from os.Args[1:].  Must be called// after all flags are defined and before flags are accessed by the program.func Parse() {    // Ignore errors; CommandLine is set for ExitOnError.
    CommandLine.Parse(os.Args[1:])
}

該方法應該在 flag 引數定義後而具體引數值被訪問前呼叫。

如果提供了 -help 引數（命令中給了）但沒有定義（程式碼中沒有），該方法返回 ErrHelp 錯誤。預設的 CommandLine，在 Parse 出錯時會退出程式（ExitOnError）。

為了更深入的理解，我們看一下 Parse(arguments []string) 的原始碼：

func (f *FlagSet) Parse(arguments []string) error {
    f.parsed = true
    f.args = arguments
    for {
        seen, err := f.parseOne()        if seen {            continue
        }        if err == nil {            break
        }        switch f.errorHandling {        case ContinueOnError:            return err        case ExitOnError:
            os.Exit(2)        case PanicOnError:
            panic(err)
        }
    }    return nil
}

真正解析引數的方法是非匯出方法 parseOne。

結合 parseOne 方法，我們來解釋 non-flag 以及包文件中的這句話：

Flag parsing stops just before the first non-flag argument ("-" is a non-flag argument) or after the terminator "--".

我們需要了解解析什麼時候停止。

根據 Parse() 中 for 迴圈終止的條件（不考慮解析出錯），我們知道，當 parseOne 返回 false, nil 時，Parse 解析終止。正常解析完成我們不考慮。看一下 parseOne 的原始碼發現，有三處會返回 false, nil。
在這裡先說一下non-flag命令列引數是指不滿足命令列語法的引數，如命令列引數為cmd -flag=true abc則第一個非flag命令列引數為“abc”

1）引數列表長度為0

if len(f.args) == 0 {        return false, nil
}

2）第一個 non-flag 引數

s := f.args[0]if len(s) == 0 || s[0] != '-' || len(s) == 1 {    return false, nil}

也就是，當遇到單獨的一個"-"或不是"-"開始時，會停止解析。比如：

./nginx - 或 ./nginx ba或者./nginx

這兩種情況，-c 都不會被正確解析。像該例子中的"-"或ba（以及之後的引數），我們稱之為 non-flag引數。

3）兩個連續的"--"

if s[1] == '-' {
    num_minuses++    if len(s) == 2 { // "--" terminates the flags
        f.args = f.args[1:]        return false, nil
    }
}

也就是，當遇到連續的兩個"-"時，解析停止。如：

./nginx --

*下面這種情況是可以正常解析的：

./nginx  -c  --

這裡的"--"會被當成是 c 的值

parseOne 方法中接下來是處理 -flag=x 這種形式，然後是 -flag 這種形式（bool型別）（這裡對bool進行了特殊處理），接著是 -flag x 這種形式，最後，將解析成功的 Flag 例項存入 FlagSet 的 actual map 中。

另外，在 parseOne 中有這麼一句：

f.args = f.args[1:]

也就是說，每執行成功一次 parseOne，f.args 會少一個。所以，FlagSet 中的 args 最後留下來的就是所有 non-flag 引數。

1.4.4 Arg(i int) 和 Args()、NArg()、NFlag()

Arg(i int) 和 Args() 這兩個方法就是獲取 non-flag 引數的；NArg()獲得 non-flag 的個數；NFlag() 獲得 FlagSet 中 actual 長度（即被設定了的引數個數）。

1.4.5 Visit/VisitAll

這兩個函式分別用於訪問 FlatSet 的 actual（存放引數值實際Flag的map） 和 formal（存放引數名預設Flag的map） 中的 Flag，而具體的訪問方式由呼叫者決定。

具體使用demo見:

1.4.6 PrintDefaults()

列印所有已定義引數的預設值（呼叫 VisitAll 實現），預設輸出到標準錯誤，除非指定了 FlagSet 的 output（透過SetOutput() 設定）。
在1.1示例中有使用。還可以參考:

1.4.7 Set(name, value string)

將名稱為name的flag的值設定為value, 成功返回nil。
demo請見：

1.5 總結

使用建議：雖然上面講了那麼多，一般來說，我們只簡單的定義flag，然後 parse，就如同開始的例子一樣。

如果專案需要複雜或更高階的命令列解析方式，可以使用 或者 這兩個強大的庫。

作者：我的小碗湯
連結：