ipakku

type AppCache interface {

	// lib为库名, second:过期时间-1为不过期
	RegLib(clib string, second int64) error

	// Set 向lib库中设置键为key的值tb
	Set(clib string, key string, tb interface{}) error

	// Get 读取缓存信息
	Get(clib string, key string, val interface{}) error

	// Del 删除缓存信息
	Del(clib string, key string) error

	// Keys 获取库的所有key
	Keys(clib string) []string

	// Clear 清空库内容
	Clear(clib string)
}

type AppConfig interface {

	// GetConfig 读取key的value信息, 返回 Object 对象, 里面的值可能是string或者map
	GetConfig(key string) utypes.Object

	// SetConfig 设置值
	SetConfig(key string, value interface{}) error

	// ScanAndAutoConfig 扫描带有@autoconfig标签的字段, 并完成其配置
	ScanAndAutoConfig(ptr interface{}) error

	// ScanAndAutoValue 扫描带有@autovalue标签的字段, 并完成其配置
	ScanAndAutoValue(configPrefix string, ptr interface{}) error
}

type AppEvent interface {
	// 异步事件, 默认未实现
	PublishEvent(group string, name string, val interface{}) error
	ConsumerEvent(group string, name string, fun EventHandle) error
}

type AppService interface {
	HTTPService
	RPCService
	StartHTTP(serviceCfg HTTPServiceConfig)
	StartRPC(serviceCfg RPCServiceConfig)
}

type AppSyncEvent interface {
	PublishSyncEvent(group string, name string, val interface{}) error
	ConsumerSyncEvent(group string, name string, fun EventHandle) error
}

type Application interface {

	// GetInstanceID 获取实例的ID
	GetInstanceID() string

	// LoadModule 装载&初始化模块 - DO Setup -> Check Ver -> Do Init
	LoadModule(mt Module) Application

	// LoadModules 装载&初始化模块 - DO Setup -> Check Ver -> Do Init
	LoadModules(mts ...Module) Application

	// GetParam 获取变量, 模板加载器实例上的变量
	GetParam(key string) utypes.Object

	// SetParam 设置变量, 保存在模板加载器实例内部
	SetParam(key string, val interface{})

	// OnModuleEvent 监听模块生命周期事件
	OnModuleEvent(name string, event ModuleEvent, val OnModuleEvent)

	// GetModuleByName 根据模块Name获取模块指针记录, 可以获取一个已经实例化的模块
	GetModuleByName(name string, val interface{}) error

	// GetModule 批量获取模块, 模块名字和接口名字一样才能正常获得
	GetModules(val ...interface{}) error

	// Invoke 模块调用, 返回 []reflect.Value, 返回值暂时无法处理
	Invoke(name string, method string, params ...interface{}) ([]reflect.Value, error)

	// AutoWired 自动注入依赖对象
	AutoWired(structobj interface{}) error
}

type ApplicationBoot interface {

	// BootStart 加载&启动程序
	BootStart() Application

	// GetApplication 获取Application
	GetApplication() Application

	// AddModule 添加模块
	AddModule(mt Module) ApplicationBoot

	// AddModules 添加模块
	AddModules(mts ...Module) ApplicationBoot

	// EnableCoreModule 启用默认的核心模块
	EnableCoreModule() ApplicationBoot

	// EnableNetModule 启用默认的网络服务模块
	EnableNetModule() ApplicationBoot

	// SetLoggerOutput 设置日志输出方式
	SetLoggerOutput(w io.Writer) ApplicationBoot

	// SetLoggerLevel 设置日志输出级别 NONE DEBUG INFO ERROR
	SetLoggerLevel(lv logs.LoggerLeve) ApplicationBoot

	// DisableBanner 禁止Banner输出
	DisableBanner() ApplicationBoot
}

type Controller interface {
	AsController() ControllerConfig
}

type ControllerConfig struct {
	RequestMapping string // 请求路径, 也可以是版本号(v1|v2...)作为路径的一部分;
	RouterConfig          // 批量注册服务路径配置对象
	FilterConfig          // 过滤器配置对象, 自动添加前缀路径(RequestMapping值)
}

type EventHandle func(v interface{}) error

type FilterConfig struct {
	FilterFunc [][]interface{} // 需要注册的函数(注意注册顺序) [{"指定的url", "FilterFunc function"}]
}

type FilterFunc func(http.ResponseWriter, *http.Request) bool

