ioc

Documentation

Index

• Constants
• func ConfigIocObject(req *LoadConfigRequest) error
• func DevelopmentSetup()
• func GetIocObjectUid(obj Object) (name, version string)
• func GrpcControllerCount() int
• func InitIocObject() error
• func LoadGinApi(pathPrefix string, root gin.IRouter)
• func LoadGoRestfulApi(pathPrefix string, root *restful.Container)
• func LoadGrpcController(server *grpc.Server)
• func ObjectUid(o *ObjectWrapper) string
• func RegistryApi(obj Object)
• func RegistryController(obj Object)
• func RegistryObjectWithNs(namespace string, obj Object)
• func ValidateFileType(ext string) error
• type ConfigEnv
• type ConfigFile
• type GRPCControllerObject
• type GetOption
  • func WithVersion(v string) GetOption
• type GinApiObject
• type GoRestfulApiObject
• type InjectTag
  • func NewInjectTag() *InjectTag
  • func ParseInjectTag(v string) *InjectTag
• type LoadConfigRequest
  • func NewLoadConfigRequest() *LoadConfigRequest
• type NamespaceStore
  • func (i *NamespaceStore) Autowire() error
  • func (s *NamespaceStore) Close(ctx context.Context) error
  • func (s *NamespaceStore) Count() int
  • func (s *NamespaceStore) First() Object
  • func (s *NamespaceStore) ForEach(fn func(*ObjectWrapper))
  • func (s *NamespaceStore) Get(name string, opts ...GetOption) Object
  • func (s *NamespaceStore) ImplementInterface(objType reflect.Type, opts ...GetOption) (objs []Object)
  • func (s *NamespaceStore) Init() error
  • func (s *NamespaceStore) Last() Object
  • func (s *NamespaceStore) Len() int
  • func (s *NamespaceStore) Less(i, j int) bool
  • func (s *NamespaceStore) List() (uids []string)
  • func (s *NamespaceStore) Load(target any, opts ...GetOption) error
  • func (i *NamespaceStore) LoadFromEnv(prefix string) error
  • func (i *NamespaceStore) LoadFromFile(filename string) error
  • func (s *NamespaceStore) Registry(v Object)
  • func (s *NamespaceStore) SetPriority(v int) *NamespaceStore
  • func (s *NamespaceStore) Sort()
  • func (s *NamespaceStore) Swap(i, j int)
• type Object
  • func GetApi(name string) Object
  • func GetController(name string) Object
  • func GetObjectWithNs(namespace, name string) Object
• type ObjectImpl
  • func (i *ObjectImpl) AllowOverwrite() bool
  • func (i *ObjectImpl) Close(ctx context.Context) error
  • func (i *ObjectImpl) Init() error
  • func (i *ObjectImpl) Name() string
  • func (i *ObjectImpl) Priority() int
  • func (i *ObjectImpl) Version() string
• type ObjectWrapper
  • func NewObjectWrapper(obj Object) *ObjectWrapper
• type StoreManage
• type StoreUser
  • func Api() StoreUser
  • func Config() StoreUser
  • func Controller() StoreUser
  • func Default() StoreUser
• type Stroe

Constants

const (
	API_NAMESPACE = "apis"
)

const (
	CONFIG_NAMESPACE = "configs"
)

const (
	CONTROLLER_NAMESPACE = "controllers"
)

const (
	DEFAULT_NAMESPACE = "default"
)

const (
	DEFAULT_VERSION = "v1"
)

Functions

func ConfigIocObject

func ConfigIocObject(req *LoadConfigRequest) error

func DevelopmentSetup

func DevelopmentSetup()

func GetIocObjectUid

func GetIocObjectUid(obj Object) (name, version string)

func GrpcControllerCount

func GrpcControllerCount() int

func InitIocObject

func InitIocObject() error

func LoadGinApi

func LoadGinApi(pathPrefix string, root gin.IRouter)

LoadGinApi 装载所有的gin app

func LoadGoRestfulApi

func LoadGoRestfulApi(pathPrefix string, root *restful.Container)

LoadHttpApp 装载所有的http app

func LoadGrpcController

func LoadGrpcController(server *grpc.Server)

LoadGrpcApp 加载所有的Grpc app

func ObjectUid

func ObjectUid(o *ObjectWrapper) string

func RegistryApi

func RegistryApi(obj Object)

注册API对象

func RegistryController

func RegistryController(obj Object)

控制器对象注册

func RegistryObjectWithNs

func RegistryObjectWithNs(namespace string, obj Object)

注册对象

func ValidateFileType

func ValidateFileType(ext string) error

Types

type ConfigEnv

type ConfigEnv struct {
	Enabled bool
	Prefix  string
}

type ConfigFile

type ConfigFile struct {
	Enabled bool
	Path    string
}

type GRPCControllerObject

type GRPCControllerObject interface {
	Object
	Registry(*grpc.Server)
}

GRPCService GRPC服务的实例

type GetOption

type GetOption func(*option)

func WithVersion

func WithVersion(v string) GetOption

type GinApiObject

type GinApiObject interface {
	Object
	Registry(gin.IRouter)
}

type GoRestfulApiObject

type GoRestfulApiObject interface {
	Object
	Registry(*restful.WebService)
}

type InjectTag

