Golang : flag 包簡介

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

入門demo

在 Go workspace 的 src 目錄下創建 flagdemo 目錄，並在目錄下創建 main.go 文件，編輯其內容如下：

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。