confiq - Go语言多格式配置解析库

confiq是一个轻量级的Go语言配置解析库，支持多种格式的配置文件解析，包括JSON、YAML、TOML、INI等。下面我将详细介绍confiq的使用方法和示例代码。

安装

go get github.com/greaka/confiq

基本用法

1. 加载配置文件

package main

import (
	"fmt"
	"github.com/greaka/confiq"
)

func main() {
	// 创建一个配置容器
	container := confiq.New()

	// 加载JSON配置文件
	if err := container.Load("config.json", confiq.JSON); err != nil {
		fmt.Printf("加载JSON配置失败: %v\n", err)
	}

	// 加载YAML配置文件
	if err := container.Load("config.yaml", confiq.YAML); err != nil {
		fmt.Printf("加载YAML配置失败: %v\n", err)
	}

	// 加载TOML配置文件
	if err := container.Load("config.toml", confiq.TOML); err != nil {
		fmt.Printf("加载TOML配置失败: %v\n", err)
	}
}

2. 读取配置值

// 读取字符串配置
appName := container.String("app.name", "defaultAppName")

// 读取整数配置
port := container.Int("server.port", 8080)

// 读取布尔值配置
debug := container.Bool("debug", false)

// 读取浮点数配置
timeout := container.Float64("timeout", 3.5)

// 读取嵌套配置
dbConfig := struct {
    Host     string `config:"host"`
    Port     int    `config:"port"`
    Username string `config:"username"`
    Password string `config:"password"`
}{}
if err := container.Unmarshal("database", &dbConfig); err != nil {
    fmt.Printf("解析数据库配置失败: %v\n", err)
}

3. 环境变量覆盖

// 启用环境变量覆盖
container.EnableEnvOverrides("APP")

// 现在可以通过环境变量覆盖配置
// 例如: APP_SERVER_PORT=9090 会覆盖 server.port 配置

高级用法

1. 多文件合并

container := confiq.New()

// 加载默认配置
container.Load("config.default.json", confiq.JSON)

// 加载环境特定配置(如开发环境)
container.Load("config.dev.json", confiq.JSON)

// 后加载的文件会覆盖前面文件的相同配置项

2. 监听配置变化

// 创建支持热加载的配置容器
container := confiq.NewWithWatcher()

// 加载并监听配置文件
if err := container.LoadAndWatch("config.json", confiq.JSON); err != nil {
    fmt.Printf("加载并监听配置失败: %v\n", err)
}

// 注册配置变更回调
container.OnChange(func() {
    fmt.Println("配置已更新，重新加载...")
    // 在这里处理配置变更逻辑
})

3. 自定义配置源

// 实现confiq.ValueSource接口
type MySource struct {
    data map[string]interface{}
}

func (m *MySource) Get() (map[string]interface{}, error) {
    return m.data, nil
}

// 使用自定义配置源
mySource := &MySource{
    data: map[string]interface{}{
        "custom.key": "value",
    },
}
container.AddSource(mySource)

完整示例

package main

import (
	"fmt"
	"log"
	"time"

	"github.com/greaka/confiq"
)

type Config struct {
	App struct {
		Name    string `config:"name"`
		Version string `config:"version"`
	} `config:"app"`
	Server struct {
		Host string `config:"host"`
		Port int    `config:"port"`
	} `config:"server"`
	Database struct {
		DSN string `config:"dsn"`
	} `config:"database"`
	Features struct {
		NewUI bool `config:"new_ui"`
	} `config:"features"`
}

func main() {
	// 初始化配置容器
	container := confiq.New()

	// 加载配置文件
	if err := container.Load("config.yaml", confiq.YAML); err != nil {
		log.Fatalf("加载配置文件失败: %v", err)
	}

	// 启用环境变量覆盖
	container.EnableEnvOverrides("MYAPP")

	// 解析到结构体
	var cfg Config
	if err := container.Unmarshal("", &cfg); err != nil {
		log.Fatalf("解析配置失败: %v", err)
	}

	// 使用配置
	fmt.Printf("应用名称: %s\n", cfg.App.Name)
	fmt.Printf("服务器地址: %s:%d\n", cfg.Server.Host, cfg.Server.Port)
	fmt.Printf("数据库DSN: %s\n", cfg.Database.DSN)

	// 动态获取配置值
	for i := 0; i < 5; i++ {
		debugMode := container.Bool("debug", false)
		fmt.Printf("调试模式: %v\n", debugMode)
		time.Sleep(2 * time.Second)
	}
}

配置文件示例

YAML格式 (config.yaml)

app:
  name: "My Awesome App"
  version: "1.0.0"

server:
  host: "0.0.0.0"
  port: 8080

database:
  dsn: "user:pass@tcp(localhost:3306)/dbname"

features:
  new_ui: true

debug: false

JSON格式 (config.json)

{
  "app": {
    "name": "My Awesome App",
    "version": "1.0.0"
  },
  "server": {
    "host": "0.0.0.0",
    "port": 8080
  },
  "database": {
    "dsn": "user:pass@tcp(localhost:3306)/dbname"
  },
  "features": {
    "new_ui": true
  },
  "debug": false
}

confiq库提供了简单易用的API来处理多种格式的配置文件，支持配置合并、环境变量覆盖和热加载等功能，非常适合在Go项目中使用。