type InjectTag struct {
	// 是否自动注入
	Autowire bool
	// 空间
	Namespace string
	// 注入对象的名称
	Name string
	// 注入对象的版本, 默认v1
	Version string
}

func NewInjectTag

func NewInjectTag() *InjectTag

func ParseInjectTag

func ParseInjectTag(v string) *InjectTag

autowire=true

type LoadConfigRequest

type LoadConfigRequest struct {
	// 环境变量配置
	ConfigEnv *ConfigEnv
	// 文件配置方式
	ConfigFile *ConfigFile
}

func NewLoadConfigRequest

func NewLoadConfigRequest() *LoadConfigRequest

type NamespaceStore

type NamespaceStore struct {
	// 空间名称
	Namespace string
	// 空间优先级
	Priority int
	// 空间对象列表
	Items []*ObjectWrapper
}

func (*NamespaceStore) Autowire

func (i *NamespaceStore) Autowire() error

从环境变量中加载对象配置

func (*NamespaceStore) Close

func (s *NamespaceStore) Close(ctx context.Context) error

func (*NamespaceStore) Count

func (s *NamespaceStore) Count() int

对象个数统计

func (*NamespaceStore) First

func (s *NamespaceStore) First() Object

第一个

func (*NamespaceStore) ForEach

func (s *NamespaceStore) ForEach(fn func(*ObjectWrapper))

func (*NamespaceStore) Get

func (s *NamespaceStore) Get(name string, opts ...GetOption) Object

func (*NamespaceStore) ImplementInterface

func (s *NamespaceStore) ImplementInterface(objType reflect.Type, opts ...GetOption) (objs []Object)

寻找实现了接口的对象

func (*NamespaceStore) Init

func (s *NamespaceStore) Init() error

func (*NamespaceStore) Last

func (s *NamespaceStore) Last() Object

最后一个

func (*NamespaceStore) Len

func (s *NamespaceStore) Len() int

func (*NamespaceStore) Less

func (s *NamespaceStore) Less(i, j int) bool

func (*NamespaceStore) List

func (s *NamespaceStore) List() (uids []string)

func (*NamespaceStore) Load

func (s *NamespaceStore) Load(target any, opts ...GetOption) error

根据对象对象加载对象

func (*NamespaceStore) LoadFromEnv

func (i *NamespaceStore) LoadFromEnv(prefix string) error

从环境变量中加载对象配置

func (*NamespaceStore) LoadFromFile

func (i *NamespaceStore) LoadFromFile(filename string) error

func (*NamespaceStore) Registry

func (s *NamespaceStore) Registry(v Object)

func (*NamespaceStore) SetPriority

func (s *NamespaceStore) SetPriority(v int) *NamespaceStore

func (*NamespaceStore) Sort

func (s *NamespaceStore) Sort()

根据对象的优先级进行排序

func (*NamespaceStore) Swap

func (s *NamespaceStore) Swap(i, j int)

type Object

type Object interface {
	// 对象初始化
	Init() error
	// 对象的名称
	Name() string
	// 对象版本
	Version() string
	// 对象优先级
	Priority() int
	// 对象的销毁
	Close(ctx context.Context) error
	// 是否允许同名对象被替换, 默认不允许被替换
	AllowOverwrite() bool
}

Object 内部服务实例, 不需要暴露

func GetApi

func GetApi(name string) Object

获取API对象

func GetController

func GetController(name string) Object

获取控制器对象

func GetObjectWithNs

func GetObjectWithNs(namespace, name string) Object

获取对象

type ObjectImpl

type ObjectImpl struct {
}

func (*ObjectImpl) AllowOverwrite

func (i *ObjectImpl) AllowOverwrite() bool

func (*ObjectImpl) Close

func (i *ObjectImpl) Close(ctx context.Context) error

func (*ObjectImpl) Init

func (i *ObjectImpl) Init() error

func (*ObjectImpl) Name

func (i *ObjectImpl) Name() string

func (*ObjectImpl) Priority

func (i *ObjectImpl) Priority() int

func (*ObjectImpl) Version

func (i *ObjectImpl) Version() string

type ObjectWrapper

type ObjectWrapper struct {
	Name           string
	Version        string
	AllowOverwrite bool
	Priority       int
	Value          Object
}

func NewObjectWrapper

func NewObjectWrapper(obj Object) *ObjectWrapper

type StoreManage

type StoreManage interface {
	// 从环境变量中加载对象配置
	LoadFromEnv(prefix string) error
}

type StoreUser

type StoreUser interface {
	// 对象注册
	Registry(obj Object)
	// 对象获取
	Get(name string, opts ...GetOption) Object
	// 根据对象类型, 直接加载对象
	Load(obj any, opts ...GetOption) error
	// 打印对象列表
	List() []string
	// 数量统计
	Count() int
	// 遍历注入的对象
	ForEach(fn func(*ObjectWrapper))
}

func Api

func Api() StoreUser

用于托管RestApi对象的Ioc空间, 最后初始化

func Config

func Config() StoreUser

用于托管配置对象的Ioc空间, 最先初始化

func Controller

func Controller() StoreUser

用于托管控制器对象的Ioc空间, 配置完成后初始化

func Default

func Default() StoreUser

默认空间, 用于托管工具类, 在控制器之前进行初始化

type Stroe

type Stroe interface {
	StoreUser
	StoreManage
}