xconfig

README

配置包

• 热更新
• 定时主动拉取

Documentation

Index

• type IConfig
  • func New(ctx context.Context, source Source, opts ...Option) IConfig
• type Option
  • func WithWatch(interval time.Duration) Option
• type ReloadConfigInterface
• type Source

Types

type IConfig

type IConfig interface {
	// ReloadConfig 加载配置 被动通知
	// 从配置源加载到内存
	ReloadConfig() error

	// Scan 将配置扫描到结构体
	Scan(v any)

	// GetString 支持json/yaml通过键名获取值 不支持数组
	GetString(key string) string

	// Subscribe 用户订阅Watch事件
	Subscribe(key string, ch chan struct{})
	// UnSubscribe 用户取消订阅
	UnSubscribe(key string)

	// Close 关闭
	Close()
}

IConfig 配置接口 功能如下： 1.热更新 主动轮询/被动通知 2.通过key获取配置 3.订阅配置变化

func New

func New(ctx context.Context, source Source, opts ...Option) IConfig

New 创建配置类 storeHandler 描述资源以何种形式存储到Config.value 返回需要存储的值

type Option

type Option func(*config)

func WithWatch

func WithWatch(interval time.Duration) Option

WithWatch 监控 推荐30秒

type ReloadConfigInterface

type ReloadConfigInterface interface {
	// ReloadConfig 实现配置重载功能
	ReloadConfig() error
}

ReloadConfigInterface 重载配置Interface

type Source

type Source interface {
	// GetConfig 获取配置
	GetConfig() ([]byte, error)
}

Source 资源接口