config

README

配置读取模块

目的：此模块主要解决的问题是尽可能简单的加载配置文件以及AB测试中需要用到同类型不同数据的配置表。

思路：每一种不同类型的配置在模块中都会生成一个配置组，配置组中使用sync.Map管理实际的配置对象。获取配置的时候通过tag区分不同配置数据，如果获取不到对应tag配置，可以fallback到默认的主配置。

配置对象需要实现接口 IConfig

• 通过Name，Path定位配置源。
• ValuePtr传出配置对象的指针，用于json反序列化。
• OnLoad在反序列化完成后调用，用于初始化配置对象的数据。

// =================== 数组类型配置表的例子 =========================
// 声明单个配置的结构和json标签
// 再声明管理配置文件的结构 把解析json数据的切片指针通过接口方法ValuePtr返回
// 除了IConfig接口的几个方法 可以自定义数据类型和方法来方便使用配置

type User struct {
	Name  string   `json:"name"`
	Age   int      `json:"age"`
	Likes []string `json:"likes"`
}

type UserConfig struct {
	Users   []*User          `json:"users"`
	UserMap map[string]*User `json:"userMap"`
}

func (u *UserConfig) Name() string {
	return "user"
}

func (u *UserConfig) Path() string {
	return "./json"
}

func (u *UserConfig) ValuePtr() any {
	u.Users = make([]*User, 0)
	return &u.Users
}

func (u *UserConfig) OnLoad() {
	u.UserMap = make(map[string]*User)
	for _, user := range u.Users {
		u.UserMap[user.Name] = user
	}
	log.Sugar.Info("load user config end")
}

// =================== 结构体类型配置表的例子 =========================
// 和上述类似 可以直接使用声明的结构体来解析配置 也可以像上面一样定义一个管理配置文件的结构

type PriceConfig struct {
	Milk   int `json:"milk"`
	Cake   int `json:"cake"`
	Cheese int `json:"cheese"`
}

func (p *PriceConfig) Name() string {
	return "price"
}

func (p *PriceConfig) Path() string {
	return "./json"
}

func (p *PriceConfig) ValuePtr() any {
	return p
}

func (p *PriceConfig) OnLoad() {
	log.Sugar.Info("load price config end")
}

配置加载

• LoadConfig 加载本地配置文件 添加tag可选参数的话 会加载tag配置 如主配置为 user.json， tag为b的配置就为 user_b.json
• FocusConsulConfig 关注consul配置文件 通过监听consul的kv变化来动态更新配置 如有可匹配主配置Name的tag配置 会自动加载tag配置到对应配置组中
• ⚠️ 如果使用consul配置的话 需要在关注consul配置后再设置consul地址 因为需要通过关注列表筛选可用配置

// 本地配置
config.LoadConfig(&UserConfig{})
config.LoadConfig(&PriceConfig{}, "b") // 加载主配置以及tag配置

// consul配置
config.FocusConsulConfig(&UserConfig{})
config.FocusConsulConfig(&PriceConfig{})
config.SetConsul("localhost:8500")

配置获取

• 通过泛型确定需要获取的配置类型

// 获取主配置
userCfg := config.GetConfig[*UserConfig]()
// 获取tag配置 第二个参数为true时找不到tag配置时返回默认配置
priceTagCfg := config.GetConfigWithTag[*PriceConfig]("b", true)

Documentation

Index

• func FocusConsulConfig(config IConfig)
• func GetConfig[T IConfig]() T
• func GetConfigWithTag[T IConfig](tag string, fallback bool) T
• func LoadConfig(config IConfig, tag ...string)
• func LoadConfigFromBytes(bytes []byte, cfg IConfig) bool
• func LoadConfigFromConsul(client *api.Client, name, path string, cfg IConfig) bool
• func LoadConfigFromFile(name, path string, cfg IConfig) bool
• func OnConsulConfigChange(f func(IConfig))
• func SetConsul(addr string)
• func StopWatch()
• type Group
• type IConfig

Functions

func FocusConsulConfig

func FocusConsulConfig(config IConfig)

FocusConsulConfig 关注consul配置 使用consul管理配置的时候 可以使用这个方法注册需要关注的配置 ⚠️ 需要在SetConsul之前调用这个方法 让watchConfigUpdate知道哪些是需要解析的配置文件

func GetConfig

func GetConfig[T IConfig]() T

GetConfig 获取配置

func GetConfigWithTag

func GetConfigWithTag[T IConfig](tag string, fallback bool) T

GetConfigWithTag 获取tag配置 fallback为true的话找不到tag则返回默认配置

func LoadConfig

func LoadConfig(config IConfig, tag ...string)

LoadConfig 加载本地配置 如果有tag则加载tag配置

func LoadConfigFromBytes

func LoadConfigFromBytes(bytes []byte, cfg IConfig) bool

func LoadConfigFromConsul

func LoadConfigFromConsul(client *api.Client, name, path string, cfg IConfig) bool

func LoadConfigFromFile

func LoadConfigFromFile(name, path string, cfg IConfig) bool

func OnConsulConfigChange

func OnConsulConfigChange(f func(IConfig))

OnConsulConfigChange 注册consul配置变更回调

func SetConsul

func SetConsul(addr string)

SetConsul 设置consul地址

func StopWatch

func StopWatch()

StopWatch 停止所有 consul watch goroutine

Types

type Group

type Group struct {
	Name       string
	Path       string
	ConfigType reflect.Type
	ConfigMap  *sync.Map
}

type IConfig

type IConfig interface {
	Name() string  // 配置名称
	Path() string  // 配置文件路径 如果是consul的kv 则为kv前缀
	ValuePtr() any // 返回用于解析配置结构体的指针
	OnLoad()       // 配置文件加载后的回调 用于处理一些需要配置文件加载后的逻辑
}

IConfig 配置接口 管理配置数据的对象需要实现这个接口