深入解析golang中的标准库flag

2022-07-20,,,

go语言内置的flag包实现了命令行参数的解析,flag包使得开发命令行工具更为简单。

os.args

如果你只是简单的想要获取命令行参数,可以像下面的代码示例一样使用os.args来获取命令行参数。

func main() {
	// 获取命令行参数
	// os.args:[]string
	if len(os.args) > 0 {
		for i, v := range os.args {
			fmt.println(i, v)
		}
	}
}

执行命令:go run .\main.go host:127.0.0.1 port:8080
输出结果:

 c:\users\mayanan\appdata\local\temp\go-build3549800423\b001\exe\main.exe
 host:127.0.0.1

 port:8080

os.args是一个存储命令行参数的字符串切片,它的第一个元素是执行文件的名称。

flag包基本使用

1.flag参数类型

flag包支持的命令行参数类型有bool、int、int64、uint、uint64、float float64、string、duration。

flag参数 有效值
字符串flag 合法字符串
整数flag 1234、0664、0x1234等类型,也可以是负数。
浮点数flag 合法浮点数
bool类型flag 1, 0, t, f, t, f, true, false, true, false, true, false。
时间段flag 任何合法的时间段字符串。如”300ms”、”-1.5h”、”2h45m”。 合法的单位有”ns”、”us” /“µs”、”ms”、”s”、”m”、”h”。

定义命令行flag参数

flag.type()

基本格式如下:
flag.type(flag名, 默认值, 帮助信息)*type例如我们要定义姓名、年龄、婚否三个命令行参数,我们可以按如下方式定义:

func main() {
	// flag.type() 的使用
	name := flag.string("name", "张三", "姓名")
	age := flag.int("age", 18, "年龄")
	married := flag.bool("married", false, "婚否")
	delay := flag.duration("d", 0, "时间间隔")

	flag.parse()

	fmt.println(*name, *age, *married, *delay)
}

终端输入:
go run .\main.go -name lisi --age 88 -married=true --d=15s

输出:
lisi 88 true 15s

flag.typevar()

基本格式如下: flag.typevar(type指针, flag名, 默认值, 帮助信息) 例如我们要定义姓名、年龄、婚否三个命令行参数,我们可以按如下方式定义:

func main() {
	var name string
	var age uint
	var married bool
	var d time.duration

	flag.stringvar(&name, "name", "王五", "姓名")
	flag.uintvar(&age, "age", 18, "年龄")
	flag.boolvar(&married, "m", false, "婚否")
	flag.durationvar(&d, "duration", 0, "时间间隔")

	flag.parse()

	fmt.println(name, age, married, d)

}

输入:
go run .\main.go -name lisi --age 35 -m=true --duration=1h15m36s

输出:
lisi 35 true 1h15m36s

flag.parse()

通过以上两种方法定义好命令行flag参数后,需要通过调用flag.parse()来对命令行参数进行解析。

支持的命令行参数格式有以下几种:

-flag xxx (使用空格,一个-符号)
--flag xxx (使用空格,两个-符号)
-flag=xxx (使用等号,一个-符号)
--flag=xxx (使用等号,两个-符号)
其中,布尔类型的参数必须使用等号的方式指定。

flag解析在第一个非flag参数(单个”-“不是flag参数)之前停止,或者在终止符”–“之后停止。

flag其他函数

  • flag.args() ////返回命令行参数后的其他参数,以[]string类型
  • flag.narg() //返回命令行参数后的其他参数个数
  • flag.nflag() //返回使用的命令行参数个数

完整示例

func main() {
	var name string
	var age uint
	var married bool
	var d time.duration

	flag.stringvar(&name, "name", "王五", "姓名")
	flag.uintvar(&age, "age", 18, "年龄")
	flag.boolvar(&married, "m", false, "婚否")
	flag.durationvar(&d, "duration", 0, "时间间隔")

	flag.parse()

	fmt.println(name, age, married, d)  // lisi 35 true 1h15m36s

	fmt.println(flag.args())  // [abc true 123]
	fmt.println(flag.narg())  // 3
	fmt.println(flag.nflag())  //  4

}

输入:
go run .\main.go -name lisi --age 35 -m=true --duration=1h15m36s abc true 123

输出:

lisi 35 true 1h15m36s
[abc true 123]
3
4

到此这篇关于golang中的标准库flag的文章就介绍到这了,更多相关go标准库flag内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!

《深入解析golang中的标准库flag.doc》

下载本文的Word格式文档,以方便收藏与打印。