golang 标准命令行解析库 flag
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)
}
上面代码指定了两个选项:
-
bool
类型的b
选项,默认值为false
,帮助信息bool flag
-
string
类型的s
选项,默认值为hello golang
,帮助信息string flag
执行 go run main.go
将输出 b 和 s 的值
b is false
s is hello golang
执行 go run main.go -b -s "hello world"
将修改 b 和 s 的值
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=value
-
bool
选项后面可以不赋值-flag
,-flag=false
,--flag
,--flag=1
- 解析过程中遇到非选项字段,将立即结束解析,后面的字段会被放入到
args
变量中 - 所有的选项必须是已定义的,遇到未知的选项将返回错误
主要接口
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)
-
type
返回一个对应类型的地址,调用 Parse 之后将会被重新复制 -
typeVar
没有返回值,传入一个地址,Parse 之后的值写入到传入的地址
解析
正常的解析过程
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 提供三种错误处理的方式:
-
ContinueOnError
: 通过 Parse 的返回值返回错误 -
ExitOnError
: 调用 os.Exit(2) 直接退出程序,这是默认的处理方式 -
PanicOnError
: 调用 panic 抛出错误
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",
})
-
NFlag
: 解析了多少个选项 -
NArg
: 剩下多少个参数没有被解析 -
Args
: 返回剩下的参数
设置单个选项
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
之类的方法,再返回一个值,这样就很容易实现了,但是 Value 的设计难度在于在解析之前需要预先为每一个选项返回一个地址,而选项的类型也不是固定的
type Value interface {
String() string
Set(string) error
}
Value
被设计成了一个接口,为不同的数据类型实现这个接口,返回给用户的地址就是这个接口的实例数据,解析过程中,可以通过 Set
方法修改它的值,这个设计确实还挺巧妙的
链接
- package flag: https://golang.google.cn/pkg/...
- 测试代码: https://github.com/hpifu/go-k...
转载请注明出处
本文链接:https://tech.hatlonely.com/article/64
hatlonely
所有的事情在实现之前都有两次诞生的过程,第一次是诞生在头脑里,第二次才诞生在这个世界。所以你要成...
1.1k 声望
24 粉丝
推荐阅读
java 线程池
java 线程池 Java 的 concurrent 包下提供了多种线程池的实现,使用起来非常方便 ExecutorService ExecutorService 是线程池的抽象接口,concurrent 包提供了如下如下几个线程池的实现 Executors.newSingleThread...
hatlonely阅读 1.5k
前端如何入门 Go 语言
类比法是一种学习方法,它是通过将新知识与已知知识进行比较,从而加深对新知识的理解。在学习 Go 语言的过程中,我发现,通过类比已有的前端知识,可以更好地理解 Go 语言的特性。
robin赞 23阅读 3.2k评论 6
Golang 中 []byte 与 string 转换
string 类型和 []byte 类型是我们编程时最常使用到的数据结构。本文将探讨两者之间的转换方式,通过分析它们之间的内在联系来拨开迷雾。
机器铃砍菜刀赞 24阅读 57.9k评论 2
年度最佳【golang】map详解
这篇文章主要讲 map 的赋值、删除、查询、扩容的具体执行过程,仍然是从底层的角度展开。结合源码,看完本文一定会彻底明白 map 底层原理。
去去1002赞 16阅读 11.5k评论 2
年度最佳【golang】GMP调度详解
Golang最大的特色可以说是协程(goroutine)了, 协程让本来很复杂的异步编程变得简单, 让程序员不再需要面对回调地狱, 虽然现在引入了协程的语言越来越多, 但go中的协程仍然是实现的是最彻底的. 这篇文章将通过分析...
去去1002赞 15阅读 11.9k评论 4
万字详解,吃透 MongoDB!
MongoDB 是一个基于 分布式文件存储 的开源 NoSQL 数据库系统,由 C++ 编写的。MongoDB 提供了 面向文档 的存储方式,操作起来比较简单和容易,支持“无模式”的数据建模,可以存储比较复杂的数据类型,是一款非常...
JavaGuide赞 8阅读 1.6k
数据结构与算法:二分查找
一、常见数据结构简单数据结构(必须理解和掌握)有序数据结构:栈、队列、链表。有序数据结构省空间(储存空间小)无序数据结构:集合、字典、散列表,无序数据结构省时间(读取时间快)复杂数据结构树、 堆图二...
白鲸鱼赞 9阅读 5.2k
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。