Golang标准库flag全面讲解

发布网友发布时间：2024-09-27 18:11

我来回答

共1个回答

热心网友时间：2024-09-28 00:49

文章首发于公众号：程序员读书；欢迎关注，可以第一时间收到文章更新哦，转载本文请注明来源！

前言

今天来聊聊Go语言标准库中一个非常简单的库flag，这个库的代码量只有1000行左右，却提供了非常完善的命令行参数解析功能。

命令行参数

如果你有使用过类Unix(比如MacOS,Linux)等操作系统，相信你应该明白命令参数是什么，比如下面的两条命令：

$ mysql -u root -p 123456$ ls -al

第一条命令是MySQL的客户端，其-u root和-p 123456就是命令行参数，第二条命令用于显示当前目录的文件及目录，该命令中-al就是命令行参数。

flag库的作用就是帮我们将命令后面的选项参数解析到对应的变量中。

使用详解

要了解一个库，须从使用开始，下面我们通过一个简单的示例来快速了解flag库的使用，这个示例可以接收从命令行传递的用于连接数据库的参数，代码如下：

package mainimport ("flag""fmt")var (host stringdbName stringport intuser stringpassword string)func main() {flag.StringVar(&host, "host", "", "数据库地址")flag.StringVar(&dbName, "db_name", "", "数据库名称")flag.StringVar(&user, "user", "", "数据库用户")flag.StringVar(&password, "password", "", "数据库密码")flag.IntVar(&port, "port", 3306, "数据库端口")flag.Parse()fmt.Printf("数据库地址:%s\n", host)fmt.Printf("数据库名称:%s\n", dbName)fmt.Printf("数据库用户:%s\n", user)fmt.Printf("数据库密码:%s\n", password)fmt.Printf("数据库端口:%d\n", port)}

在命令行窗口输入以下命令，开始运行程序

go run main.go -host=localhost -user=test -password=123456 -db_name=test -port=3306

运行结束，输出结果如下所示：

数据库地址:localhost数据库名称:test数据库用户:test数据库密码:123456数据库端口:3306

上面的示例就是一个解析命令行选项参数的模板，包括下面三个步骤：

定义好接收参数的变量。

调用flag.StringVar()等函数将命令行选项与变量绑定。

调用flag.Parse()函数，开始解析变量。

在上面程序中，我们用了StringVar函数绑定字符串类型的参数，用了IntVar函数绑定整数类型的参数，除了字符串和整型，flag支持boolean，Duration，float64，Int64，uint，uint64等类型，下面是这些函数的定义，用法与StringVar相同。

func BoolVar(p *bool, name string, value bool, usage string)func DurationVar(p *time.Duration, name string, value time.Duration, usage string)func Float64Var(p *float64, name string, value float64, usage string)func Int64Var(p *int64, name string, value int64, usage string)func IntVar(p *int, name string, value int, usage string)func StringVar(p *string, name string, value string, usage string)func Uint64Var(p *uint64, name string, value uint64, usage string)func UintVar(p *uint, name string, value uint, usage string)

上面列出的函数带有Var后缀，表示需要我们自己传递一个变量去接收命令行参数，而flag在这些函数有基础上，封装了下面列表的函数，这些函数没有Var后缀，跟上面的函数相比少了一个参数，却多了一个返回值，这个返回值就是接收命令参数的变量指针。

func Bool(name string, value bool, usage string) *boolfunc Duration(name string, value time.Duration, usage string) *time.Durationfunc Float64(name string, value float64, usage string) *float64func Int(name string, value int, usage string) *intfunc Int64(name string, value int64, usage string) *int64func String(name string, value string, usage string) *stringfunc Uint(name string, value uint, usage string) *uintfunc Uint64(name string, value uint64, usage string) *uint64

所以我们把上面的示例改写为以下的样子：

package mainimport ("flag""fmt")func main() {host := flag.String("host", "", "数据库地址")dbName := flag.String("db_name", "", "数据库名称")user := flag.String("user", "", "数据库用户")password := flag.String("password", "", "数据库密码")port := flag.Int("port", 3306, "数据库端口")flag.Parse()fmt.Printf("数据库地址:%s\n", *host)fmt.Printf("数据库名称:%s\n", *dbName)fmt.Printf("数据库用户:%s\n", *user)fmt.Printf("数据库密码:%s\n", *password)fmt.Printf("数据库端口:%d\n", *port)}

另外，运行程序时，在后面跟上-h或--help来查看命令的参数选项，如：

go run main.go --helpUsage of main:-db_name string数据库名称-host string数据库地址-password string数据库密码-port int数据库端口 (default 3306)-user string数据库用户选项语法

flag支持以下三种命令行格式，参数前面的-也可以换成--，在flag库中，--并不是表示长选项的意思。

cmd -flagcmd -flag=xcmd -flag x

第一种只用布尔值的选项，如果该参数出现，则为true,不出则为默认值，而其他数据类型不能使用这种格式传值。

第二种可适用任何类型，因此也是最常用的格式。

第三种不可用于布尔值的选项。

flag在解析参数时，如果遇到第一个非选项参数(不是以-或--开头的)或终止符--，就会停止解析，比如上面的示例中，我们将运行命令改成下面的样子：

go run main.go -host=localhost noflag -user=test -password=123456 -db_name=test -port=3306

运行结果如下，可以看到解析-host参数之后遇到了noflag这样的非选项参数，flag就停止解析了，所以后面的参数都只输出了默认值。

整数类型的参数可以接收十进制、八进制，十六进制的参数，布尔型可以接收下面列出参数

Duration类型的参数接收可以被time.ParseDuration()解析的参数。

flag是怎么解析参数的？

我们知道flag库是用于命令行解析的，但其内部是怎么解析的呢？下面我们来分析一下

一个命令行参数包含以下四个部分：

接收参数的变量

参数名称

默认值

参数说明

所以flag设置命令行参数的函数有四个参数，比如：

flag内部有一个名称CommandLine的变量，其类型为FlagSet，如：

FlagSet就是一个命令行参数的集合体，当我们调用诸如IntVar这类的函数时，就是将命令行的默认值、参数说明，参数名称，接收参数的变量等信息告诉flag库，而flag内部会让CommandLine来处理，用这些信息创建Flag类型的变量，将添加到这个集合体中。

最后，当我们调用flag.Parse函数时，实际就是调用FlagSet结构体的Parse函数将命令参数解析到变量中，flag.Parse函数代码如下：

从上面的代码我们也可以看出来，FlagSet的Parse函数最终是通过获取os.Args数组的数据来解析命令行参数的。

即然我们知道flag是通过类型为FlagSet的变量CommandLine来处理命令行参数的，那其实我们也可以自己创建一个FlagSet类型的变量来处理命令行参数，所以我们可以将上面的例改成下面的样子：

另外，我们已经知道了flag解析参数的来源是os.Args这样的字符串数组，那我们也可以模拟一个这样的数组，将数组解析到变量之中，而不需要去解析os.Args数组，下面的例子就是这样做的：

运行程序，在命令后面不需要跟命令行参数，如下：

运行后结果如下：

如果flag提供的数据类型不能满足我们的需要，我们也可以自定义类型，自定义类型需要实现flag中的Value接口，该接口定义如下：

go run main.go -host=localhost -user=test -password=123456 -db_name=test -port=33060

Value类