当我们写好一个服务之后需要发布运行时,服务的端口不应该写死吧?
万一你定义的端口在要运行的服务器上被占用了呢?
那,写到配置文件?这是一个方法。
除了写到配置文件,是否可以在启动时传入参数呢?
答案是肯定的。
我们有时在使用一些工具时,往往可以输入 -h 查看需要传入哪些参数,以此来使用这工具,比如 curl 这工具。
我们今天也来完成一个这样的参数管理。
go 语言官方提供了一个名为 flag 的包,用来处理启动时传入的参数,但是在取值的时候类型上不是很全。
这里推荐一个他的升级版 github.com/spf13/pflag 我是在 超级账本 的项目里面看到有使用他,于是顺着杆往上爬,发现还挺好的。
这里做个轻便的讲解。
一、引入
和别的包一样 go get 就好了。
go get github.com/spf13/pflag
二、基础使用
这里我定义两个变量由外部传入,分别是 string 类型的 name 和 int 类型的 age,代码如下:
package main
import (
"fmt"
flag "github.com/spf13/pflag"
)
func main() {
pName := flag.StringP("name", "n", "nike", "输入用户名")
iAge := flag.IntP("age", "a", 1, "输入年龄")
flag.Parse()
fmt.Println(*pName,*iAge)
}
flag.StringP 后面接的参数分别代表:全名,简写,默认值,提示
flag.Parse() 可别漏了,这是对传入的数据进行解析。
我们让他运行起来:
$ go run t.go
nike 1
这是不传入任何参数的结果,取的默认值。
现在再传值试试:
$ go run t.go -n 张三 -a 45
张三 45
这里的 -n 和 -a 分别是 对应里面的 StringP 和 IntP 的第二个参数,简写。
如果你想用全名传值就使用 --name 和 --age 进行传值。
像这样:
$ go run t.go --name 张三 --age 45
张三 45
相对来说,还是比较灵活的。
来检查下 -h,输入后是这样的:
是不是和之前的 curl 工具一样了呀。
三、一些高级的用法
1、隐藏参数
这种情况,经常会出现,当我们的应用升级后,有些参数就不用让用户传入了,但是我又不想删除代码(有时就这么奇怪)。
就可以使用 CommandLine.MarkHidden 方法,具体使用如下:
pName := flag.StringP("name", "n", "nike", "输入用户名")
iAge := flag.IntP("age", "a", 1, "输入年龄")
err := flag.CommandLine.MarkHidden("age")
if err != nil {
fmt.Println(err)
}
flag.Parse()
fmt.Println(*pName,*iAge)
这样我们再执行 -h 就会发现看不到 age 的参数要求了。
2、设置默认值
除了在 StringP 定义时设定默认值之外,还可以在 flag.Parse() 之后做下数据过滤,给他设置下默认值。
flag.Lookup("age").NoOptDefVal = "25"
这样当没传入 age 时的默认值就是 25 了。
还有其他的一些黑科技,感兴趣的可以去看他们的官方 github 库。
四、一些总结
这库支持的取值类型有很多,基本覆盖了,我们常用的数据类型,和下一期我们要讲的 viper 结合起来用,基本解决了项目里面的配置问题。
大家可以试试用 pflag 实现一个四则运算,哈哈。