go flag包使用

Go是怎么接受外部的命令行参数的?

在Python中有 sys 模块下的 sys.args 可以获取命令行列表,与之对应的,Go 也有一个 flag 包来获取

使用 flag 包获取参数需要哪几个步骤?

  1. 导入 flag 包
  2. 初始化变量用来存储外部的命令
  3. flag 包的配置工作,比如要接收哪些参数等等
  4. 在前面的准备工作做完之后,要在最后阶段 flag.Parse()
import (
    "flag"
)

var name string

func init() {
    flag.StringVar(&name, "name", "everyone", "The greeting object.")
}

func main() {
    // Parse 函数必须放在变量声明和 flag 设置之后调用
    flag.Parse()
    fmt.Printf("Hello, %s!\n", name)
}

flal.StringVar 接收4个参数

  1. 用于存储该命令参数的值的地址
  2. 获取的外部命令参数的名称
  3. 在未追加该命令参数的默认值
  4. 该命令的简短说明,在 go run xx.go --help 时会输出

name 的赋值方式,除了上面的 StringVar 之外,还有一个 String 函数也可以

// 通过返回值的方式
var name = flag.String("name", "everyone", "The greeting object.")

设置完,这样调用就完成了一个最简单的读取命令行参数的功能

go run test.go -name=Lee
// >> Hello, Lee!

// 没有指定 name 参数,会输出默认值 everyone
go run test.go
// >> Hellp, everyone!

// 指定了没有配置的参数,会报错,这个报错的形式如果没有指明的话,就会采取默认的说明
go run test.go -a=1
>>  flag provided but not defined: -a
    Usage of question:
      -name string
            The greeting object. (default "everyone")
    exit status 2

// 这里就用到了 StringVar / String 的第三和第四个参数了
如果我们想自定义说明呢?

很简单,只要实现 flag.Usage 函数就行了

flag.Usage = func() {
    fmt.Fprintf(os.Stderr, "usage of %s:\n这是我自定义的输出信息\n", "question")
    flag.PrintDefaults()
}

这时候调用

>> go run test.go --help

输出信息

Usage of question:
这是我自定义的信息
  -name string
        The greeting object. (default "everyone")
exit status 2

变量名、描述、默认值是固定不变的,但是上面的信息可以自定义

上面在调用 StringVar、Parse 等等的函数的时候。实际上是在调用 flag.CommandLine 变量的对应方法

// flag.ExitOnError 表示是以什么样的形式推出程序,还有 flag.PanicOnError
flag.CommandLine = flag.NewFlagSet("", flag.ExitOnError)
flag.CommandLine.Usage = func() {
    fmt.Fprintf(os.Stderr, "Ueage of %s\n", "question")
    flag.PrintDefaults()
}

// 创建自己私有的命令参数容器
var cmdLine = flag.NewFlagSet("question", flag.ExitOnError)

// 用自己自定义的命令参数
cmdLine.StringVar(&name, "name", "everyone", "The greeting object.")

cmdLine.Parse(os.Args[1:]) // [1:]第一个元素是文件本身,所以要从1开始

以上关于flag的使用只是做一些简单介绍,具体的大家可以去看一下官方文档做深入了解

来自 https://leejnull.github.io/2019/08/21/2019-08-21/

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