使用sflags库基于结构体生成多类型命令行标志

sflags是一个强大的Go库，它允许你通过结构体定义自动生成命令行标志(flags)，支持多种数据类型和自定义验证。下面我将详细介绍如何使用sflags。

基本用法

首先安装sflags库：

go get github.com/qwenode/sflags

简单示例

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/qwenode/sflags"
	"github.com/qwenode/sflags/gen/gpflag"
)

type Config struct {
	Host     string `desc:"Server host" default:"localhost"`
	Port     int    `desc:"Server port" default:"8080"`
	Debug    bool   `desc:"Enable debug mode"`
	Timeout  int    `desc:"Request timeout in seconds" default:"30"`
	MaxRetry int    `desc:"Maximum retry attempts" default:"3"`
}

func main() {
	cfg := &Config{}
	
	// 将结构体转换为flag集
	pflagSet, err := gpflag.Parse(cfg)
	if err != nil {
		log.Fatalf("failed to parse flags: %v", err)
	}

	// 解析命令行参数
	pflagSet.Parse(os.Args[1:])

	fmt.Printf("Config: %+v\n", cfg)
}

运行程序时可以使用标准的flag语法：

./app --host=example.com --port=9000 --debug --timeout=60

高级特性

1. 嵌套结构体

type DatabaseConfig struct {
	URL      string `desc:"Database connection URL" default:"postgres://localhost:5432"`
	PoolSize int    `desc:"Connection pool size" default:"10"`
}

type AppConfig struct {
	Server struct {
		Host string `desc:"Server host" default:"0.0.0.0"`
		Port int    `desc:"Server port" default:"8080"`
	}
	DB DatabaseConfig
}

生成的flag会像这样：

--server.host
--server.port
--db.url
--db.pool-size

2. 切片类型支持

type Config struct {
	AllowedIPs []string `desc:"List of allowed IP addresses"`
	Ports      []int    `desc:"List of ports to listen on" default:"80,443"`
}

使用方式：

./app --allowed-ips=192.168.1.1,10.0.0.1 --ports=8080,8081

3. 自定义验证

type Config struct {
	Port int `desc:"Server port" validate:"min=1024,max=65535"`
}

func main() {
	cfg := &Config{}
	
	// 添加验证器
	validator := sflags.NewValidator()
	validator.RegisterFunc("min", func(v interface{}, param string) error {
		// 实现最小值验证
		return nil
	})
	
	_, err := gpflag.Parse(cfg, gpflag.WithValidator(validator))
	// ...
}

4. 环境变量支持

type Config struct {
	APIKey string `desc:"API key" env:"API_KEY"`
}

sflags会自动从环境变量中读取值。

完整示例

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/qwenode/sflags"
	"github.com/qwenode/sflags/gen/gpflag"
)

type ServerConfig struct {
	Host        string   `desc:"Server host" default:"0.0.0.0"`
	Port        int      `desc:"Server port" default:"8080"`
	Enabled     bool     `desc:"Enable server"`
	AllowedCORS []string `desc:"Allowed CORS origins" default:"*"`
}

type DatabaseConfig struct {
	URL      string `desc:"Database URL" env:"DB_URL"`
	Username string `desc:"Database username"`
	Password string `desc:"Database password"`
	PoolSize int    `desc:"Connection pool size" default:"10"`
}

type Config struct {
	Server   ServerConfig
	Database DatabaseConfig
	Debug    bool `desc:"Enable debug mode"`
}

func main() {
	cfg := &Config{}

	// 生成flag集
	pflagSet, err := gpflag.Parse(cfg,
		gpflag.WithEnvPrefix("APP_"), // 环境变量前缀
	)
	if err != nil {
		log.Fatalf("Failed to generate flags: %v", err)
	}

	// 解析命令行参数
	pflagSet.Parse(os.Args[1:])

	// 打印配置
	fmt.Printf("Configuration:\n%+v\n", cfg)

	// 使用帮助标志
	if help, _ := pflagSet.GetBool("help"); help {
		pflagSet.PrintDefaults()
		os.Exit(0)
	}
}

优势总结

1. 声明式配置：通过结构体定义配置，代码更清晰
2. 类型安全：自动处理类型转换
3. 灵活扩展：支持嵌套结构体、切片、自定义类型
4. 多来源：支持命令行参数、环境变量、默认值
5. 验证支持：内置验证功能

sflags是一个强大的工具，可以显著简化Go应用程序的配置管理，特别是对于需要复杂配置结构的项目。