Golang中命令行参数解析工具Flag包详解

flag包作用

Golang中的flag包用于解析命令行参数，提供了一个方便的接口来接收命令行参数，并将其转换为Go语言中的值。

使用方法

先看段示例代码：

package main

import (
	"flag"
	"fmt"
)

func main() {
	var name string
	flag.StringVar(&name, "name", "luduoxin", "请输入名称：")
	flag.Parse()
	fmt.Printf("name: %sn", name)
}

运行一下看下效果。

$ go run ./main.go -name xiaoming
name: xiaoming

在命令行通过-name参数传入xiaoming后，name这个变量获取到了这个值。StringVar方法将参数绑定到指定的变量，该方法有四个参数：

• 第一个是绑定的变量，指针类型。
• 第二个是参数名称。
• 第三个是默认值。
• 第四个是提示信息。

$ go run ./main.go -h            
  -name string
        请输入名称： (default "luduoxin")

这里只是使用StringVar方法来举例，还有很多和StringVar功能类似的方法，只是类型不同，如BoolVar、DurationVar、Float64Var、IntVar、Int64Var、UintVar和Uint64Var。这8个方法分别对应着不带Var的方法，如下String、Bool、Duration、Float64、Int、Int64、Uint和Uint64，以String为例：

package main

import (
	"flag"
	"fmt"
)

func main() {
	name := flag.String("name", "luduoxin", "请输入名称：")
	flag.Parse()
	fmt.Printf("age: %Tn", name)
	fmt.Printf("age: %sn", *name)
}

运行看下效果：

$ go run ./main.go -name xiaoming
age: *string
age: xiaoming

String规范法有三个参数：

• 第一个参数是参数名称
• 第二个参数是默认值
• 第三个参数是提示信息

返回的是对应的指针类型，获取参数结果需要使用*name。

上面两个实例中都调用了flag.Parse()，这个方法用来解析参数，如果不调用该方法，参数不会被解析，但是可以获得默认值。注释此方法运行看下效果：

go run ./chan.go -name xiaoming
age: *string
age: luduoxin

虽然传入了xiaoming，但值依然是默认值luduoxin。

命令行参数语法

命令行传参的语法有如下三种形式：

-flag 只支持bool类型
-flag=x
-flag x // 仅限非布尔类型的flag

例如如下示例：

package main

import (
	"flag"
	"fmt"
)

func main() {
	var name string
	flag.StringVar(&name, "name", "luduoxin", "请输入名称：")
	flag.Parse()
	fmt.Println(name)
}

可以使用如下方式传参：

$ go run ./main.go -name=xiaoming

也可以使用如下方式传参：

$ go run ./main.go -name xiaoming

自定义帮助信息

以上面的示例代码为例，来看一下默认帮助信息：

$ go run ./chan.go --help
Usage of xxx/main:
  -name string
        请输入名称： (default "luduoxin")

如果想改变帮助信息可以通过重写Usage来实现。示例代码如下：

package main

import (
	"flag"
	"fmt"
)

func main() {
	var name string
	flag.StringVar(&name, "name", "luduoxin", "请输入名称：")
	flag.Usage = customUsage

	flag.Parse()
	flag.Usage()

	fmt.Println(name)
}

func customUsage() {
	fmt.Fprintf(flag.CommandLine.Output(), `nginx version: nginx/1.10.0
使用方法: nginx -v`)

	flag.PrintDefaults()
}

运行看下效果：

$ go run ./chan.go --help
nginx version: nginx/1.10.0
使用方法: nginx -v  -name string
        请输入名称： (default "luduoxin")

帮助信息已经变成了自定义的了。

小结

关于flag的文章主要讲了flag包中常用的功能，其他不太常用的功能需要自己去探索，借助flag包可以实现非常强大的命令行工具。如果项目需要使用到更复杂或更高级的命令行解析方式，可以自己借助flag包来封装，也可以直接使用优秀的三方包，例如https://github.com/urfave/cli和https://github.com/spf13/cobra。