flag 包簡介

在 Golang 程式中有很多種方法來處理命令列引數。簡單的情況下可以不使用任何庫，直接處理 os.Args；其實 Golang 的標準庫提供了 flag 包來處理命令列引數；還有第三方提供的處理命令列引數的庫，比如 Pflag 等。

入門 demo

在 Go workspace 的 src 目錄下建立 flagdemo 目錄，並在目錄下建立 main.go 檔案，編輯其內容如下：

package main

import "flag"
import "fmt"

// 定義命令列引數對應的變數，這三個變數都是指標型別
var cliName = flag.String("name", "nick", "Input Your Name")
var cliAge = flag.Int("age", 28, "Input Your Age")
var cliGender = flag.String("gender", "male", "Input Your Gender")

// 定義一個值型別的命令列引數變數，在 Init() 函式中對其初始化
// 因此，命令列引數對應變數的定義和初始化是可以分開的
var cliFlag int
func Init() {
    flag.IntVar(&cliFlag, "flagname", 1234, "Just for demo")
}

func main() {
    // 初始化變數 cliFlag
    Init()
    // 把使用者傳遞的命令列引數解析為對應變數的值
    flag.Parse()
    
    // flag.Args() 函式返回沒有被解析的命令列引數
    // func NArg() 函式返回沒有被解析的命令列引數的個數
    fmt.Printf("args=%s, num=%d\n", flag.Args(), flag.NArg())
    for i := 0; i != flag.NArg(); i++ {
        fmt.Printf("arg[%d]=%s\n", i, flag.Arg(i))
    }
    
    // 輸出命令列引數
    fmt.Println("name=", *cliName)
    fmt.Println("age=", *cliAge)
    fmt.Println("gender=", *cliGender)
    fmt.Println("flagname=", cliFlag)
}

使用 flag 包前要通過 import 命令匯入該包：

import "flag"

定義一個整型的引數 age，返回指標型別的變數：

var cliAge = flag.Int("age", 28, "Input Your Age")

建立值型別的引數變數，並在 Init() 函式中對其初始化(注意這裡呼叫的是 flag.IntVar 方法)：

var cliFlag int
func Init() {
    flag.IntVar(&cliFlag, "flagname", 1234, "Just for demo")
}

通過 flag.Parse() 函式接下命令列引數，解析函式將會在碰到第一個非 flag 命令列引數時停止：

flag.Parse()

命令列傳參的格式：

-isbool    (一個 - 符號，布林型別該寫法等同於 -isbool=true)
-age=x     (一個 - 符號，使用等號)
-age x     (一個 - 符號，使用空格)
--age=x    (兩個 - 符號，使用等號)
--age x    (兩個 - 符號，使用空格)

執行 demo

在 flagdemo 目錄下執行 go build 命令編譯 demo 生成可執行檔案 flagdemo。
不傳遞命令列引數

此時輸出的命令列引數都是定義的預設值。

傳遞命令列引數

傳遞的命令列引數會覆蓋預設值。

傳遞多餘的命令列引數

可以通過 flag.Args() 和 flag.NArg() 函式獲取未能解析的命令列引數。

傳遞錯誤的命令列參

如果通過 -xx 傳入未定義的命令列引數，則會直接報錯退出，並輸出幫助資訊。

檢視幫助資訊
通過命令列引數 -h 或 --help 可以檢視幫助資訊：

解讀 flag 包原始碼

flag 包支援的型別有 Bool、Duration、Float64、Int、Int64、String、Uint、Uint64。這些型別的引數被封裝到其對應的後端型別中，比如 Int 型別的引數被封裝為 intValue，String 型別的引數被封裝為 stringValue。這些後端的型別都實現了 Value 介面，因此可以把一個命令列引數抽象為一個 Flag 型別的例項。下面是 Value 介面和 Flag 型別的程式碼：

// Value 介面
type Value interface {
    String() string
    Set(string) error
}

// Flag 型別
type Flag struct {
    Name     string // name as it appears on command line
    Usage    string // help message
    Value    Value  // value as set 是個 interface，因此可以是不同型別的例項。
    DefValue string // default value (as text); for usage message
}

intValue 等型別實現了 Value 介面，因此可以賦值給 Flag 型別中的 Value 欄位，下面是 intValue 型別的定義：

// -- int Value
type intValue int

func newIntValue(val int, p *int) *intValue {
    *p = val
    return (*intValue)(p)
}

func (i *intValue) Set(s string) error {
    v, err := strconv.ParseInt(s, 0, strconv.IntSize)
    *i = intValue(v)
    return err
}

func (i *intValue) Get() interface{} { return int(*i) }
func (i *intValue) String() string { return strconv.Itoa(int(*i)) }

所有的引數被儲存在 FlagSet 型別的例項中，FlagSet 型別的定義如下：

// A FlagSet represents a set of defined flags.
type FlagSet struct {
    Usage func()

    name          string
    parsed        bool
    actual         map[string]*Flag    // 中儲存從命令列引數中解析到的引數例項
    formal        map[string]*Flag    // 中儲存定義的命令列引數例項(例項中包含了預設值)
    args          []string // arguments after flags
    errorHandling ErrorHandling
    output        io.Writer // nil means stderr; use out() accessor
}

Flag 包被匯入時建立了 FlagSet 型別的物件 CommandLine：

var CommandLine = NewFlagSet(os.Args[0], ExitOnError)

在程式中定義的所有命令列引數變數都會被加入到 CommandLine 的 formal 屬性中，其具體的呼叫過程如下：

var cliAge = flag.Int("age", 28, "Input Your Age")
func Int(name string, value int, usage string) *int {
    return CommandLine.Int(name, value, usage)
}
func (f *FlagSet) Int(name string, value int, usage string) *int {
    p := new(int)
    f.IntVar(p, name, value, usage)
    return p
}
func (f *FlagSet) IntVar(p *int, name string, value int, usage string) {
    f.Var(newIntValue(value, p), name, usage)
}
func (f *FlagSet) Var(value Value, name string, usage string) {
    // Remember the default value as a string; it won't change.
    flag := &Flag{name, usage, value, value.String()}
    _, alreadythere := f.formal[name]
    if alreadythere {
        var msg string
        if f.name == "" {
            msg = fmt.Sprintf("flag redefined: %s", name)
        } else {
            msg = fmt.Sprintf("%s flag redefined: %s", f.name, name)
        }
        fmt.Fprintln(f.Output(), msg)
        panic(msg) // Happens only if flags are declared with identical names
    }
    if f.formal == nil {
        f.formal = make(map[string]*Flag)
    }
    // 把命令列引數對應的變數新增到 formal 中
    f.formal[name] = flag
}

命令列引數的解析過程則由 flag.Parse() 函式完成，其呼叫過程大致如下：

func Parse() {
    CommandLine.Parse(os.Args[1:])
}
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
}

最終由 FlagSet 的 parseOne() 方法執行解析任務：

func (f *FlagSet) parseOne() (bool, error) {
…
flag.Value.Set(value)
…
f.actual[name] = flag
…
}

並在解析完成後由 flag.Value.Set 方法把使用者傳遞的命令列引數設定給 flag 例項，最後新增到 FlagSet 的 actual 屬性中。

總結

本文介紹了 Golang 標準庫中 flag 包的基本用法，並進一步分析了其主要的程式碼邏輯。其實 flag 包還支援使用者自定義型別的命令列引數，本文不再贅述，有興趣的朋友請參考官方 demo。