golang flag包使用总结

最近看NSQD源码使用flag+ toml配置文件的用法, 详细总结下.

flag

该包提供了一系列解析命令行参数的功能接口

toml

一个第三方的配置文件解析的包地址:http://github.com/BurntSushi/toml

example

一个小demo, 包括了, 覆盖了flag包大部分使用场景

package main

import (
    "flag"
    "fmt"
    "github.com/BurntSushi/toml"
    "github.com/mreiferson/go-options"
    "log"
    "math/rand"
    "os"
    "strings"
    "time"
)

func main() {
    // 设置conf 的默认值
    opts := newConf()
    flagSet := newOpts(opts)
    // 从命令行获取参数值
    flagSet.Parse(os.Args[1:])
    rand.Seed(time.Now().UTC().UnixNano())
    if flagSet.Lookup("version").Value.(flag.Getter).Get().(bool) {
        fmt.Println("Zsh-1.0.1")
        os.Exit(0)
    }
    configFile := flagSet.Lookup("config").Value.String()
    var cfg config

    if configFile != "" {
        _, err := toml.DecodeFile(configFile, &cfg)
        if err != nil {
            panic(err.Error())
        }
    }
    // 校验配置有效性
    cfg.Validate()
    // options 这个包能中和命令行, 配置文件,和默认配置的优先级
    options.Resolve(opts, flagSet, cfg)

    fmt.Println(opts.Url, opts.ListenPort, opts.MysqlAddr)
}

type Conf struct {
    AppName    string
    Version    string
    MysqlAddr  string   `flag:"mysql"` // 这里的flag tag 是在参数行的key,和json tag 类似;
    ListenPort int      `flag:"port"`
    Url        []string `flag:"url"`
}

type config map[string]interface{}

//参数校验
func (c config) Validate() {
    if port, ok := c["port"]; ok {
        if _, ok = port.(int64); !ok {
            log.Fatal("port must be Int")
        }
    }
}

// 设置参数的默认值
func newConf() *Conf {
    return &Conf{
        AppName:    "Zsh",
        ListenPort: 9090,
        Url:        StringArray{"127.0.0.1:2371"},
    }
}

func newOpts(c *Conf) *flag.FlagSet {
    // new 一个flagSet, 并且把默认的配置传进来.
    flagSet := flag.NewFlagSet("Zsh", flag.ExitOnError)
    flagSet.String("name", c.AppName, "应用名称, 默认Zsh")
    flagSet.String("v", "1.0.0.", "应用名字")
    flagSet.String("mysql", "127.0.0.1:3306", "mysql address.")
    flagSet.Int("port", c.ListenPort, "listen and port.")
    flagSet.String("config", "", "config path.")
    // 自定义类型, 这玩意我研究了半天!!
    url := StringArray{}
    flagSet.Var(&url, "url", "请求url")
    flagSet.Bool("version", false, "print version string")
    return flagSet
}

/*
要想在自定义类,必须实现Value, 和getter接口
type Value interface {
    String() string
    Set(string) error
}
type Getter interface {
    Value
    Get() interface{}
}

*/

type StringArray []string

func (a *StringArray) Get() interface{} { return []string(*a) }

func (a *StringArray) Set(s string) error {
    news := strings.Replace(s, " ", "", -1)
    *a = StringArray(strings.Split(news, ","))
    return nil
}

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