Golang轻量级强大配置管理插件库GoLobby/Config的使用

简介

GoLobby Config是一个轻量级但功能强大的Go项目配置管理器。它利用Dot-env(.env)文件、OS环境变量以及配置文件(JSON、YAML和TOML)来满足您的所有需求。

要求

需要Go v1.16或更高版本。

安装

在项目根目录运行以下命令安装：

go get github.com/golobby/config/v3

快速开始

以下示例演示如何使用JSON配置文件：

// 配置结构体
type MyConfig struct {
    App struct {
        Name string
        Port int
    }
    Debug      bool
    Production bool
    Pi         float64
}

// 创建配置结构体实例
myConfig := MyConfig{}

// 创建从JSON文件提供配置数据的feeder
jsonFeeder := feeder.Json{Path: "config.json"}

// 创建Config实例并使用jsonFeeder填充myConfig
c := config.New()
c.AddFeeder(jsonFeeder)
c.AddStruct(&myConfig)
err := c.Feed()

// 或使用方法链:
// err := config.New().AddFeeder(jsonFeeder).AddStruct(&myConfig).Feed()

// 使用myConfig...

Feeders

Feeders提供配置数据。GoLobby Config包支持以下内置feeders：

• Json: 使用JSON文件
• Yaml: 使用YAML文件
• Toml: 使用TOML文件
• DotEnv: 使用dot env(.env)文件
• Env: 使用OS环境变量

您也可以通过实现Feeder接口创建自定义feeders或使用第三方feeders。

Json Feeder

Json feeder使用Go内置的json包加载JSON文件：

jsonFeeder := feeder.Json{Path: "sample1.json"}
c := config.New().AddFeeder(jsonFeeder)

Yaml Feeder

Yaml feeder使用YAML包(v3)加载YAML文件：

yamlFeeder := feeder.Yaml{Path: "sample1.yaml"}
c := config.New().AddFeeder(yamlFeeder)

Toml Feeder

Toml feeder使用BurntSushi TOML包加载TOML文件：

tomlFeeder := feeder.Toml{Path: "sample1.toml"}
c := config.New().AddFeeder(tomlFeeder)

DotEnv Feeder

DotEnv feeder使用GoLobby DotEnv包加载.env文件：

type MyConfig struct {
    App struct {
        Name string `env:"APP_NAME"`
        Port int    `env:"APP_PORT"`
    }
    Debug      bool    `env:"DEBUG"`
    Production bool    `env:"PRODUCTION"`
    Pi         float64 `env:"PI"`
    IDs        []int   `env:"IDS"`
}

myConfig := MyConfig{}
dotEnvFeeder := feeder.DotEnv{Path: ".env"}
err := config.New().AddFeeder(dotEnvFeeder).AddStruct(&myConfig).Feed()

必须为每个字段添加env标签以确定相关的dot env变量。如果相关文件中没有字段的值，它将忽略结构体字段。

Env Feeder

Env feeder基于GoLobby Env包构建：

type MyConfig struct {
    App struct {
        Name string `env:"APP_NAME"`
        Port int    `env:"APP_PORT"`
    }
    Debug      bool     `env:"DEBUG"`
    Production bool     `env:"PRODUCTION"`
    Pi         float64  `env:"PI"`
    IPs        []string `env:"IPS"`
    IDs        []int16  `env:"IDS"`
}

_ = os.Setenv("APP_NAME", "Shop")
_ = os.Setenv("APP_PORT", "8585")
_ = os.Setenv("DEBUG", "true")
_ = os.Setenv("PRODUCTION", "false")
_ = os.Setenv("PI", "3.14")
_ = os.Setenv("IPS", "192.168.0.1", "192.168.0.2")
_ = os.Setenv("IDS", "10, 11, 12, 13")

myConfig := MyConfig{}
envFeeder := feeder.DotEnv{}
err := config.New().AddFeeder(envFeeder).AddStruct(&myConfig).Feed()

必须为每个字段添加env标签以确定相关的OS环境变量名。如果OS环境变量中没有字段的值，它将忽略结构体字段。

多个Feeders

GoLobby Config包的关键特性之一是使用多个feeders进行配置。后添加的feeders会覆盖先添加的。

以下示例演示如何使用JSON文件作为主配置feeder，并用dot env和os变量覆盖配置：

type MyConfig struct {
    App struct {
        Name string `env:"APP_NAME"`
        Port int    `env:"APP_PORT"`
    }
    Debug      bool    `env:"DEBUG"`
    Production bool    `env:"PRODUCTION"`
    Pi         float64 `env:"PI"`
    IDs        []int32 `env:"IDS"`
}

_ = os.Setenv("PRODUCTION", "true")
_ = os.Setenv("APP_PORT", "6969")
_ = os.Setenv("IDs", "6, 9")

myConfig := MyConfig{}

feeder1 := feeder.Json{Path: "sample1.json"}
feeder2 := feeder.DotEnv{Path: ".env.sample2"}
feeder3 := feeder.Env{}

err := config.New().AddFeeder(feeder1, feeder2, feeder3).AddStruct(&myConfig).Feed()

fmt.Println(c.App.Name)   // Blog  [from DotEnv]
fmt.Println(c.App.Port)   // 6969  [from Env]
fmt.Println(c.Debug)      // false [from DotEnv]
fmt.Println(c.Production) // true  [from Env]
fmt.Println(c.Pi)         // 3.14  [from Json]
fmt.Println(c.IDs)        // 6, 9  [from Env]

Setup方法

Setup()方法在feeding后自动运行。您可以使用此方法进行后处理逻辑：

type Region int

const (
    Asia Region = iota
    Europe
    America
    Else
)

type Config struct {
    RegionId int `env:"REGION"`
    Region   Region
}

func (c *Config) Setup() error {
    if fc.RegionId == 0 {
        fc.Region = Asia
    } else if fc.RegionId == 1 {
        fc.Region = Europe
    } else if fc.RegionId == 2 {
        fc.Region = America
    } else if fc.RegionId == 3 {
        fc.Region = Else
    } else {
        return errors.New("invalid region")
    }
    return nil
}

_ = os.Setenv("REGION", "2")

myConfig := Config{}
f := feeder.Env{}

err := config.New().AddFeeder(f).AddStruct(&myConfig).Feed()

fmt.Println(c.Region) // America (2)

重新Feed

您可以在需要时重新填充结构体。只需再次调用Feed()方法：

c := config.New().AddFeeder(feeder).AddStruct(&myConfig)
err := c.Feed()

// 是时候重新feed了吗？
err = c.Feed()

// 使用更新后的myConfig数据！

监听器

GoLobby Config的特性之一是能够在无需重新部署的情况下更新配置结构体。它利用OS信号来处理此需求。Config实例监听"SIGHUP"操作系统信号并刷新结构体(调用Feed()方法)。

要为Config实例启用监听器，您应该调用SetupListener()方法。它获取一个回退函数，并在Feed()方法失败并返回错误时调用它。

c := config.New().AddFeeder(feeder).AddStruct(&myConfig)
c.SetupListener(func(err error) {
    fmt.Println(err)
})

err := c.Feed()

您可以使用以下shell命令向正在运行的应用程序发送SIGHUP信号：

KILL -SIGHUP [YOUR-APP-PROCESS-ID]

您可以使用ps命令获取应用程序进程ID。

许可证

GoLobby Config根据MIT许可证发布。