Go 语言 flag 包:命令行参数解析
Go 语言内置的 flag 包提供了命令行参数解析的功能。
可以将命令行中的参数输入转换为程序定义的变量值,使程序具备灵活的用户交互能力。
本文将介绍 flag 包的使用方法,主要内容包括
flag 包简介
flag 基础用法
flag 参数类型
自定义 flag 解析
flag.NewFlagSet
flag 其他函数
flag 实战示例
1. flag 包简介
flag 包实现了命令行参数的解析,用法简单,提供了一系列定义命令行 flag 参数的函数。
由 flag 包解析命令行参数,可以避免手动解析 os.Args 的繁琐。
flag 包使得开发命令行工具更加简单高效。
主要由两个部分组成:
定义 flags 的变量
调用 flag.Parse()解析输入的 flags
2. flag 基础用法
基本使用方法是先定义命令行参数,然后调用 flag.Parse()进行解析。
package main import ( "flag" "fmt") var flagname = flag.String("flagname", "default", "description") func main() { flag.Parse() fmt.Println(*flagname)}
在 idea 命令行输入:
go run main.go -flagname value
则会输出输入的值"value"。
可以定义多个 flag,在解析时会对应解析。
3. flag 参数类型
flag 包支持的命令行参数类型有:
flag.String(name, default, usage) //字符串
flag.Int(name, default, usage) //整数
flag.Bool(name, default, usage) //布尔
flag.Float64(name, default, usage) //浮点数
flag.Duration(name, default, usage) //时间段
例如:
import ( "flag" "fmt") func main() { host := flag.String("host", "localhost", "服务器地址") port := flag.Int("port", 8080, "服务器端口") verbose := flag.Bool("verbose", false, "详细日志") flag.Parse() fmt.Println("服务器地址:", *host) fmt.Println("服务器端口:", *port) fmt.Println("是否详细日志:", *verbose)}
各种类型的 flag 使用方法类似。
4. 自定义 flag 解析
可以通过实现 flag.Value 接口自定义 flag 解析:
package main import ( "flag" "fmt") type LogLevel int const ( Info LogLevel = iota Debug Error) var logLevel LogLevel func init() { flag.IntVar((*int)(&logLevel), "loglevel", int(Info), "日志级别 (0: Info, 1: Debug, 2: Error)")} func main() { flag.Parse() fmt.Println("日志级别:", logLevel)}
在命令行传入 myflag 参数时会调用 myFlag 的 Set 方法进行解析。
5. flag.NewFlagSet
FlagSet 可以定义独立的 flag 组,方便同时解析多个命令行参数组。
package main import ( "flag" "fmt" "os") var ( startCmd = flag.NewFlagSet("start", flag.ExitOnError) stopCmd = flag.NewFlagSet("stop", flag.ExitOnError)) func main() { if len(os.Args) < 2 { fmt.Println("缺少子命令") os.Exit(1) } switch os.Args[1] { case "start": startCmd.Parse(os.Args[2:]) // 处理start子命令的逻辑 // 可以在这里使用startCmd中定义的命令行参数 case "stop": stopCmd.Parse(os.Args[2:]) // 处理stop子命令的逻辑 // 可以在这里使用stopCmd中定义的命令行参数 default: fmt.Println("无效的子命令") os.Exit(1) }}
6. flag 其他函数
flag 包还提供了一些其他函数:
flag.Args() //返回非 flag 参数
flag.NArg() //返回非 flag 参数个数
flag.NFlag() //返回使用的 flag 数
可以用于获取其它命令行参数。
7. flag 实战示例
下面是一个 web 服务器的例子:
package main import ( "flag" "fmt" "log" "net/http") func main() { var port int var dir string flag.IntVar(&port, "port", 80, "server port") flag.StringVar(&dir, "dir", ".", "document root dir") flag.Parse() http.Handle("/", http.FileServer(http.Dir(dir))) fmt.Printf("Server started at :%d and serving files from %s\n", port, dir) log.Fatal(http.ListenAndServe(fmt.Sprintf(":%d", port), nil))}
通过 flag 定义监听端口和文档目录参数,启动 Web 服务器。
8. flag 包的优缺点
flag 包的优点是使用简单方便,可以很容易地从命令行参数中读取输入。
需要注意的是,flag 全部采用全局变量,多个 flag 之间可以相互影响,需要注意名称不要冲突。
另外,参数的定义是散落在多个包中的,不便管理。
9. 总结
flag 包提高了命令行程序的灵活性,使用简单方便。
flag 包可以轻松实现命令行参数的解析
是开发命令行工具时的重要组件之一。
