写点什么

golang 实战之 flag 包

作者:程序员欣宸
  • 2022 年 8 月 22 日
    广东
  • 本文字数:2248 字

    阅读完需:约 7 分钟

golang实战之flag包

欢迎访问我的 GitHub

这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos

本篇概览

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
复制代码

源码下载

欢迎关注 InfoQ:程序员欣宸

学习路上,你不孤单,欣宸原创一路相伴...


发布于: 11 分钟前阅读数: 7
用户头像

搜索"程序员欣宸",一起畅游Java宇宙 2018.04.19 加入

前腾讯、前阿里员工,从事Java后台工作,对Docker和Kubernetes充满热爱,所有文章均为作者原创,个人Github:https://github.com/zq2599/blog_demos

评论

发布
暂无评论
golang实战之flag包_golang_程序员欣宸_InfoQ写作社区