configuration

README

Configuration

configuration 基于配置导表功能实现的配置加载及刷新功能

目录导航

列出了该 package 下所有的函数及类型定义，可通过目录导航进行快捷跳转 ❤️

展开 / 折叠目录导航

包级函数定义

函数名称	描述
Init	配置初始化
Load	加载配置
Refresh	刷新配置
WithTickerLoad	通过定时器加载配置
StopTickerLoad	停止通过定时器加载配置
RegConfigRefreshEvent	当配置刷新时将立即执行被注册的事件处理函数
OnConfigRefreshEvent	暂无描述...

类型定义

类型	名称	描述
STRUCT	RefreshEventHandle	配置刷新事件处理函数
INTERFACE	Loader	配置加载器

---

详情信息

func Init(loader ...Loader)

配置初始化

• 在初始化后会立即加载配置

---

func Load()

加载配置

• 加载后并不会刷新线上配置，需要执行 Refresh 函数对线上配置进行刷新

---

func Refresh()

刷新配置

---

func WithTickerLoad(ticker *timer.Ticker, interval time.Duration)

通过定时器加载配置

• 通过定时器加载配置后，会自动刷新线上配置
• 调用该函数后不会立即刷新，而是在 interval 后加载并刷新一次配置，之后每隔 interval 加载并刷新一次配置

---

func StopTickerLoad()

停止通过定时器加载配置

---

func RegConfigRefreshEvent(handle RefreshEventHandle)

当配置刷新时将立即执行被注册的事件处理函数

---

func OnConfigRefreshEvent()

---

RefreshEventHandle STRUCT

配置刷新事件处理函数

type RefreshEventHandle func()

Loader INTERFACE

配置加载器

type Loader interface {
	Load()
	Refresh()
}

Documentation

Overview

Package configuration 基于配置导表功能实现的配置加载及刷新功能

Index

• func Init(loader ...Loader)
• func Load()
• func OnConfigRefreshEvent()
• func Refresh()
• func RegConfigRefreshEvent(handle RefreshEventHandle)
• func StopTickerLoad()
• func WithTickerLoad(ticker *timer.Ticker, interval time.Duration)
• type Loader
• type RefreshEventHandle

Functions

func Init

func Init(loader ...Loader)

Init 配置初始化

• 在初始化后会立即加载配置

func Load

func Load()

Load 加载配置

• 加载后并不会刷新线上配置，需要执行 Refresh 函数对线上配置进行刷新

func OnConfigRefreshEvent

func OnConfigRefreshEvent()

func Refresh

func Refresh()

Refresh 刷新配置

func RegConfigRefreshEvent

func RegConfigRefreshEvent(handle RefreshEventHandle)

RegConfigRefreshEvent 当配置刷新时将立即执行被注册的事件处理函数

func StopTickerLoad

func StopTickerLoad()

StopTickerLoad 停止通过定时器加载配置

func WithTickerLoad

func WithTickerLoad(ticker *timer.Ticker, interval time.Duration)

WithTickerLoad 通过定时器加载配置

• 通过定时器加载配置后，会自动刷新线上配置
• 调用该函数后不会立即刷新，而是在 interval 后加载并刷新一次配置，之后每隔 interval 加载并刷新一次配置

Types

type Loader

type Loader interface {
	// Load 加载配置
	//   - 加载后并不会刷新线上配置，需要执行 Refresh 函数对线上配置进行刷新
	Load()
	// Refresh 刷新线上配置
	Refresh()
}

Loader 配置加载器

type RefreshEventHandle

type RefreshEventHandle func()

RefreshEventHandle 配置刷新事件处理函数