ioc

package
v1.9.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2023 License: MIT Imports: 18 Imported by: 130

Documentation

Index

Constants

View Source
const (
	API_NAMESPACE = "apis"
)
View Source
const (
	CONFIG_NAMESPACE = "configs"
)
View Source
const (
	CONTROLLER_NAMESPACE = "controllers"
)
View Source
const (
	DEFAULT_NAMESPACE = "default"
)
View Source
const (
	DEFAULT_VERSION = "v1"
)

Variables

This section is empty.

Functions

func ConfigIocObject added in v1.9.20

func ConfigIocObject(req *LoadConfigRequest) error

func DevelopmentSetup added in v1.9.25

func DevelopmentSetup()

func GetIocObjectUid added in v1.9.26

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

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 added in v1.9.17

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 added in v1.9.20

func ValidateFileType(ext string) error

Types

type ConfigEnv added in v1.9.20

type ConfigEnv struct {
	Enabled bool
	Prefix  string
}

type ConfigFile added in v1.9.20

type ConfigFile struct {
	Enabled bool
	Path    string
}

type GRPCControllerObject

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

GRPCService GRPC服务的实例

type GetOption added in v1.9.19

type GetOption func(*option)

func WithVersion added in v1.9.19

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 added in v1.9.26

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

func NewInjectTag added in v1.9.26

func NewInjectTag() *InjectTag

func ParseInjectTag added in v1.9.26

func ParseInjectTag(v string) *InjectTag

autowire=true

type LoadConfigRequest added in v1.9.20

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

func NewLoadConfigRequest added in v1.9.20

func NewLoadConfigRequest() *LoadConfigRequest

type NamespaceStore added in v1.9.20

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

func (*NamespaceStore) Autowire added in v1.9.26

func (i *NamespaceStore) Autowire() error

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

func (*NamespaceStore) Close added in v1.9.20

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

func (*NamespaceStore) First added in v1.9.20

func (s *NamespaceStore) First() Object

第一个

func (*NamespaceStore) ForEach added in v1.9.20

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

func (*NamespaceStore) Get added in v1.9.20

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

func (*NamespaceStore) ImplementInterface added in v1.9.26

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

寻找实现了接口的对象

func (*NamespaceStore) Init added in v1.9.20

func (s *NamespaceStore) Init() error

func (*NamespaceStore) Last added in v1.9.20

func (s *NamespaceStore) Last() Object

最后一个

func (*NamespaceStore) Len added in v1.9.20

func (s *NamespaceStore) Len() int

func (*NamespaceStore) Less added in v1.9.20

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

func (*NamespaceStore) List added in v1.9.26

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

func (*NamespaceStore) Load added in v1.9.26

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

根据对象对象加载对象

func (*NamespaceStore) LoadFromEnv added in v1.9.20

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

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

func (*NamespaceStore) LoadFromFile added in v1.9.20

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

func (*NamespaceStore) Registry added in v1.9.20

func (s *NamespaceStore) Registry(v Object)

func (*NamespaceStore) SetPriority added in v1.9.20

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

func (*NamespaceStore) Sort added in v1.9.20

func (s *NamespaceStore) Sort()

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

func (*NamespaceStore) Swap added in v1.9.20

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

type Object added in v1.9.19

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 added in v1.9.20

type ObjectImpl struct {
}

func (*ObjectImpl) AllowOverwrite added in v1.9.20

func (i *ObjectImpl) AllowOverwrite() bool

func (*ObjectImpl) Close added in v1.9.25

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

func (*ObjectImpl) Init added in v1.9.20

func (i *ObjectImpl) Init() error

func (*ObjectImpl) Name added in v1.9.20

func (i *ObjectImpl) Name() string

func (*ObjectImpl) Priority added in v1.9.20

func (i *ObjectImpl) Priority() int

func (*ObjectImpl) Version added in v1.9.20

func (i *ObjectImpl) Version() string

type ObjectWrapper added in v1.9.26

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

func NewObjectWrapper added in v1.9.26

func NewObjectWrapper(obj Object) *ObjectWrapper

type StoreManage added in v1.9.20

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

type StoreUser added in v1.9.20

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

func Api added in v1.9.19

func Api() StoreUser

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

func Config added in v1.9.19

func Config() StoreUser

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

func Controller added in v1.9.19

func Controller() StoreUser

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

func Default added in v1.9.19

func Default() StoreUser

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

type Stroe added in v1.9.20

type Stroe interface {
	StoreUser
	StoreManage
}

Directories

Path Synopsis
apps
oss
config

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL