1. iocgo簡介

習慣于Java或者C#開發的人應該對控制反轉與依賴注入應該再熟悉不過了。在Java平臺有鼎鼎大名的Spring框架，在C#平臺有Autofac,Unity,Windsor等，我當年C#開發時用的最多的就是Windsor。使用IoC容器是面向對象開發中非常方便的解耦模塊之間的依賴的方法。各個模塊之間不依賴于實現，而是依賴于接口，然后在構造函數或者屬性或者方法中注入特定的實現，方便了各個模塊的拆分以及模塊的獨立單元測試。

在[長安鏈]的設計中，各個模塊可以靈活組裝，模塊之間的依賴基于protocol中定義的接口，每個接口有一個或者多個官方實現，當然第三方也可以提供該接口更多的實現。為了實現更靈活的組裝各個模塊，管理各個模塊的依賴關系，于是我寫了iocgo這個輕量級的golang版Ioc容器。

2. iocgo如何使用

2.1 iocgo包的安裝

現在go官方版本已經出到1.17了，當然我在代碼中其實也沒有用什么新版本的新特性，于是就用1.15版本或者之后的Go版本即可。要使用iocgo包，直接通過go get添加到項目中：

go get github.com/studyzy/iocgo

2.2 使用示例與說明

2.2.1 最簡單的例子：

type Fooer interface {
	Foo(int)
}
type Foo struct {
}
func (Foo)Foo(i int)  {
	fmt.Println("foo:",i)
}
type Barer interface {
	Bar(string)
}
type Bar struct {
}
func (Bar) Bar(s string){
	fmt.Println("bar:",s)
}
type Foobarer interface {
	Say(int,string)
}
type Foobar struct {
	foo Fooer
	bar Barer
}
func NewFoobar(f Fooer,b Barer) Foobarer{
	return &Foobar{
		foo: f,
		bar: b,
	}
}
func (f Foobar)Say(i int ,s string)  {
	f.foo.Foo(i)
	f.bar.Bar(s)
}
func TestContainer_SimpleRegister(t *testing.T) {
	container := NewContainer()
	container.Register(NewFoobar)
	container.Register(func() Fooer { return &Foo{} })
	container.Register(func() Barer { return &Bar{} })
	var fb Foobarer
	container.Resolve(&fb)
	fb.Say(123,"Hello World")
}

這里我使用NewContainer()創建了一個新的容器，然后在容器中調用Register方法注冊了3個接口和對應的構造函數，分別是：

• Foobarer接口對應NewFoobar(f Fooer,b Barer)構造函數
• Fooer接口對應構造&Foo{}的匿名函數。
• Barer接口對應構造&Bar{}的匿名函數。

接下來調用Resolve函數，并傳入var fb Foobarer 這個接口變量的指針，iocgo就會自動去構建Foobarer對應的實例，并最終將實例賦值到fb這個變量上，于是最后我們就可以正常調用fb.Say實例方法了。

2.22. Register 的選項

iocgo的注冊interface到對象的函數定義如下：

func Register(constructor interface{}, options ...Option) error

iocgo為Register函數提供了以下參數選項可根據實際情況選擇性使用:

• Name 為某個interface->對象的映射命名
• Optional 表名這個構造函數中哪些注入的interface參數是可選的，如果是可選，那么就算找不到interface對應的實例也不會報錯。
• Interface 顯式聲明這個構造函數返回的實例是映射到哪個interface。
• Lifestyle(isTransient) 聲明這個構造函數在構造實例后是構造的臨時實例還是單例實例，如果是臨時實例，那么下次再獲取該interface對應的實例時需要再次調用構造函數，如果是單例，那么就緩存實例到容器中，下次再想獲得interface對應的實例時直接使用緩存中的，不需要再次構造。
• DependsOn 這個主要是指定構造函數中的某個參數在通過容器獲得對應的實例時，應該通過哪個Name去獲得對應的實例。
• Parameters 這個主要用于指定構造函數中的某些非容器托管的參數，比如某構造函數中有int，string等參數，而這些參數的實例是不需要通過ioc容器進行映射托管的，那么就在這里直接指定。
• Default 這個主要用于設置一個interface對應的默認的實例，也就是如果沒有指定Name的情況下，應該找哪個實例。 關于每一個參數該如何使用，我都寫了UT樣例，具體參考： container_test.go