type HTTPService interface {
	// Get Get
	Get(url string, fun HandlerFunc) error

	// Post Post
	Post(url string, fun HandlerFunc) error

	// Put Put
	Put(url string, fun HandlerFunc) error

	// Patch Patch
	Patch(url string, fun HandlerFunc) error

	// Head Head
	Head(url string, fun HandlerFunc) error

	// Options Options
	Options(url string, fun HandlerFunc) error

	// Delete Delete
	Delete(url string, fun HandlerFunc) error

	// Any Any
	Any(url string, fun HandlerFunc) error

	// AsRouter 批量注册路由, 可以再指定一个前缀url
	AsRouter(url string, router Router) error

	// AsController 批量注册路由, 使用RequestMapping字段作为前缀url
	AsController(router Controller) error

	// Filter Filter
	Filter(url string, fun FilterFunc) error

	// SetStaticDIR SetStaticDIR
	SetStaticDIR(path, dir string, fun FilterFunc) error

	// SetStaticFile SetStaticFile
	SetStaticFile(path, file string, fun FilterFunc) error
}

type HTTPServiceConfig struct {
	CertFile   string
	KeyFile    string
	ListenAddr string
	Server     *http.Server
}

type HandlerFunc func(http.ResponseWriter, *http.Request)

type ICache interface {

	// Init 初始化缓存管理器, 一个对象只能初始化一次
	Init(config AppConfig, appName string)

	// lib为库名, second:过期时间-1为不过期
	RegLib(clib string, second int64) error

	// Set 向lib库中设置键为key的值tb
	Set(clib string, key string, tb interface{}) error

	// Get 读取缓存信息
	Get(clib string, key string, val interface{}) error

	// Del 删除缓存信息
	Del(clib string, key string) error

	// Keys 获取库的所有key
	Keys(clib string) []string

	// Clear 清空库内容
	Clear(clib string)
}

type IConfig interface {

	// Init 初始化解析器
	Init(appName string) error

	// GetConfig 读取key的value信息, 返回 Object 对象, 里面的值可能是string或者map
	GetConfig(key string) (res utypes.Object)

	// SetConfig 设置值
	SetConfig(key string, value interface{}) error
}

type IEvent interface {
	// 异步事件, 默认未实现
	Init(conf AppConfig) error
	PublishEvent(name string, val string, obj interface{}) error
	ConsumerEvent(group string, name string, fun EventHandle) error
}

type Loader interface {

	// GetInstanceID 获取实例的ID
	GetInstanceID() string

	// Load 装载&初始化模块, 初始化顺序: doReady -> doSetup -> doCheckVersion -> doInit -> doEnd
	Load(mt Module)

	// Loads 装载&初始化模块, 初始化顺序: doReady -> doSetup -> doCheckVersion -> doInit -> doEnd
	Loads(mts ...Module)

	// GetParam 获取变量, 模板加载器实例上的变量
	GetParam(key string) utypes.Object

	// SetParam 设置变量, 保存在模板加载器实例内部
	SetParam(key string, val interface{})

	// GetModuleVersion 获取模块版本号
	GetModuleVersion(name string) string

	// OnModuleEvent 监听模块生命周期事件
	OnModuleEvent(name string, event ModuleEvent, val OnModuleEvent)

	// SetModuleInfoHandler 设置模块信息记录器
	SetModuleInfoHandler(moduleInfo ModuleInfo)

	// GetModuleByName 根据模块Name获取模块指针记录, 可以获取一个已经实例化的模块
	GetModuleByName(name string, val interface{}) error

	// GetModules 获取模块, 模块名字和接口名字一样才能正常获得
	GetModules(val ...interface{}) error

	// Invoke 模块调用, 返回 []reflect.Value, 返回值暂时无法处理
	Invoke(name string, method string, params ...interface{}) ([]reflect.Value, error)

	// AutoWired 自动注入依赖对象
	AutoWired(structobj interface{}) error
}

type Method string

type Module interface {
	AsModule() Opts
}

type ModuleEvent string

type ModuleInfo interface {
	Init(appName string) error
	GetValue(key string) string
	SetValue(key string, value string) error
}

type OnModuleEvent func(module interface{}, loader Loader)

type Opts struct {
	Name        string                     // [可选] 模块ID, 不填则为结构体名称
	Version     float64                    // [必填] 模块版本
	Description string                     // [可选] 模块描述
	Updaters    func(mctx Loader) Updaters // [可选] 模块升级执行器, 一个版本执行一次
	OnReady     func(mctx Loader)          // [可选] 每次加载模块开始之前执行
	OnSetup     func()                     // [可选] 模块安装, 一个模块只初始化一次
	OnInit      func()                     // [可选] 每次模块安装、升级后执行一次
}

type RPCService interface {
	RegisteRPC(rcvr interface{}) error
}

type RPCServiceConfig struct {
	Network    string
	ListenAddr string
	Listener   net.Listener
}

type Router interface {
	AsRouter() serviceutil.RouterConfig
}

type RouterConfig serviceutil.RouterConfig

type Updater interface {
	// Version 要升级到的版本号
	Version() float64
	// Execute 执行升级
	Execute(mctx Loader) error
}

type Updaters []Updater