go-flags 是一个用于处理命令行参数和标志的 Go 库，它提供了一种简洁而灵活的方式来定义和解析命令行标志（flags）和参数。这个库对于需要处理命令行输入的 Go 应用程序非常有用，特别是在构建 CLI（命令行工具）时。
Life is like a journey
go-flags首先，你需要安装 go-flags 库。在命令行中运行以下命令：
go get github.com/jessevdk/go-flags
这个命令会安装 go-flags 库。
go-flags 允许你定义标志和位置参数，并且能够自动生成帮助信息。最基本的使用方式是定义结构体，标志将被映射到结构体字段上。
package main
import (
"fmt"
"github.com/jessevdk/go-flags"
)
type Options struct {
Name string `short:"n" long:"name" description:"Your name" required:"true"`
Age int `short:"a" long:"age" description:"Your age" required:"true"`
Verbose bool `short:"v" long:"verbose" description:"Enable verbose output"`
}
func main() {
var opts Options
parser := flags.NewParser(&opts, flags.Default)
// 解析命令行参数
_, err := parser.Parse()
if err != nil {
fmt.Println(err)
return
}
// 输出解析后的结果
fmt.Printf("Name: %s\n", opts.Name)
fmt.Printf("Age: %d\n", opts.Age)
fmt.Printf("Verbose: %t\n", opts.Verbose)
}
Options 结构体定义了程序的命令行标志：
Name 和 Age 是必填字段，使用 required:"true" 标签来指定。Verbose 是一个可选标志，表示是否启用详细输出。flags.NewParser(&opts, flags.Default) 创建一个新的解析器，opts 是用于存储解析结果的结构体。parser.Parse() 解析命令行参数。go-flags 允许在结构体字段上使用标签来定义命令行标志。常用的标签包括：
short：设置标志的短版本（通常是一个字符）。long：设置标志的长版本（通常是一个单词）。required：如果为 true，则标志是必需的，未提供时将报错。description：标志的描述，在帮助信息中显示。default：设置标志的默认值。env：指定从环境变量中获取值的标志。package main
import (
"fmt"
"github.com/jessevdk/go-flags"
)
type Options struct {
Port int `short:"p" long:"port" description:"Port to bind" default:"8080"`
Host string `short:"h" long:"host" description:"Host address" default:"localhost"`
LogFile string `short:"l" long:"logfile" description:"Log file" default:"app.log"`
}
func main() {
var opts Options
parser := flags.NewParser(&opts, flags.Default)
// 解析命令行参数
_, err := parser.Parse()
if err != nil {
fmt.Println(err)
return
}
// 输出解析后的结果
fmt.Printf("Port: %d\n", opts.Port)
fmt.Printf("Host: %s\n", opts.Host)
fmt.Printf("LogFile: %s\n", opts.LogFile)
}
Port、Host 和 LogFile 都有默认值，分别为 8080、localhost 和 app.log，如果命令行中没有指定这些值，程序会使用这些默认值。description 字段会在帮助信息中显示。除了命令行标志外，go-flags 还可以处理位置参数。这些参数按顺序解析，不需要标志。
package main
import (
"fmt"
"github.com/jessevdk/go-flags"
)
type Options struct {
Verbose bool `short:"v" long:"verbose" description:"Enable verbose output"`
Filename string `positional-arg-name:"filename" description:"File to process" required:"true"`
}
func main() {
var opts Options
parser := flags.NewParser(&opts, flags.Default)
// 解析命令行参数
_, err := parser.Parse()
if err != nil {
fmt.Println(err)
return
}
// 输出解析后的结果
fmt.Printf("Verbose: %t\n", opts.Verbose)
fmt.Printf("Filename: %s\n", opts.Filename)
}
Filename 是一个位置参数，用户需要按顺序提供。positional-arg-name 标签用于指定位置参数的名称，required:"true" 表示这是必需的。go-flags 会自动为你生成帮助信息，你可以通过 --help 或 -h 来查看。例如：
$ go run main.go --help
Usage:
example [OPTIONS] FILENAME
Application Options:
-v, --verbose Enable verbose output
-h, --host=localhost Host address (default: localhost)
-p, --port=8080 Port to bind (default: 8080)
-l, --logfile=app.log Log file (default: app.log)
Positional arguments:
filename File to process
Help Options:
-h, --help Show this help message
go-flags 还支持从环境变量中加载配置。你可以使用 env 标签来指定环境变量。
package main
import (
"fmt"
"github.com/jessevdk/go-flags"
"os"
)
type Options struct {
Host string `long:"host" description:"Host address" env:"HOST" default:"localhost"`
}
func main() {
// 设置环境变量
os.Setenv("HOST", "192.168.1.1")
var opts Options
parser := flags.NewParser(&opts, flags.Default)
// 解析命令行参数
_, err := parser.Parse()
if err != nil {
fmt.Println(err)
return
}
// 输出解析后的结果
fmt.Printf("Host: %s\n", opts.Host)
}
Host 变量的值将会从 HOST 环境变量中获取，如果该环境变量未设置，则使用默认值 localhost。go-flags 允许你处理解析错误，并提供了多种错误类型，例如 flag.ErrHelp，你可以根据需要进行自定义错误处理。
package main
import (
"fmt"
"github.com/jessevdk/go-flags"
)
type Options struct {
Verbose bool `short:"v" long:"verbose" description:"Enable verbose output"`
}
func main() {
var opts Options
parser := flags.NewParser(&opts, flags.Default)
// 解析命令行参数
_, err := parser.Parse()
if err != nil {
if flags.WantHelp(err) {
// 当需要帮助信息时
fmt.Println("Displaying help:")
parser.WriteHelp(os.Stdout)
return
}
fmt.Println("Error parsing flags:", err)
return
}
// 输出解析后的结果
fmt.Printf("Verbose: %t\n", opts.Verbose)
}
go-flags 提供了一种灵活的方式来处理命令行标志、位置参数和环境变量。go-flags 支持自动生成帮助信息和错误处理，使得构建命令行工具更加高效。