Golang多源配置管理插件库configure使用指南

configure是一个强大的Golang配置管理库，支持从多种来源加载配置，包括文件、环境变量、命令行参数等。下面我将详细介绍其使用方法。

安装

首先安装configure库：

go get github.com/paked/configure

基本使用

1. 从多种来源加载配置

package main

import (
	"fmt"
	"github.com/paked/configure"
)

func main() {
	// 创建配置实例
	conf := configure.New()

	// 定义配置变量
	var (
		port     = conf.Int("port", 8080, "the port to listen on")
		username = conf.String("username", "admin", "the username for authentication")
		debug    = conf.Bool("debug", false, "enable debug mode")
	)

	// 配置来源
	conf.Use(configure.NewEnvironment())       // 环境变量
	conf.Use(configure.NewFlag())             // 命令行参数
	conf.Use(configure.NewJSONFromFile("config.json")) // JSON文件

	// 解析配置
	conf.Parse()

	// 使用配置
	fmt.Printf("Port: %d, Username: %s, Debug: %v\n", 
		*port, *username, *debug)
}

2. 从JSON文件加载配置

创建config.json文件：

{
    "port": 9090,
    "username": "json_user",
    "debug": true
}

3. 从环境变量加载配置

export PORT=7070
export USERNAME=env_user
export DEBUG=true

4. 从命令行参数加载配置

./your_app --port=6060 --username=cli_user --debug=true

高级功能

1. 多配置文件支持

conf.Use(configure.NewJSONFromFile("config.json"))
conf.Use(configure.NewJSONFromFile("config.local.json")) // 本地覆盖配置

2. 自定义配置源

type MySource struct {
	data map[string]interface{}
}

func (m *MySource) Parse() error {
	// 实现自定义解析逻辑
	return nil
}

func (m *MySource) Get(key string) interface{} {
	return m.data[key]
}

// 使用自定义源
customSource := &MySource{
	data: map[string]interface{}{
		"port":     5050,
		"username": "custom_user",
	},
}
conf.Use(customSource)

3. 配置验证

conf.Parse()

if *port < 1 || *port > 65535 {
    log.Fatal("Invalid port number")
}

4. 监听配置变化

// 需要自己实现文件监听逻辑
go func() {
    for {
        if changed := checkFileChange("config.json"); changed {
            conf.Use(configure.NewJSONFromFile("config.json"))
            conf.Parse()
            fmt.Println("Config reloaded")
        }
        time.Sleep(5 * time.Second)
    }
}()

最佳实践

1. 配置优先级：通常命令行参数 > 环境变量 > 配置文件 > 默认值
2. 敏感信息：不要将密码等敏感信息放入配置文件，考虑使用环境变量或专门的密钥管理服务
3. 配置结构：对于复杂配置，建议使用结构体来组织配置项
4. 默认值：总是为配置项设置合理的默认值
5. 文档化：为每个配置项添加清晰的描述说明

完整示例

package main

import (
	"fmt"
	"log"
	"os"
	
	"github.com/paked/configure"
)

type Config struct {
	Port     int
	Username string
	Debug    bool
}

func main() {
	// 初始化配置
	conf := configure.New()
	
	// 定义配置变量
	var (
		port     = conf.Int("port", 8080, "Server port (1-65535)")
		username = conf.String("username", "admin", "Admin username")
		debug    = conf.Bool("debug", false, "Enable debug mode")
	)
	
	// 设置配置源
	conf.Use(configure.NewEnvironment())
	conf.Use(configure.NewFlag())
	conf.Use(configure.NewJSONFromFile("config.json"))
	
	// 解析配置
	if err := conf.Parse(); err != nil {
		log.Fatalf("Failed to parse config: %v", err)
	}
	
	// 验证配置
	if *port < 1 || *port > 65535 {
		log.Fatal("Invalid port number")
	}
	
	// 使用配置
	config := Config{
		Port:     *port,
		Username: *username,
		Debug:    *debug,
	}
	
	fmt.Printf("Running with config: %+v\n", config)
	
	// 模拟应用启动
	if config.Debug {
		fmt.Println("Debug mode enabled")
	}
	fmt.Printf("Starting server on port %d...\n", config.Port)
}

configure库提供了灵活的配置管理方案，可以轻松实现多源配置的加载和合并，非常适合需要从不同环境获取配置的应用程序。