配置管理

Gone框架的配置分层三个级别: 1.内核配置支持 => 2.本地配置支持 => 3.远程配置支持，逐层递进，渐进增强。

内核配置支持

只依赖框架内核模块，只需要引入github.com/gone-io/gone即可实现从环境变量中读取配置，自动注入到标记的结构体变量，下面讲解如何使用配置注入。

配置注入

type Service struct {
    gone.Flag
    confKey string `gone:"config,config.key"`
}
func init(){
    gone.Load(&Service{})
}

配置注入的方式是通过标记gone:"config,config.key"，其中config是配置的名称，config.key是配置的键名。

提示

1. 需要将结构体变量加载到Gone框架中，才能实现配置注入；
2. 结构体需要匿名嵌入gone.Flag，才能使用gone.Load完成加载。
3. Gone框架启动后会尝试从环境变量GONE_CONFIG_KEY中读取配置，将配置注入到结构体变量中；
4. 注意环境变量GONE_CONFIG_KEY的命名以GONE_开头，后面的键名需要将小写字母替换大写字母，使用下划线代替键名中的.

基础配置接口

type Configure interface {
    // Get 从配置源中获取配置值
    // key: 配置的键名
    // valuePointer: 配置值的指针，用于存储配置值
    // defaultVal: 当配置不存在时，使用默认值
    Get(key string, valuePointer any, defaultVal string) error
}

实现Configure并且替换掉默认配置组件，即可实现自定义配置组件，参考代码：

type CustomConfigure struct {
    gone.Flag
}
func (c *CustomConfigure) Get(key string, valuePointer any, defaultVal string) error {
    // 实现获取配置的逻辑
    return nil
}

func LoadCustomConfigure(loader gone.Loader) error {
    return loader.Load(
        &CustomConfigure{},
        gone.Name(gone.ConfigureName), //设置组件名称，这里为了替换默认的Configure组件，需要设置为gone.ConfigureName
        gone.IsDefault(new(gone.Configure)), //将CustomConfigure 设置为 Configure接口的默认实现
        gone.ForceReplace(), // 强制替换原有的配置提供者
    )
}

动态配置支持

内核接口支持

type ConfWatchFunc func(oldVal, newVal any)

// 定义动态配置接口，用于监听配置变化
type DynamicConfigure interface {
    Configure
    Notify(key string, callback ConfWatchFunc)
}

// 用于注入组件中，监听配置变化
type ConfWatcher func(key string, callback ConfWatchFunc)

动态配置使用

type Service struct {
    gone.Flag
    confKey *string `gone:"config,config.key"`
    watcher gone.ConfWatcher `gone:"*"`
}
func(s* Service) Init(){
    s.watcher("config.key", func(key string, value interface{}) {
        //todo 处理配置变化的逻辑
    })
}

提示

1. 需要动态变化的配置可以使用指针类型来接受值，配置变化时，对应的指针类型也会被更新，这种情况需要组件逻辑功能动态依赖配置值的变化；
2. 另外一种方式是，在组件中注入gone.ConfWatcher，使用gone.ConfWatcher可以监听配置变化，在回调函数中处理配置变化的逻辑；需要注意：回调函数不应该是阻塞的，如果存在比较耗时的操作应该新开一个协程处理。

已经支持动态配置的配置组件

• goner/apollo
• goner/nacos
• goner/viper/remote

配置接口和实现原理

配置注入，本质是基于Gone框架的Provider机制做的扩展，在内核中实现了一个名为config的gone.NamedProvider，它实质上是接管了所有gone:"config,xxx"的配置注入，它会根据配置的键名，调用Configure的Get方法，获取配置值，并将配置值注入到标记的结构体变量中。

本地配置支持

内核配置支持，可以用于goner组件测试，但是实际在生产中我们更大的可能需要使用本地文件来对系统做配置。为了实现本地配置的支持，我们提供了goner/viper组件，它基于viper实现了本地配置的支持，得益于viper本身的强大，goner/viper组件可以支持多种配置格式的配置文件，包括json、yaml、toml、properties等。 另外在此基础上，我们做了多环境支持，和配置文件覆盖的优先级。

