framework

Documentation

Index

• type Container
• type NewInstance
• type ServiceProvider
• type YgoContainer
  • func NewYgoContainer() *YgoContainer
  • func (ygo *YgoContainer) Bind(provider ServiceProvider) error
  • func (ygo *YgoContainer) IsBind(key string) bool
  • func (ygo *YgoContainer) Make(key string) (interface{}, error)
  • func (ygo *YgoContainer) MakeNew(key string, params []interface{}) (interface{}, error)
  • func (ygo *YgoContainer) MustMake(key string) interface{}
  • func (ygo *YgoContainer) NameList() []string
  • func (ygo *YgoContainer) PrintProviders() []string

Types

type Container

type Container interface {
	// Bind 绑定一个服务提供者，如果关键字凭证已经存在，会进行替换操作，返回error
	Bind(provider ServiceProvider) error
	// IsBind 关键字凭证是否已经绑定服务提供者
	IsBind(key string) bool

	// Make 根据关键字凭证获取一个服务，
	Make(key string) (interface{}, error)
	// MustMake 根据关键字凭证获取一个服务，如果这个关键字凭证未绑定服务提供者，那么会panic。
	// 所以在使用这个接口的时候请保证服务容器已经为这个关键字凭证绑定了服务提供者。
	MustMake(key string) interface{}
	// MakeNew 根据关键字凭证获取一个服务，只是这个服务并不是单例模式的
	// 它是根据服务提供者注册的启动函数和传递的params参数实例化出来的
	// 这个函数在需要为不同参数启动不同实例的时候非常有用
	MakeNew(key string, params []interface{}) (interface{}, error)
	// 列出当前容器绑定的所有服务提供者
	NameList() []string
}

Container 是一个服务容器，提供绑定服务和获取服务的功能

type NewInstance

type NewInstance func(...interface{}) (interface{}, error)

NewInstance 定义了如何创建一个新实例，所有服务容器的创建服务

type ServiceProvider

type ServiceProvider interface {
	// Register 在服务容器中注册了一个实例化服务的方法，是否在注册的时候就实例化这个服务，需要参考 IsDefer 接口。
	Register(Container) NewInstance
	// Boot 在调用实例化服务的时候会调用，可以把一些准备工作：基础配置，初始化参数的操作放在这个里面。
	// 如果 Boot 返回 error，整个服务实例化就会实例化失败，返回错误
	Boot(Container) error
	// IsDefer 决定是否在注册的时候实例化这个服务，如果不是注册的时候实例化，那就是在第一次 make 的时候进行实例化操作
	// false 表示不需要延迟实例化，在注册的时候就实例化。true 表示延迟实例化
	IsDefer() bool
	// Params params 定义传递给 NewInstance 的参数，可以自定义多个，建议将 container 作为第一个参数
	Params(Container) []interface{}
	// Name 代表了这个服务提供者的凭证
	Name() string
}

ServiceProvider 定义一个服务提供者需要实现的接口

type YgoContainer

type YgoContainer struct {
	Container
	// contains filtered or unexported fields
}

YgoContainer 是服务容器的具体实现

func NewYgoContainer

func NewYgoContainer() *YgoContainer

NewYgoContainer 单例模式创建一个服务容器

func (*YgoContainer) Bind

func (ygo *YgoContainer) Bind(provider ServiceProvider) error

Bind 将服务容器和关键字做了绑定

func (*YgoContainer) IsBind

func (ygo *YgoContainer) IsBind(key string) bool

func (*YgoContainer) Make

func (ygo *YgoContainer) Make(key string) (interface{}, error)

func (*YgoContainer) MakeNew

func (ygo *YgoContainer) MakeNew(key string, params []interface{}) (interface{}, error)

func (*YgoContainer) MustMake

func (ygo *YgoContainer) MustMake(key string) interface{}

func (*YgoContainer) NameList

func (ygo *YgoContainer) NameList() []string

NameList 列出容器中所有服务提供者的字符串凭证

func (*YgoContainer) PrintProviders

func (ygo *YgoContainer) PrintProviders() []string

PrintProviders 输出服务容器中注册的关键字