作用
主要用来实现命令行的参数解析,以达到实现以下效果的目的
$ cmd -flagname 123
使用方式
flag是Go语言的内置包,能接收的参数类型主要有字符串、布尔和数值类型。
方式一
func main() {
var ip = flag.String("ip", "127.0.0.1", "此处传入IP地址")
flag.Parse()
fmt.Println(*ip)
}
我们在main函数中调用flag.String 函数来定义命令,该函数共有三个参数
- 第一个参数是命令名称
- 第二个参数为默认值,也就是不传ip时默认拿到的值
- 第三个参数是给用户的提示
同时该函数返回的是指针类型,打印变量ip时记得加上指针符号来输出地址对应的值。在执行flag.String后,记得执行flag.Parse来解析命令,否则不能执行成功。我们来测试一下,先键入一个错的参数,会得到以下提示。
go run main.go -i
flag provided but not defined: -i
Usage of /var/folders/3s/5v6r481x17x5ks_7q1dzmlsw0000gp/T/go-build400337564/b001/exe/main:
-ip string
此处传入IP地址 (default "127.0.0.1")
加上-ip 参数和值,可以直接获取到对应的值
go run main.go -ip 192.168.1.1
192.168.1.1
除了-ip 192.168.1.1 这种形式外,以等号赋值的方式也是支持的
go run main.go -ip=192.168.1.1
192.168.1.1
现在什么都不传,可以直接拿到设置的默认值
go run main.go
127.0.0.1
方式二
除上述内容之外,还有一种写法,我们再增加一个端口号为例
var port int
func init() {
flag.IntVar(&port, "port", 80, "端口号")
}
func main() {
flag.Parse()
fmt.Println("port", port)
}
首先定义一个整型变量port,在init函数中调用flag.IntVar函数,该函数与flag.String相比,少了返回值,且多一个参数,第一个参数是预先定义好的变量,为了方便IntVar内部修改变量值,所以该参数传引用类型。
方式三
如果我们想在接收参数值的过程当中做一些处理,那么也可以自己进行实现。假如我们需要对传入的用户名user 进行处理,加上一个_suffix 后缀。
type user string
func (u *user) String() string {
return fmt.Sprint(*u)
}
func (u *user) Set(value string) error {
if len(value) < 3 {
return errors.New("姓名长度不得小于3位")
}
*u = user(value + "_suffix")
return nil
}
首先需要定义一个类型,然后实现两个方法String与Set,在Set方法中我对传入的值进行了长度判断,如果小于3个字符就抛出错误,否则就将传入的值拼接一个后缀_suffix 。
var userFlag user
func main() {
flag.Var(&userFlag, "user", "用户名")
flag.Parse()
fmt.Println(userFlag)
}
接下来定义一个user类型的变量,然后在main函数中调用flag.Var方法,将变量地址传入,接下来执行命令做测试。
go run flagVar.go -user pingye
pingye_suffix
成功拼接上了后缀。
Go语言组件学习示例开源库,欢迎star https://github.com/EnochZg/golang-examples
|
请发表评论