配置文件加载路径

1. 程序（可执行文件）所在目录
2. 程序所在目录下的config子目录
3. 用户当前工作目录
4. 用户当前工作目录下的config子目录
5. 如果使用gone.Test()启动程序，还行加载：
   • 5.1 当前module的根目录下的config子目录
   • 5.2 当前工作目录下的testdata子目录
   • 5.3 当前工作目录下的testdata/config子目录
6. 如果设置了环境变量 CONF 或启动时使用了 -conf 选项，还会查找指定的配置文件路径

提示

1. gone.Test()可以用于编写单元测试，一般 和 goner/viper 组件配合使用；
2. 方便对不同package的配置进行单独管理；

多环境支持

• 默认配置文件，配置文件名为:default.*
• 环境配置文件，配置文件名为:[环境名称].*，例如：dev.yaml、prod.properties, 其中[环境名称]可以是任意字符串，环境配置文件将覆盖默认配置文件；
• 环境变量如何定义：
  • 启动时使用-env选项，例如：-env=dev
  • 启动时使用ENV环境变量，例如：ENV=dev
• 环境变量为空时，默认环境为local。

本地配置最佳实践

1. 所有配置文件都放在config子目录下，方便管理；
2. 使用一种配置文件格式，比如yaml;
3. 提供一个默认配置文件，例如：config/default.yaml；
4. 定义不同环境的配置文件，例如：config/dev.yaml，config/prod.yaml，覆盖默认配置文件；
5. 提供local环境的配置文件，例如：config/local.yaml，用于本地开发；
6. 本地开发配置应该是完整且开箱可用的，即 其他小伙伴下载代码后不需要做任何配置调整就能直接运行代码；

环境变量、启动参数作为配置

goner/viper 组件还支持从环境变量、启动参数中读取配置，从环境变量读取配置是兼容“内核配置支持”的，规则依然是GONE_开头，后面的键名需要将小写字母替换大写字母，使用下划线代替键名中的.。

远程配置支持

随着微服务的流行，一个系统动辄十几个服务，集中管理配置变成了一件很重要的事情，市面上也出现了许多优秀的配置管理系统，比如：apollo、nacos、consul等。 为了方便使用这些配置管理系统，我们提供了goner/apollo、goner/nacos、goner/viper/remote等组件，使用他们可以很方便的使用这些配置管理系统。 这些组件的设计逻辑，是基于goner/viper读取本地配置，拉取远程配置中心的配置，再合并本地配置，监控远程配置中心的配置变化，实现配置的动态更新。

更多内容

📄️ 内核支持

Gone框架配置系统提供智能的配置管理解决方案，支持自动环境变量注入、复杂配置映射和多数据源扩展。通过简洁的标签语法实现配置到结构体字段的自动填充，支持JSON复杂对象、默认值设置和自定义配置源扩展。本指南详细介绍了从基础使用到高级扩展的完整实践方法，帮助Go开发者快速构建灵活可维护的配置系统，提升微服务和企业级应用的配置管理效率。

📄️ 本地配置

Gone框架本地配置系统基于Viper库，提供了优雅的多环境配置管理方案。通过分层配置策略，支持默认配置与环境特定配置的智能合并，实现一套代码适配多种部署环境。 系统采用"基础配置+环境覆盖"的设计模式，先读取default配置文件作为基准，再根据ENV环境变量加载对应的环境配置进行覆盖。支持YAML、JSON、TOML等多种配置格式，推荐使用YAML格式以获得最佳的可读性。 核心特性包括：自动配置注入、类型安全的配置绑定、灵活的环境切换机制。通过gonectl工具可快速安装goner/viper组件，支持local、dev、test、prod等多环境配置文件管理。 适用于需要在本地开发、测试环境、生产环境使用不同配置的Go微服务项目，提供了完整的配置管理最佳实践和故障排除指南。

🗃️ 配置中心/远程配置

3 个项目