2.2.3. 注冊實例

如果我們已經有了某個對象的實例，那么可以將該實例和其想映射的interface直接注冊到ioc容器中，方便其他依賴的對象獲取，RegisterInstance函數定義如下:

RegisterInstance(interfacePtr interface{}, instance interface{}, options ...Option) error?

使用上也很簡單，直接將實例對應的interface的指針作為參數1，實例本身作為參數2，傳入RegisterInstance即可：

b := &Bar{}
var bar Barer //interface
container.RegisterInstance(&bar, b) // register interface -> instance

2.2.4. 獲得實例

相關映射我們通過Register函數和RegisterInstance函數已經注冊到容器中，接下來就需要從容器獲得指定的實例了。獲得實例需要調用函數：

func Resolve(abstraction interface{}, options ...ResolveOption) error

這里第一個參數abstraction是我們想要獲取的某個interface的指針，第二個參數是可選參數，目前提供的選項有：

• ResolveName 指定使用哪個name的interface和實例的映射，如果不指定，那么就是默認映射。
• Arguments 指定在調用對應的構造函數獲得實例時，傳遞的參數，比如int，string等類型的不在ioc容器中托管的參數，可以在這里指定。如果構造函數本身需要這些參數，而且在前面Register的時候已經通過Parameters選項進行了指定，那么這里新的指定會覆蓋原有Register的指定。

var fb Foobarer
err:=container.Resolve(&fb)

另外如果我們的構造函數return的值中支持error，而且實際構造的時候確實返回了error，那么Resolve函數也會返回對應的這個err。

特別注意：Resolve的第一個參數是申明的某個interface的指針，一定要是指針，不能直接傳interface

2.2.5. 結構體參數和字段填充

有些時候構造函數的入參非常多，于是我們可以申明一個結構體，把所有入參都放入這個結構體中，這樣構造函數就只需要一個參數了。iocgo也支持自動填充這個結構體中interface對應的實例，從而構造新的對象。另外iocgo也提供了Fill方法，可以直接填充某個結構體，比如：

type FoobarInput struct {
	foo Fooer
	bar Barer
	msg string
}
input := FoobarInput{
		msg: "studyzy",
	}
	container.Register(func() Fooer { return &Foo{} })
	container.Register(func() Barer { return &Bar{} })
	err := container.Fill(&input)

結構體中的字段還支持tag，目前提供的tag有兩種：

• name //指定這個字段在獲得對應的實例時使用的name
• optional //指定這個字段是否是可選的，如果是，那么就算獲得不到對應的實例，也不會報錯。 示例example:

type FoobarInputWithTag struct {
	foo Fooer `optional:"true"`
	bar Barer `name:"baz"`
	msg string
}

2.2.6. 函數調用

除了構造函數注入之外，iocgo也支持函數注入，我們申明一個函數，這個函數的參數中有些參數是interface，那么通過調用iocgo中的Call方法，可以為這個函數注入對應的實例作為參數，并最終完成函數的調用。 示例 example:

func SayHi1(f Fooer, b Barer) {
	f.Foo(1234)
	b.Bar("hi")
}
Register(func() Fooer { return &Foo{} })
Register(func() Barer { return &Bar{} })
Call(SayHi1)

Call函數也是支持選項的，目前提供了2個選項:

• CallArguments 指定函數中某個參數的值
• CallDependsOn 指定函數中某個參數在通過ioc容器獲得實例時使用哪個name來獲得實例。 最后函數調用完成，如果函數本身有多個返回值，有error返回，那么Call函數也會返回對應的結果。

2.3 參考:

在寫這個iocgo的代碼時，主要參考了以下兩個Ioc相關的項目：

• https://github.com/golobby/container
• https://github.com/castleproject/Windsor

3. 總結

iocgo是一個純Golang語言開發的用于管理依賴注入的IoC容器，使用這個容器可以很好的實現go語言下的面向對象開發，模塊解耦。現已經開源，歡迎大家使用，開源地址：https://github.com/studyzy/iocgo