Golang輕量級IoC容器安裝使用範例

2022-06-24 10:01:54

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 &amp;Foo{} })
Register(func() Barer { return &amp;Bar{} })
Call(SayHi1)

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