开发命令行程序时,经常需要接受命令行传入的参数,flag包提供了参数处理的功能,官方文档地址:https://golang.google.cn/pkg/flag/
demo简介
写个使用flag包的demo,用于接收命令行参数并打印出来,如果命令行没有输入该参数则提供默认值,go的版本是1.11.5;
实战源码
在GOPAHT目录下创建目录 src/hello ,在此新建文件 hello.go,内容如下:
package main
import (
"flag"
"fmt"
)
//声明变量用于接收命令行传入的参数值
var (
name string
age int
address *string
id *int
)
func init() {
//通过传入变量地址的方式,绑定命令行参数到string变量
flag.StringVar(&name, //第一个参数:存放值的参数地址
"name", //第二个参数:命令行参数的名称
"匿名", //第三个参数:命令行不输入时的默认值
"您的姓名") //第四个参数:该参数的描述信息,help命令时会显示
//通过传入变量地址的方式,绑定命令行参数到int变量
flag.IntVar(&age, //第一个参数:存放值的参数地址
"age", //第二个参数:命令行参数的名称
-1, //第三个参数:命令行不输入时的默认值
"您的年龄") //第四个参数:该参数的描述信息,help命令时会显示
//和前面两个变量的获取方式不同,这个api没有传入变量地址,而是把命令行参数值的地址返回了
address = flag.String("address", //第一个参数:命令行参数的名称
"未知", //第二个参数:命令行不输入时的默认值
"您的住址") //第三个参数:该参数的描述信息,help命令时会显示
id = flag.Int("id", //第一个参数:命令行参数的名称
-1, //第二个参数:命令行不输入时的默认值
"身份ID") //第三个参数:该参数的描述信息,help命令时会显示
}
func main() {
//处理入参
flag.Parse()
//入参已经被赋值给各个变量,可以使用了
fmt.Printf("%s您好, 您的年龄:%d, 您的住址:%s, 您的ID:%d\n\n", name, age, *address, *id)
fmt.Println("---遍历有输入的参数(开始)---")
//Visit方法会遍历有输入的参数,flag.Flag可以将参数的名称、值、默认值、描述等内容取到
flag.Visit(func(f *flag.Flag){
fmt.Printf("参数名[%s], 参数值[%s], 默认值[%s], 描述信息[%s]\n", f.Name, f.Value, f.DefValue, f.Usage)
})
fmt.Println("---遍历有输入的参数(结束)---\n")
fmt.Println("---遍历所有的参数(开始)---")
//VisitAll方法会遍历所有定义的参数(包括没有在命令行输入的),flag.Flag可以将参数的名称、值、默认值、描述等内容取到
flag.VisitAll(func(f *flag.Flag){
fmt.Printf("参数名[%s], 参数值[%s], 默认值[%s], 描述信息[%s]\n", f.Name, f.Value, f.DefValue, f.Usage)
})
fmt.Println("---遍历所有的参数(结束)---\n")
}
由以上代码可见,将命令行输入的参数传递到代码中的变量主要有两种方式:
第一种:StringVar和IntVar等方法,第一个参数是变量的地址;
第二种:String和Int等方法,将入参的值存入一个变量中,再将此变量的地址作为返回值返回;
遍历入参
flag提供Visit方法,用于遍历每个有传入值的参数,Visit方法的入参是个自定义方法,用于接收和出入命令行的传入值;
flag提供VisitAll方法,用于遍历所有在代码中声明过的命令行参数,VisitAll方法的入参是个自定义方法,用于接收和出入命令行的传入值;
运行验证
在hello.go所在目录执行命令go run hello.go -name 超人 -address 深圳 -id 101,控制台输出如下,可见除了age参数没有输入,打印的是默认值,其他的参数都被绑定到正确的变量上了,并且有输入的参数和所有参数都能被遍历到:
超人您好, 您的年龄:-1, 您的住址:深圳, 您的ID:101
---遍历有输入的参数(开始)---
参数名[address], 参数值[深圳], 默认值[未知], 描述信息[您的住址]
参数名[id], 参数值[101], 默认值[-1], 描述信息[身份ID]
参数名[name], 参数值[超人], 默认值[匿名], 描述信息[您的姓名]
---遍历有输入的参数(结束)---
---遍历所有的参数(开始)---
参数名[address], 参数值[深圳], 默认值[未知], 描述信息[您的住址]
参数名[age], 参数值[-1], 默认值[-1], 描述信息[您的年龄]
参数名[id], 参数值[101], 默认值[-1], 描述信息[身份ID]
参数名[name], 参数值[超人], 默认值[匿名], 描述信息[您的姓名]
---遍历所有的参数(结束)---
输入命令go run hello.go –help,可以看到帮助信息如下,代码中设置的描述信息也输出了:
Usage of /var/folders/l7/nk5tjlsx4118k9tjg3n6248r0000gn/T/go-build071933964/b001/exe/hello:
-address string
您的住址 (default "未知")
-age int
您的年龄 (default -1)
-id int
身份ID (default -1)
-name string
您的姓名 (default "匿名")
exit status 2
源码下载
源码已经上传到github,地址是:https://github.com/zq2599/blog_demos/tree/master/godemo/src/hello
以上就是flag包常用API的实战了,golang的学习刚刚开始,读者您如果发现文章中的问题,还请及时指正,谢谢!
作者:程序员欣宸
标题: golang实战之flag包
来源:https://blog.csdn.net/boling_cavalry/article/details/87901677