initialize

initialize

基于反射自动注入的config及dao(data access object)初始化，暴露一个全局变量，记录模块信息

example

go run _example/main.go -c _example/config/config.toml

feature

• 默认支持local config,支持本地多配置文件
• 支持环境区分(dev，test，prod,可自定义)
• 支持环境变量
• 支持命令行flag
• 支持监听文件变更
• 支持viper支持的所有格式("json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini")
• 支持远程配置中心,支持nacos,apollo,etcd,http请求作为配置中心,可自定义扩展

quick start

配置模板

# dev | test | stage | prod |...
Env = "dev" # 将会选择与Env名字相同的环境配置
[dev]
ConfigTemplateDir = "." # 模板目录,将会生成配置模板

仅需以上最小配置,点击启动,即可生成配置模板 如果还是麻烦,试试直接用 ${your app}.exe --format ${配置格式} -e ${环境} -p ${模板路径} 启动吧

启动配置

启动配置作为根配置,不会监听更改,用于记录应用名称,区分环境,配置不同环境所需的本地配置及配置中心,后续配置均从本地配置及配置中心加载及自动更新

Name = "hoper"
# dev | test | stage | prod |...
Env = "dev" # 将会选择与Env名字相同的环境配置

[dev]
debug = true
SkipInjectDaos = ["Apollo","Etcd", "Es"]
ConfigTemplateDir = "." # 将会生成配置模板
# 上方是一个个初始配置,如果不知道如何进行接下来的配置,可以先启动生成配置模板
[dev.localConfig]
Paths = ["local.toml"]
ReloadInterval = "1s"

[dev.ConfigCenter]
Format = "toml"
Type = "nacos"

[dev.ConfigCenter.http]
Url = "http://localhost:6666/local.toml"
ReloadInterval = "1s"

[dev.ConfigCenter.nacos]
DataId = "pro"
Group = "DEFAULT_GROUP"

[[dev.ConfigCenter.nacos.ServerConfigs]]
Scheme = "http"
IpAddr = "nacos"
Port = 9000
GrpcPort = 10000

[dev.ConfigCenter.nacos.ClientConfig]
NamespaceId = "xxx"
username = "nacos"
password = "nacos"
LogLevel = "debug"

import(
  "github.com/hopeio/initialize"
)
type config struct {
	//自定义的配置
	Customize serverConfig
}
type serverConfig struct{
    TokenMaxAge time.Duration
}


// 注入配置前初始化
func (c *config) BeforeInject() {
    c.Customize.TokenMaxAge = time.Second * 60 * 60 * 24
}
// 注入配置后初始化
func (c *config) AfterInject() {
	c.Customize.TokenMaxAge = time.Second * 60 * 60 * 24 * c.Customize.TokenMaxAge
}

func main() {
	global:= initialize.NewGlobal[*config,*initialize.EmbeddedPresets]()
    //配置初始化应该在第一位
    defer global.Cleanup()
}

Dao注入

import(
    "github.com/hopeio/initialize/contrib/gormdb/sqlite"
    initredis "github.com/hopeio/initialize/contrib/redis"
)
// dao dao.
type dao struct {
	// GORMDB 数据库连接
	GORMDB   *sqlite.DB
	StdDB    *sql.DB
}
// 注入配置前初始化
func (c *dao) BeforeInject() {
}
// 注入配置后初始化
func (c *dao) AfterInjectConfig() {
}
// 注入dao后初始化
func (d *dao) AfterInject() {
	db := d.GORMDB
	db.Callback().Create().Remove("gorm:save_before_associations")
	db.Callback().Create().Remove("gorm:save_after_associations")
	db.Callback().Update().Remove("gorm:save_before_associations")
	db.Callback().Update().Remove("gorm:save_after_associations")

	d.StdDB, _ = db.DB()
}
func main() {
    global:= initialize.NewGlobal[*config,*dao]()
    defer global.Cleanup()
}

原生集成了redis,gormdb(mysql,postgressql,sqlite),kafka,pebbledb,apollo,badgerdb,etcd,elasticsearch,nsq,ristretto,viper等，并且非常简单的支持自定义扩展,不局限于Dao对象，任何对象都支持根据配置自动注入生成

注入时使用root config

// initWithRootConfig
import "github.com/hopeio/initialize"
func (c *conf) BeforeInjectWithRoot(root *initialize.RootConfig) {
}
func (c *dao) BeforeInjectWithRoot(root *initialize.RootConfig) {
}
// AfterInjectConfigWithRoot(*initialize.RootConfig)
// AfterInjectWithRoot(*initialize.RootConfig)

单配置文件

如果你的项目不需要分环境,那么不要env这个配置,不要 -e flag,直接在启动目录放一个config.xxx文件即可 或者可以手动指定-c ${配置文件}

生成模板

要为单配置文件生成模板--format ${配置格式} -p ${模板路径}