Go命令行参数解析flag 包使用示例详解
作者:梦_鱼
Go]命令行参数解析包(flag 包)使用详解
Go 的 flag 包可以解析命令行的参数。
一、命令行语法
命令行语法主要有以下几种形式:
cmd -flag // 只支持bool类型
cmd -flag=xxx
cmd -flag xxx // 只支持非bool类型
以上语法对于一个或两个‘-’号是一样的,即
cmd -flag xxx (使用空格,一个 - 符号)
cmd --flag xxx (使用空格,两个 - 符号)
cmd -flag=xxx (使用等号,一个 - 符号)
cmd --flag=xxx (使用等号,两个 - 符号)
对于整形 flag,合法的值可以为 1234,0664,0x1234 或 负数 等。对于布尔型 flag,可以为 1,0,t,f,T,F,true,false,TRUE,FALSE,True,False 等
其中,布尔类型的参数比较特殊,为了防止解析时的二义性,应该使用 等号 的方式指定
二、命令行参数方法
1.定义flag参数
参数有三个:第一个为 参数名称,第二个为 默认值,第三个是 使用说明
1>通过 flag.String(),Bool(),Int() 等 flag.Xxx() 方法,该种方式返回一个相应的指针
var ip = flag.Int("flagname", 1234, "help message for flagname")
2>通过 flag.XxxVar() 方法将 flag 绑定到一个变量,该种方式返回 值类型,如
var flagvar intflag.IntVar(&flagvar, "flagname", 1234, "help message for flagname")
3> 通过 flag.Var() 绑定自定义类型,自定义类型需要实现 Value 接口 (Receiver 必须为指针),如
flag.Var(&flagVal, "name", "help message for flagname")
2. 调用 flag.Parse() 解析命令行参数到定义的 flag
flag.Parse()
解析函数将会在碰到第一个 非flag 命令行参数时停止,非flag 命令行参数是指不满足命令行语法的参数,如命令行参数为 cmd --flag=true abc 则第一个 非flag 命令行参数为“abc”
3. 调用 Parse 解析后,就可以直接使用 flag 本身(指针类型)或者绑定的变量了(值类型)
fmt.Println("flagvar has value ", flagvar)
还可通过 flag.Args(), flag.Arg(i) 来获取 非flag 命令行参数!
三、实例
package main import ( "flag" "fmt" ) func main() { username := flag.String("name", "", "Input your username") flag.Parse() fmt.Println("Hello, ", *username) }
编译:
go build flag.go
运行:
./flag -name=world
输出:
Hello, world
Go 还允许 自定义“命令行参数解析规则”,如下接口所示:
FlagSet 结构:
type FlagSet struct { Usage func() }
示例:
package main import ( "flag" "fmt" ) var myFlagSet = flag.NewFlagSet("myflagset", flag.ExitOnError) var stringFlag = myFlagSet.String("abc", "default value", "help mesage") func main() { myFlagSet.Parse([]string{"-abc", "def", "ghi", "123"}) args := myFlagSet.Args() for i := range args { fmt.Println(i, myFlagSet.Arg(i)) } }
Go-命令行参数解析
1. 解析命令行参数
程序在执行时,获取在命令行启动程序是使用的参数
- 命令行( Command line interface -- CLI):基于文本来查看、处理、操作计算机的界面,又被称为 终端、控制台
- 命令:在命令行执行的程序,一般是一行,包含命令名字、子命令与命令相关的选项(Flag),
- Flag:传递给命令的参数,通过参数全称或者参数首字符指定参数名称,参数之后使用
=
或空格连接参数与参数值
2. Golang 获取命令行参数
os.Args: 返回一个字符串slice,第一个当前程序自身路径,剩余参数是传递给命令行的参数
传递的参数一般是
--key=value
形式 、简写-k value
形式或者是一个开关标志-k
,使用os.Args
只是获取一个以空格分隔的字符串列表,无法很好的解析传递进来的参数到变量中
package main import ( "fmt" "os" ) func main() { commandArgs := os.Args fmt.Println(commandArgs) }
# 执行程序: 递归浏览指定目录下所有文件 go run main.go --name ls --value /etc -r # 输出: [/tmp/go-build2637413899/b001/exe/main --name ls --value /etc -r]
- 命令行参数解析 -- flag包
需要知晓程序的命令行需要传递哪些参数,如果没有传递该参数,那么默认值是什么,参数的说明
使用flag的流程: 1. 初始化存放命令行参数的全局变量 2. 在main包的init函数中注册需要解析的命令行参数,包含参数的类型、参数存放到哪个变量、参数的名称、参数的默认值、参数的使用说明 3. 在定义解析命令行参数最后,添加 flag.Parse(),解析传递到程序的命令行参数到变量中 4. 主函数中通过全局变量引用命令行参 5. 运行主函数,通过 -<参数名>=<value> 或 -<参数名> <value> 方式传参 解析命令行参数的基本文法: 1. flag.<类型>Var(<指针>, <参数名称>, <默认值>, <用法说明>) 2. 等价方法: flag.<类型>(<参数名称>, <默认值>, <用法说明>) - 区别在于,Var后缀方法是通过指针将值存放到指针指向的变量,未带Var后缀的方法返回一个指定值的指针 - 相同的,参数值不同则使用不同的类型,都包含参数的名称、参数的默认值、该参数使用说明 - 类型是基本数据类型:int int64 uint uint64 string bool fl0at64 Duration
package main import ( "flag" "fmt" ) // 1. 声明保存命令行参数的变量 var ( name string value string isRecursive bool ) func init() { // 2. 注册需要解析的命令行参: 参数名、默认值、参数说明 flag.StringVar(&name, "name", "none", "执行命令的名称") flag.StringVar(&value, "value", "none", "执行命令的参数") flag.BoolVar(&isRecursive, "recursive", false, "是否递归") // 3. 解析命令行参数 flag.Parse() } func main() { // 4. 主程序中通过全局变量引用命令行参 fmt.Println(name, value, isRecursive) }
# 输出:ls /etc true go run main.go -name ls -value /etc -recursive # 输出: ls /etc false go run main.go -name ls -value /etc
Flag包相关的其他方法
flag.Set()
解析后修改或设置命令行参数
package main import ( "flag" "fmt" ) // 1. 声明保存命令行参数的变量 var ( name string ) func init() { // 2. 声明需要解析的命令行参: 参数名、默认值、参数说明 flag.StringVar(&name, "name", "none", "执行命令的名称") // 将name的值修改为 find flag.Set("name", "find") } func main() { // 4. 主程序中通过全局变量引用命令行参 fmt.Println(name) }
# 输出:find go run main.go -name ls
flog.NFlag()
返回被设置的flag数量
package main import ( "flag" "fmt" ) // 1. 声明保存命令行参数的变量 var ( name string value string isRecursive bool ) func init() { flag.StringVar(&name, "name", "none", "执行命令的名称") flag.StringVar(&value, "value", "none", "执行命令的参数") flag.BoolVar(&isRecursive, "recursive", false, "是否递归") flag.Parse() } func main() { fmt.Println("number of set flag:", flag.NFlag()) }
# 输出:number of set flag: 2
go run main.go -name ls -value /etc
flag,Parsed()
检查flag.Parse()
是否被调用过
package main import ( "flag" "fmt" ) // 1. 声明保存命令行参数的变量 var ( name string value string isRecursive bool ) func init() { flag.StringVar(&name, "name", "none", "执行命令的名称") flag.StringVar(&value, "value", "none", "执行命令的参数") flag.BoolVar(&isRecursive, "recursive", false, "是否递归") flag.Parse() } func main() { fmt.Println("is Parsed", flag.Parsed()) }
# 输出:is Parsed true
go run main.go -name ls -value /etc
flag.Visit(func (*Flag))
按字典顺序遍历,进行设置了的标签
package main import ( "flag" "fmt" ) // 1. 声明保存命令行参数的变量 var ( name string value string isRecursive bool ) func init() { flag.StringVar(&name, "name", "none", "执行命令的名称") flag.StringVar(&value, "value", "none", "执行命令的参数") flag.BoolVar(&isRecursive, "recursive", false, "是否递归") flag.Parse() } func main() { flag.Visit(func(f *flag.Flag) { fmt.Printf("Name: %s, Value: %s, DefValue: %s, Usage: %s \n", f.Name, f.Value, f.DefValue, f.Usage) }) }
# 输出:
# Name: name, Value: ls, DefValue: none, Usage: 执行命令的名称
# Name: value, Value: /etc, DefValue: none, Usage: 执行命令的参数
go run main.go -name ls -value /etc
到此这篇关于Go-命令行参数解析的文章就介绍到这了,更多相关Go命令行参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!