Golang依賴注入工具digo的使用詳解
digo工具地址:https://github.com/werbenhu/digo
特性
- 使用注釋中的注解
- 自動代碼生成
- 自動檢測循環(huán)依賴
- 編譯時期依賴注入
- 自動初始化
- 支持實例組的管理
快速開始
更多示例請參考:examples
編寫代碼和注解
package main import ( "log" "github.com/werbenhu/digo" ) // @provider({"id":"main.db.url"}) func NewDbUrl() string { return "localhost:3306" } type Db struct { url string } // @provider({"id":"main.db"}) // @inject({"param":"url", "id":"main.db.url"}) func NewDb(url string) *Db { return &Db{ url: url, } } type App struct { Db *Db } // @provider({"id":"main.app"}) // @inject({"param":"db", "id":"main.db"}) func NewApp(db *Db) *App { return &App{ Db: db, } } func (a *App) Start() { log.Printf("app strat, db:%s\n", a.Db.url) } func main() { app, err := digo.Provide("main.app") if err == nil { app.(*App).Start() } }
安裝digogen工具
go install github.com/werbenhu/digo/digogen@v1.0.0
生成依賴注入代碼
打開命令行執(zhí)行下面命令,digogen
將會根據(jù)注解自動生成digo.generated.go
源碼文件.
digogen
運行代碼
go run .\digo.generated.go .\main.go
注解詳情
@provider
@provider注解表示是一個實例提供者,該實例是一個單例
示例
// @provider({"id":"main.db"})
支持的參數(shù):
參數(shù) | 類型 | 是否必需 | 說明 |
---|---|---|---|
id | string | 是 | 實例的id |
如果獲取實例,通過digo.Provide(providerId)
可以獲取到某一個provider的實例
app, err := digo.Provide("main.app") if err == nil { app.(*App).Start() }
@inject
@inject注解表示注入一個實例到某個參數(shù), @inject注解必須和@provider或者@group二者中的一個同時存在.
示例
// @inject({"param":"db", "id":"main.db"})
支持的參數(shù):
參數(shù) | 類型 | 是否必需 | 說明 |
---|---|---|---|
param | string | 是 | 指明哪個參數(shù)需要注入實例 |
id | string | 是 | 指明需要注入的實例id |
pkg | string | 否 | 該參數(shù)需要引入特定的包 |
pkg在什么時候需要使用,比如我們需要引入一個包 github.com/xxx/tool/v1
, 我們使用包名的時候是這樣使用的 *tool.Struct, 而不是 *v1.Struct,那我們需要顯示指明需要導(dǎo)入github.com/xxx/tool/v1
包
// @inject({"param":"tool", "id":"main.tool", "pkg":"github.com/xxx/tool/v1"})
@group
@group注解表示將實例注冊到一個組
示例
// @group({"id":"main.controllers"})
支持的參數(shù):
參數(shù) | 類型 | 是否必需 | 說明 |
---|---|---|---|
id | string | 是 | 組的id |
如果獲取組的所有實例,通過digo.Members(groupId)
可以獲取到組的所有實例
ctrls, err := digo.Members("main.controllers") if err == nil { for _, controller := range ctrls { // TODO: } }
到此這篇關(guān)于Golang依賴注入工具digo的使用詳解的文章就介紹到這了,更多相關(guān)Golang依賴注入內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!