flag 库实现了对命令行参数的解析

基本用法

package main

import (
    "fmt"
    "flag"
)

func main() {
    b := flag.Bool("b", false, "bool flag")
    s := flag.String("s", "hello golang", "string flag")
    flag.Parse()
    fmt.Println("b is", *b)
    fmt.Println("s is", *s)
}

上面代码指定了两个选项:

boolbfalsebool flagstringshello golangstring flag
go run main.go
b is false
s is hello golang
go run main.go -b -s "hello world"
b is true
s is hello world
go run main.go -h
Usage of main:
  -b    bool flag
  -s string
        string flag (default "hello golang")

命令行语法

-b -i 100 -f=12.12 --s golang --d=20s
------bool-flag value-flag=value--falg value--flag=valuebool-flag-flag=false--flag--flag=1args

主要接口

CommandLine

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

FlagSet 是 flag 的核心解析类，为了方便使用，flag 内部提供了一个 FlagSet 对象 CommandLine，并且为 CommandLine 的所有方法封装了一下直接对外

flag.Int("i", 10, "int flag")CommandLine.Int("i", 10, "int flag")
func Int(name string, value int, usage string) *int {
    return CommandLine.Int(name, value, usage)
}

添加选项

flagSet := flag.NewFlagSet("test flag", flag.ExitOnError)

i := flagSet.Int("i", 10, "int flag")
f := flagSet.Float64("f", 11.11, "float flag")
s := flagSet.String("s", "hello world", "string flag")
d := flagSet.Duration("d", time.Duration(30)*time.Second, "string flag")
b := flagSet.Bool("b", false, "bool flag")

So(*i, ShouldEqual, 10)
So(*f, ShouldAlmostEqual, 11.11)
So(*s, ShouldEqual, "hello world")
So(*d, ShouldEqual, time.Duration(30)*time.Second)
So(*b, ShouldBeFalse)

flag 提供了两种方式添加选项

func Int(name string, value int, usage string) *int
func IntVar(p *int, name string, value int, usage string)
typetypeVar

解析

正常的解析过程

err := flagSet.Parse(strings.Split("-b -i 100 -f=12.12 --s golang --d=20s", " "))
So(err, ShouldBeNil)
So(*i, ShouldEqual, 100)
So(*f, ShouldAlmostEqual, 12.12)
So(*s, ShouldEqual, "golang")
So(*d, ShouldEqual, time.Duration(20)*time.Second)
So(*b, ShouldBeTrue)

解析过程中遇到非选项参数

// -i 后面期望之后一个参数，但是提供了两个，解析会立即停止，剩下的参数会写入到 args 中
err := flagSet.Parse(strings.Split("-b -i 100 101 -f 12.12 -s golang -d 20s", " "))
So(err, ShouldBeNil)
So(*b, ShouldBeTrue)
So(*i, ShouldEqual, 100)
So(*f, ShouldEqual, 11.11)          // not override
So(*s, ShouldEqual, "hello world")  // not override
So(*d, ShouldEqual, 30*time.Second) // not override

遇到未知的选项将出错，下面代码将直接返回错误

flag 提供三种错误处理的方式:

ContinueOnErrorExitOnErrorPanicOnError
flagSet.Parse(strings.Split("-xx abc", " "))

解析状态

err := flagSet.Parse(strings.Split("-b -i 100 101 -f 12.12 -s golang -d 20s", " "))
So(flagSet.NFlag(), ShouldEqual, 2)
So(flagSet.NArg(), ShouldEqual, 7)
So(flagSet.Args(), ShouldResemble, []string{
    "101", "-f", "12.12", "-s", "golang", "-d", "20s",
})
NFlagNArgArgs

设置单个选项

err := flagSet.Set("i", "120")
So(err, ShouldBeNil)
So(*i, ShouldEqual, 120)

遍历和查询选项

// 遍历所有设置过得选项
flagSet.Visit(func(f *flag.Flag) {
    fmt.Println(f.Name)
})

// 遍历所有选项
flagSet.VisitAll(func(f *flag.Flag) {
    fmt.Println(f.Name)
})

f := flagSet.Lookup("i")
So(f.Name, ShouldEqual, "i")
So(f.DefValue, ShouldEqual, "10")
So(f.Usage, ShouldEqual, "int flag")
So(f.Value.String(), ShouldEqual, "10")

设计思路

解析过程

func (f *FlagSet)Parse([]string) error
---===

value 的设计

GetInt
type Value interface {
    String() string
    Set(string) error
}
ValueSet

链接