core

README

DIO

一个基于 DI 的项目框架。内置了：

• zap log日志框架，使用file-rotatelogs 实现日志滚动

Documentation

Index

• Constants
• func EnvDefault(key string, def string) (val string)
• func UUID() string
• type Dio
• type Log
• type PluginConfig
• type Property

Constants

const DefaultTraceName = "X-Request-Id"

Functions

func EnvDefault

func EnvDefault(key string, def string) (val string)

func UUID

func UUID() string

Types

type Dio

type Dio interface {
	// SetDefaultProperty 设置默认配置项
	SetDefaultProperty(key string, value interface{}) Dio

	// SetDefaultPropertyMap 设置多条默认配置项
	SetDefaultPropertyMap(properties map[string]interface{}) Dio

	// SetProperty 设置配置项
	SetProperty(key string, value interface{}) Dio

	// SetPropertyMap 设置多条配置项
	SetPropertyMap(properties map[string]interface{}) Dio

	// HasProperty 判断是否存在配置项
	HasProperty(property string) bool

	// GetPropertyString 获取配置项值
	GetPropertyString(property string) string

	// GetProperties 加载配置值到结构体
	GetProperties(prefix string, destType interface{}) interface{}

	// LoadDefaultConfig 从文件中加载默认配置
	LoadDefaultConfig(configs fs.FS, filename string) Dio

	// LoadConfig 从文件中加载配置
	LoadConfig(configs fs.FS, filename string) Dio

	// AutoMigrateEnv 载入环境变量到配置
	AutoMigrateEnv() Dio

	SetLogger(log Log) Dio

	Logger() Log

	// RegisterBean 注册bean实例
	RegisterBean(beanInstance ...interface{}) Dio

	// RegisterNamedBean 指定名称注册bean实例
	RegisterNamedBean(beanName string, beanInstance interface{}) Dio

	// Provide 注册bean原型
	Provide(prototype ...interface{}) Dio

	// ProvideNamedBean 指定名称注册bean原型
	ProvideNamedBean(beanName string, prototype interface{}) Dio

	// ProvideMultiNamedBean 根据map注册多个bean原型
	ProvideMultiNamedBean(namedBeanMap map[string]interface{}) Dio

	// OnProperty 按条件执行
	OnProperty(property string, compareValue string, caseSensitive bool, fn func(Dio)) Dio

	// NotOnProperty 按条件执行
	NotOnProperty(property string, compareValue string, caseSensitive bool, fn func(Dio)) Dio

	// ProvideOnProperty 按条件注册bean原型
	ProvideOnProperty(prototype interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideMultiBeanOnProperty 按条件注册多个bean原型
	ProvideMultiBeanOnProperty(beans []interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideNamedBeanOnProperty 按条件指定名称注册bean原型
	ProvideNamedBeanOnProperty(beanName string, prototype interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideMultiNamedBeanOnProperty 按条件根据map注册多个bean原型
	ProvideMultiNamedBeanOnProperty(namedBeanMap map[string]interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideNotOnProperty 按条件注册bean原型
	ProvideNotOnProperty(prototype interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideMultiBeanNotOnProperty 按条件注册多个bean原型
	ProvideMultiBeanNotOnProperty(beans []interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideNamedBeanNotOnProperty 按条件指定名称注册bean原型
	ProvideNamedBeanNotOnProperty(beanName string, prototype interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// ProvideMultiNamedBeanNotOnProperty 按条件根据map注册多个bean原型
	ProvideMultiNamedBeanNotOnProperty(namedBeanMap map[string]interface{}, property string, compareValue string, caseSensitive ...bool) Dio

	// GetBean 根据名称从容器中获取bean实例
	GetBean(beanName string) (bean interface{}, ok bool)

	// GetByType 根据类型从容器中获取bean实例
	GetByType(beanType interface{}) (bean interface{}, ok bool)

	// NewBean 根据类型从容器中创建一个新的bean实例
	NewBean(beanType interface{}) (bean interface{})

	// NewBeanByName 根据名称从容器中创建一个新的bean实例
	NewBeanByName(beanName string) (bean interface{})

	// Use 使用插件
	Use(plugins ...PluginConfig) Dio

	// Run 运行
	Run(ctx context.Context, afterRunFns ...func(Dio))
}

type Log

type Log interface {
	Named(string) Log
	Skip(skip int) Log
	Logger() interface{}
	Trace(ctx context.Context) context.Context
	TraceWith(ctx context.Context, val any) context.Context

	Debug(ctx context.Context, msg string, keyAndValues ...interface{})
	Debugw(ctx context.Context, msg string, keyAndValues ...map[string]interface{})
	Info(ctx context.Context, msg string, keyAndValues ...interface{})
	Infow(ctx context.Context, msg string, keyAndValues ...map[string]interface{})
	Warn(ctx context.Context, msg string, keyAndValues ...interface{})
	Warnw(ctx context.Context, msg string, keyAndValues ...map[string]interface{})
	Error(ctx context.Context, msg string, keyAndValues ...interface{})
	Errorw(ctx context.Context, msg string, keyAndValues ...map[string]interface{})
}

type PluginConfig

type PluginConfig func(Dio)

type Property

type Property struct {
	Name      string `value:"name"`
	Dir       string `value:"dir"`
	MaxAge    int    `value:"max-age"` // 存活日期，单位天
	DebugMode bool   `value:"debug"`
	Std       bool   `value:"std"`
	File      bool   `value:"file"`
	TraceName string `value:"trace-Name"` // 会话追踪名称
}