golang flag包源码阅读

前言

用过golang的小伙伴应该都知道flag包,因此这边就不做使用的介绍了。本文主要简单分析flag包的源码,以及简单介绍下如何自定义自己的value类型。

本文测试代码如下:

var kk *bool = flag.Bool("k",false,"just k")

func main() {    

    //flag.Usage()    

    flag.Parse()        

    fmt.Println(*kk)

}

代码分析

当我们 import  package时,package内的全局变量会进行初始化,并且init函数会执行。对应flag包,代码如下:

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

func init() {       

    CommandLine.Usage = commandLineUsage

}

CommandLine 代表的是当前可执行程序的命令行集合,也就是 FlagSet。

CommandLine.Usage从字面理解就是使用说明。

NewFlagSet函数用于构造一个FlagSet,这样的函数命名也是golang推荐的。

对于FlagSet结构体,我们可以先看下它的定义:

type FlagSet struct {   

    Usage func()       

    name string      //FlagSet名字,被赋值为 os.Args[0]

    parsed bool     //是否被解析过

    actual map[string]*Flag    //在实际命令行中使用到的Flag

    formal map[string]*Flag     //在代码中预定义的全部Flag

    args []string                      //等于 os.Args[1:]

    errorHandling ErrorHandling    

    output io.Writer

}

注意从 Flag包中导出的函数最终都会调用到 CommandLine 对应的函数,所以这里我只分析 FlagSet 的对应函数。

Flag包初始化的过程之后,接下来就到测试代码的分析:

var kk *bool = flag.Bool("k",false,"just k")

三个参数分别为 name,default value,usage。

func (f *FlagSet) Bool(name string, value bool, usage string) *bool {    

    p := new(bool)    

    f.BoolVar(p, name, value, usage)    

    return p

}

函数简单明了,new出一个p,通过 FlagSet.BoolVar的处理,p会承接命令行中的值,然后直接返回p的指针。

所以最关键的函数在于 FlagSet.BoolVar 函数。

func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string) {    

    f.Var(newBoolValue(value, p), name, usage)

}

BoolVar 先调用 newBoolValue,之后调用 f.Var。

func newBoolValue(val bool, p *bool) *boolValue{    

    *p = val    

    return (*boolValue)(p)

}

newBoolValue功能只有一个,把默认值赋给 p,并将p转换成 boolValue指针类型,然后返回。

注意 boolValue 拥有成员函数: Set/String/Get,因此boolValue实现了 flag.Value,fmt.Stringer,flag.Getter接口。

func (f *FlagSet) Var(value Value, name string, usage string) {   

    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) 

   }    

    if f.formal == nil {        

        f.formal = make(map[string]*Flag)    

    }    

    f.formal[name] = flag

}

FlagSet.Var函数首先新建一个 Flag结构体,然后检查对应的 flag的name是否存在于 FlagSet的formal slice中,如果存在同名flag,直接panic。

如果不存在则直接把flag存放在 formal中。

至此,预定义的flag已经存放在 CommandLine 中。

之后我们分析 flag.Parse函数。

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

    f.parsed = true    

    f.args = arguments    

    for {        

        seen, err := f.parseOne()        

        ......

    }

}

其中 arguments    等于 os.Args[1:],因此Flag.Args()得到的是纯正的命令行参数,不包括 os.Args[0]。但是要千万注意,parseOne 函数会一直更新 FlagSet.args slice,从而导致 Parse结束后,Flag.Args() 得到的是一个空的 slice。

Parse函数中,最主要的函数是 FlagSet.ParseOne 函数。

ParseOne 的函数同样很简单,解析 “-” 符号,根据 “=” 的位置,解析出 name 与 value,其中很关键的代码:

fv, ok := flag.Value.(boolFlag)

fv.Set(value)

这里 Set 由Value接口定义,因此如果我们自定义参数类型的话,必须实现 Value 接口。

函数最后 flag会被添加到 FlagSet.actual 中。

基本的代码分析到这,里面还有一些比较简单的函数,比如usage相关,arg相关的函数,可以自己看看。

自定义Flag

根据上面代码的分析,只要我们定义的Flag结构体实现了Value接口,即能通过命令行初始化。下面代码为例:

type myFlag struct {    

    name string    

    age int

}

func (mf *myFlag) Set(data string) error {    

    b := bytes.NewBufferString(data)    

    fmt.Fscanf(b,"%d%s",&mf.age,&mf.name)    

    return nil

}

func (mf *myFlag)String() string {    

    return fmt.Sprintf("%s now is %d",mf.name,mf.age)

}

var mf *myFlag = &myFlag{}

func init() {    

    flag.CommandLine.Var(mf,"na","name age")

}

func main() {    

//flag.Usage()    

flag.Parse()        

fmt.Println(mf)

}

在实现 Value接口后,主要需要调用 flag.CommandLine.Var ,当然也可以调用 flag.Var 函数。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,265评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,078评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,852评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,408评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,445评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,772评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,921评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,688评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,130评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,467评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,617评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,276评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,882评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,740评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,967评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,315评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,486评论 2 348

推荐阅读更多精彩内容