|
|
|
|
公众号矩阵

命令行参数的解析:Flag 库详解

如果真的遇上了所谓的复杂场景,那么还可以使用 Golang 的标准库 flag 包来处理命令行参数。本文将介绍 Golang 标准库中 flag 包的用法。

作者: 写代码的明哥来源: Go编程时光|2021-01-13 05:29

 

在 Golang 程序中有很多种方法来处理命令行参数。

简单的情况下可以不使用任何库,直接使用 os.Args

  1. package main 
  2.  
  3. import ( 
  4.     "fmt" 
  5.     "os" 
  6.  
  7. func main() { 
  8.     if len(os.Args) > 0 { 
  9.         for index, arg := range os.Args { 
  10.             fmt.Printf("args[%d]=%v\n"index, arg) 
  11.         } 
  12.     } 

试着运行一下,第一个参数是执行文件的路径。

  1. $ go run demo.go hello world hello golang 
  2. args[0]=/var/folders/72/lkr7ltfd27lcf36d75jdyjr40000gp/T/go-build187785213/b001/exe/demo 
  3. args[1]=hello 
  4. args[2]=world 
  5. args[3]=hello 
  6. args[4]=golang 

从上面你可以看到,os.Args 只能处理简单的参数,而且对于参数的位置有严格的要求。对于一些比较复杂的场景,就需要你自己定义解析规则,非常麻烦。

如果真的遇上了所谓的复杂场景,那么还可以使用 Golang 的标准库 flag 包来处理命令行参数。

本文将介绍 Golang 标准库中 flag 包的用法。

1. 参数种类

根据参数是否为布尔型,可以分为两种:

  • 布尔型参数:如 --debug,后面不用再接具体的值,指定就为 True,不指定就为 False非布尔型参数
  • 非布尔型参数:非布尔型,有可能是int,string 等其他类型,如 --name jack ,后面可以接具体的参数值

根据参数名的长短,还可以分为:

  • 长参数:比如 --name jack 就是一个长参数,参数名前有两个 -
  • 短参数:通常为一个或两个字母(是对应长参数的简写),比如 -n ,参数名前只有一个 -

2. 入门示例

我先用一个字符串类型的参数的示例,抛砖引玉

  1. package main 
  2.  
  3. import ( 
  4.     "flag" 
  5.     "fmt" 
  6.  
  7. func main(){ 
  8.     var name string 
  9.     flag.StringVar(&name"name""jack""your name"
  10.  
  11. flag.Parse()  // 解析参数 
  12.     fmt.Println(name

flag.StringVar 定义了一个字符串参数,它接收几个参数

  • 第一个参数 :接收值后,存放在哪个变量里,需为指针
  • 第二个参数 :在命令行中使用的参数名,比如 --name jack 里的 name
  • 第三个参数 :若命令行中未指定该参数值,那么默认值为 jack
  • 第四个参数:记录这个参数的用途或意义

运行以上程序,输出如下

  1. $ go run demo.go 
  2. jack 
  3.  
  4. $ go run demo.go --name wangbm 
  5. wangbm 

3. 改进一下

如果你的程序只接收很少的几个参数时,上面那样写也没有什么问题。

但一旦参数数量多了以后,一大堆参数解析的代码堆积在 main 函数里,影响代码的可读性、美观性。

建议将参数解析的代码放入 init 函数中,init 函数会先于 main 函数执行。

  1. package main 
  2.  
  3. import ( 
  4.     "flag" 
  5.     "fmt" 
  6.  
  7. var name string 
  8.  
  9. func init()  { 
  10.     flag.StringVar(&name"name""jack""your name"
  11.  
  12. func main(){ 
  13.     flag.Parse() 
  14.     fmt.Println(name

4. 参数类型

当你在命令行中指定了参数,Go 如何解析这个参数,转化成何种类型,是需要你事先定义的。

不同的参数,对应着 flag 中不同的方法。

下面分别讲讲不同的参数类型,都该如何定义。

布尔型

实现效果:当不指定 --debug 时,debug 的默认值为 false,你一指定 --debug,debug 为赋值为 true。

  1. var debug bool 
  2.  
  3. func init()  { 
  4.     flag.BoolVar(&debug, "debug"false"是否开启 DEBUG 模式"
  5.  
  6. func main(){ 
  7.     flag.Parse() 
  8.     fmt.Println(debug) 

运行后,执行结果如下

  1. $ go run main.go  
  2. false 
  3. $ go run main.go --debug 
  4. true 

数值型

定义一个 age 参数,不指定默认为 18

  1. var age int 
  2.  
  3. func init()  { 
  4.     flag.IntVar(&age, "age", 18, "你的年龄"
  5.  
  6. func main(){ 
  7.     flag.Parse() 
  8.     fmt.Println(age) 

运行后,执行结果如下

  1. $ go run main.go  
  2. 18 
  3.  
  4. $ go run main.go --age 20 
  5. 20 

int64、 uint 和 float64 类型分别对应 Int64Var 、 UintVar、Float64Var 方法,也是同理,不再赘述。

字符串

定义一个 name参数,不指定默认为 jack

  1. var name string 
  2.  
  3. func init()  { 
  4.     flag.StringVar(&name"name""jack""你的名字"
  5.  
  6. func main(){ 
  7.     flag.Parse() 
  8.     fmt.Println(name

运行后,执行结果如下

  1. $ go run main.go  
  2. jack 
  3.  
  4. $ go run main.go --name wangbm 
  5. wangbm 

时间类型

定义一个 interval 参数,不指定默认为 1s

  1. var interval time.Duration 
  2.  
  3. func init()  { 
  4.     flag.DurationVar(&interval, "interval", 1 * time.Second"循环间隔"
  5.  
  6. func main(){ 
  7.     flag.Parse() 
  8.     fmt.Println(interval) 

验证效果如下

  1. $ go run main.go  
  2. 1s 
  3.  
  4. $ go run main.go --interval 2s 
  5. 2s 

5. 自定义类型

flag 包支持的类型有 Bool、Duration、Float64、Int、Int64、String、Uint、Uint64。

这些类型的参数被封装到其对应的后端类型中,比如 Int 类型的参数被封装为 intValue,String 类型的参数被封装为 stringValue。

这些后端的类型都实现了 flag.Value 接口,因此可以把一个命令行参数抽象为一个 Flag 类型的实例。下面是 Value 接口和 Flag 类型的代码:

  1. type Value interface { 
  2.     String() string 
  3.     Set(string) error 
  4.  
  5. // Flag 类型 
  6. type Flag struct { 
  7.     Name     string // name as it appears on command line 
  8.     Usage    string // help message 
  9.     Value    Value  // value as set 是个 interface,因此可以是不同类型的实例。 
  10.     DefValue string // default value (as text); for usage message 
  11.  
  12. func Var(value Value, name string, usage string) { 
  13.     CommandLine.Var(value, name, usage) 

想要实现自定义类型的参数,其实只要 Var 函数的第一个参数对象实现 flag.Value接口即可

  1. type sliceValue []string 
  2.  
  3.  
  4. func newSliceValue(vals []string, p *[]string) *sliceValue { 
  5.     *p = vals 
  6.     return (*sliceValue)(p) 
  7.  
  8. func (s *sliceValue) Set(val string) error { 
  9.          // 如何解析参数值 
  10.     *s = sliceValue(strings.Split(val, ",")) 
  11.     return nil 
  12.  
  13. func (s *sliceValue) String() string { 
  14.     return strings.Join([]string(*s), ","

比如我想实现如下效果,传入的参数是一个字符串,以逗号分隔,flag 的解析时将其转成 slice。

  1. $ go run demo.go -members "Jack,Tom" 
  2. [Jack Tom] 

那我可以这样子编写代码

  1. var members []string 
  2. type sliceValue []string 
  3.  
  4.  
  5. func newSliceValue(vals []string, p *[]string) *sliceValue { 
  6.     *p = vals 
  7.     return (*sliceValue)(p) 
  8.  
  9. func (s *sliceValue) Set(val string) error { 
  10.          // 如何解析参数值 
  11.     *s = sliceValue(strings.Split(val, ",")) 
  12.     return nil 
  13.  
  14.  
  15. func (s *sliceValue) String() string { 
  16.     return strings.Join([]string(*s), ","
  17.  
  18. func init()  { 
  19.     flag.Var(newSliceValue([]string{}, &members), "members""会员列表"
  20.  
  21. func main(){ 
  22.     flag.Parse() 
  23.     fmt.Println(members) 

有的朋友 可能会对 (*sliceValue)(p) 这行代码有所疑问,这是什么意思呢?

关于这个,其实之前在 【2.9 详细图解:静态类型与动态类型】有讲过,忘记了可以前往复习。

6. 长短选项

flag 包,在使用上,其实并没有没有长短选项之别,你可以看下面这个例子

  1. package main 
  2.  
  3. import ( 
  4.     "flag" 
  5.     "fmt" 
  6.  
  7. var name string 
  8.  
  9. func init()  { 
  10.     flag.StringVar(&name"name""明哥""你的名字"
  11.  
  12. func main(){ 
  13.     flag.Parse() 
  14.     fmt.Println(name

通过指定如下几种参数形式

  1. $ go run main.go  
  2. 明哥 
  3. $ go run main.go --name jack 
  4. jack 
  5. $ go run main.go -name jack 
  6. jack 

一个 - 和两个 - 执行结果是相同的。

那么再加一个呢?

终于报错了。说明最多只能指定两个 -

  1. $ go run main.go ---name jack 
  2. bad flag syntax: ---name 
  3. Usage of /tmp/go-build245956022/b001/exe/main: 
  4.   -name string 
  5.         你的名字 (default "明哥"
  6. exit status 2 

7. 总结一下

flag 在绝大多数场景下,它是够用的,但如果要支持更多的命令传入格式,flag 可能并不是最好的选择。

那些在标准库不能解决的场景,往往会有相应的Go爱好者提供第三方解决方案。我所了解到的 cobra 就是一个非常不错的库。

本文转载自微信公众号「Go编程时光」,可以通过以下二维码关注。转载本文请联系Go编程时光公众号。

【编辑推荐】

  1. Windows命令行bat/cmd脚本异地备份,自动备份,服务器灾备
  2. Windows 10推出新的命令行工具,可以查看磁盘空间使用情况
  3. Nosqli:一款功能强大的NoSQL注入命令行接口工具
  4. Windows命令行bat/cmd脚本,文件批处理教程
  5. 网络/命令行抓包工具Tcpdump详解
【责任编辑:武晓燕 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

数据湖与数据仓库的分析实践攻略

数据湖与数据仓库的分析实践攻略

助力现代化数据管理:数据湖与数据仓库的分析实践攻略
共3章 | 创世达人

1人订阅学习

云原生架构实践

云原生架构实践

新技术引领移动互联网进入急速赛道
共3章 | KaliArch

30人订阅学习

数据中心和VPDN网络建设案例

数据中心和VPDN网络建设案例

漫画+案例
共20章 | 捷哥CCIE

209人订阅学习

视频课程+更多

华为HCIP(HCNP)精品课程-Wakin出品

华为HCIP(HCNP)精品课程-Wakin出品

讲师:谢斌10133人学习过

架构之路

架构之路

讲师:王军伟3133人学习过

Netty教程:十二个实例带你轻松学习Netty

Netty教程:十二个实例带你轻松学习Netty

讲师:江成军86026人学习过

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO官微