目錄

• go微服務框架kratos學習筆記八(kratos的依賴注入)
  • 什麼是依賴注入
  • google wire
  • kratos中的wire
    • wire.NewSet
    • Binding Interfaces

go微服務框架kratos學習筆記八(kratos的依賴注入)

---

筆記二提過依賴注入，和如何生成，但沒有細講，本文來簡單看看kratos的依賴注入。

什麼是依賴注入

先來看一個小程式，

建立一個小程式模擬迎賓員問候客人的事件

我們將建立三個結構型別:

1)為迎賓員建立訊息 message
2)表達訊息的迎賓員 greeter
3)迎賓員問候客人的事件 event

type Message string

type Greeter struct {
    // ... TBD
}

type Event struct {
    // ... TBD
}

Message 僅僅攜帶一條string，現在我們建立一個簡單初始器

func NewMessage() Message {
    return Message("Hi there!")
}

我們的Greeter將需要引用這條訊息，讓我們建立一條初始器給Greeter

func NewGreeter(m Message) Greeter {
    return Greeter{Message: m}
}

type Greeter struct {
    Message Message // <- adding a Message field
}

在這個初始器中我們分配了Message 欄位給Greeter，現在我們能用Greeter的方法Greet來得到一條Message

func (g Greeter) Greet() Message {
    return g.Message
}

下一步，我們同樣也需要一個初始器用Event來建立一個Greeter

。

func NewEvent(g Greeter) Event {
    return Event{Greeter: g}
}

type Event struct {
    Greeter Greeter // <- adding a Greeter field
}

新增一個Start()來啟動事件

func (e Event) Start() {
    msg := e.Greeter.Greet()
    fmt.Println(msg)
}

Start即是我們小程式的核心，它告訴greeter去放出一條問候並打印出來。

現在我們小程式所有的元件就緒了，看看它是如何初始化所有元件的，它看起來可能是這樣的

func main() {
    message := NewMessage()
    greeter := NewGreeter(message)
    event := NewEvent(greeter)

    event.Start()
}

首先我們建立一條message，然後我們用message建立一個greeter，最後我們用greeter建立一個event.

這其實就是依賴注入dependency injection簡稱di的原理，

依賴注入基本上就是提供物件需要的物件（其依賴），而不是讓物件自己構造它們。

依賴注入能讓測試變的更為簡單，我們可以通過建構函式來進行注入。

SomeClass() has its constructor as following:

public SomeClass() {
    myObject = Factory.getObject();
}

例如，如果myObject包含複雜的任務像磁碟訪問或者網路訪問，那麼SomeClass將很難進行單元測試。程式必須模仿myObject並且需要模仿Factory呼叫

而將myObject作為引數傳遞給建構函式.

public SomeClass (MyClass myObject) {
    this.myObject = myObject;
}

myObject就能直接執行，使測試變的更為簡單。

可以通過多種方式將依賴項注入到物件中（例如建構函式注入或setter注入）。甚至可以使用專門的依賴項注入框架（例如Spring）來做到這一點，但是肯定不是必需的。不需要那些框架的依賴注入。顯式例項化和傳遞物件（依賴項）與框架注入一樣好。

google wire

kratos 使用的 google wire 就是golang的一個依賴注入解決的工具，這個工具能夠自動生成類的依賴關係。

依賴注入的一個缺點就是需要如此多的初始化步驟，讓我們看看如何使用Wire來讓初始化我們的元件變的更快.

將我們的小程式main函式改成如下形式：

func main() {
    e := InitializeEvent()

    e.Start()
}

下一步，分離一個檔案wire.go，我們定義InitializeEvent

// wire.go

func InitializeEvent() Event {
    wire.Build(NewEvent, NewGreeter, NewMessage)
    return Event{}
}

不是依次初始化每個元件並將其傳遞給下一個元件，而是通過一個wire.Build呼叫來構建我們想要的用的初始器。在Wire中，初始化器被稱為providers，一個提供特定型別的函式。

我們為Event新增一個零值作為返回值，以滿足編譯器的要求。
注意，即使我們向Event新增值，Wire也會忽略它們。
實際上，注入器的目的是提供關於使用哪些providers來構造Event的資訊。

InitializeEvent即是一個“注入器”。現在我們已經完成了注入器

然後在wire.go目錄下執行wire工具。

安裝 ：

go get github.com/google/wire/cmd/wire

Wire將找到InitializeEvent注入器並生成一個函式，其主體由所有必要的初始化步驟填充。結果將被寫入名為wire_gen.go的檔案。

// wire_gen.go

func InitializeEvent() Event {
    message := NewMessage()
    greeter := NewGreeter(message)
    event := NewEvent(greeter)
    return event
}

這看上去就像我們上面手工寫的程式碼，想象一下，對於複雜得多的元件，Wire是多麼有用。

kratos中的wire

最後回來看看kratos中的wire.go

// +build wireinject
// The build tag makes sure the stub is not built in the final build.

package di

import (
    pb "demo/api"
    "demo/internal/dao"
    "demo/internal/server/grpc"
    "demo/internal/server/http"
    "demo/internal/service"

    "github.com/google/wire"
)

var daoProvider = wire.NewSet(dao.New, dao.NewDB, dao.NewRedis, dao.NewMC)
var serviceProvider = wire.NewSet(service.New, wire.Bind(new(pb.DemoServer), new(*service.Service)))

func InitApp() (*App, func(), error) {
    panic(wire.Build(daoProvider, serviceProvider, http.New, grpc.New, NewApp))
}

可以看到kratos用到了wire的一些其它介面：wire.NewSet,wire.Bind，簡單看看。

wire.NewSet

Wire有兩個核心概念:Providers和injectors。

Providers

Wire中的主要機制是Providers:一個可以生成值的函式。這些函式都是普通的Go程式碼。

Providers 可以分組為provider sets，通過wire.NewSet函式可以新增一組providers到一個新的集合中。

var daoProvider = wire.NewSet(dao.New, dao.NewDB, dao.NewRedis, dao.NewMC)

當然也可以新增一個provider sets進一個provider sets

var MegaSet = wire.NewSet(daoProvider, pkg.OtherSet)

injector(注入器)

一個應用程式用injector連線這些providers: 一個按依賴順序呼叫providers的函式，即使用Wire，編寫注入器的簽名，然後Wire生成函式的主體。

呼叫wire.Build的函式則是來宣告注入器的，返回值不重要，只要型別正確即可。

func InitApp() (*App, func(), error) {
    panic(wire.Build(daoProvider, serviceProvider, http.New, grpc.New, NewApp))
}

Binding Interfaces

最後看看 wire.Bind 用來繫結介面的具體型別。

var serviceProvider = wire.NewSet(service.New, wire.Bind(new(pb.DemoServer), new(*service.Service)))

wire.Bind第一個引數 為指向所需介面型別的指標，第二個引數為 指向實現該介面型別的指標，

可以看到如果不加wire.Bind(new(pb.DemoServer), new(*service.Service))， 可以看到會找不到依賴。

相關推薦