依賴註入 與 Wire 的使用

来源:https://www.cnblogs.com/gui-lin/p/18066085
-Advertisement-
Play Games

寫在前面 在Java日常開發過程中，實現Excel文件的導入導出功能是一項常見的需求。 通過使用相關的Java庫，如Apache POI、EasyPoi或EasyExcel，可以輕鬆地實現Excel文件的讀寫操作。 而這篇文章將介紹如何在Java中使用Apache POI、EasyPoi 和Easy ...


控制反轉和依賴註入

控制反轉（Inversion of Control，縮寫為IoC），是面向對象編程中的一種設計原則，可以用來減低電腦代碼之間的耦合度。其中最常見的方式叫做依賴註入（Dependency Injection，簡稱DI）。依賴註入是生成靈活和鬆散耦合代碼的標準技術，通過明確地向組件提供它們所需要的所有依賴關係。在 Go 中通常採用將依賴項作為參數傳遞給構造函數的形式：

構造函數NewBookRepo在創建BookRepo時需要從外部將依賴項db作為參數傳入，我們在NewBookRepo中無需關註db的創建邏輯，實現了代碼解耦。

// NewBookRepo 創建BookRepo的構造函數
func NewBookRepo(db *gorm.DB) *BookRepo {
	return &BookRepo{db: db}
}

區別於控制反轉，如果在NewBookRepo函數中自行創建相關依賴，這將導致代碼高度耦合併且難以維護和調試。

// NewBookRepo 創建BookRepo的構造函數
func NewBookRepo() *BookRepo {
  db, _ := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{})
	return &BookRepo{db: db}
}

為什麼需要依賴註入工具

現在我們已經知道了應該在開發中儘可能地使用控制反轉和依賴註入將程式解耦開來，從而寫出靈活和易測試的程式。

在小型應用程式中，我們可以自行創建依賴並手動註入。但是在一個大型應用程式中，手動去實現所有依賴的創建和註入就會比較繁瑣。

例如，在一些常見的HTTP服務中，會根據業務需要劃分出不同的代碼層：

├── internal
│   ├── conf
│   │   └── conf.go
│   ├── data
│   │   └── data.go
│   ├── server
│   │   └── server.go
│   └── service
│       └── service.go
└── main.go

我們的服務需要有一個配置，指定工作模式、連接的資料庫和監聽埠等信息。

// conf/conf.go

// NewDefaultConfig 返回預設配置，不需要依賴
func NewDefaultConfig() *Config {...}

我們這裡定義了一個預設配置，當然後續可以支持從配置文件或環境變數讀取配置信息。

在程式的data層，需要定義一個連接資料庫的函數，它依賴上面定義的Config並返回一個*gorm.DB（這裡使用gorm連接資料庫）。

// data/data.go

// NewDB 返回資料庫連接對象
func NewDB(cfg *conf.Config) (*gorm.DB, error) {...}

同時定義一個BookRepo，它有一些數據操作相關的方法。它的構造函數NewBookRepo依賴*gorm.DB，並返回一個*BookRepo。

// data/data.go

type BookRepo struct {
	db *gorm.DB
}

func NewBookRepo(db *gorm.DB) *BookRepo {...}

Service層位於data層和Server層的中間，它負責實現對外服務。其中構造函數 NewBookService 依賴Config和BookRepo。

// service/service.go

type BookService struct {
	config *conf.Config
	repo   *data.BookRepo
}

func NewBookService(cfg *conf.Config, repo *data.BookRepo) *BookService {...}

server層又有一個NewServer構造函數，它依賴外部傳入Config和BookService。

// server/server.go

type Server struct {
	config  *conf.Config
	service *service.BookService
}

func NewServer(cfg *conf.Config, srv *service.BookService) *Server {...}

在main.go文件中又依賴Server創建一個app。

// main.go

type Server interface {
	Run()
}

type App struct {
	server Server
}

func newApp(server Server) *App {...}

由於在程式中定義了大量需要依賴註入的構造函數，程式的main函數中會出現以下情形。所有依賴的創建和順序都需要手動維護。

// main.go

func main() {
	cfg := conf.NewDefaultConfig()
	db, _ := data.NewDB(cfg)
	repo := data.NewBookRepo(db)
	bookSrv := service.NewBookService(cfg, repo)
	server := server.NewServer(cfg, bookSrv)
	app := newApp(server)

	app.Run()
}

我們確實需要一個工具來解決這類問題。

Wire

Wire 是一個專為依賴註入（Dependency Injection）設計的代碼生成工具，它可以自動生成用於初始化各種依賴關係的代碼，從而幫助我們更輕鬆地管理和註入依賴關係。

Wire 安裝

我們可以執行以下命令來安裝 Wire 工具：

$ go install github.com/google/wire/cmd/wire@latest

安裝之前請確保已將 $GOPATH/bin 添加到環境變數 $PATH 里。

Wire 的基本使用

前置代碼準備

雖然我們在前面已經通過 go install 命令安裝了 Wire 命令行工具，但在具體項目中，我們仍然需要通過以下命令安裝項目所需的 Wire 依賴，以便結合 Wire 工具生成代碼：

$ go get github.com/google/wire@latest

接下來，讓我們模擬一個簡單的 web 博客項目，編寫查詢文章介面的相關代碼，並使用 Wire 工具生成代碼。

項目的目錄結構如下：

.
├── ioc
│   └── article.go
├── main.go
├── service
│   └── article.go
├── web
│   └── article.go
└── wire.go

首先，我們先定義相關類型與方法，並提供對應的 初始化函數：

  • 定義 PostHandler 結構體，創建註冊路由的方法 RegisterRoutes 和查詢文章路由處理的方法 GetPostById 以及初始化的函數 NewPostHandler，並且它依賴於 IPostService 介面：
type PostHandler struct {
	serv service.IPostService
}

func (h *PostHandler) RegisterRoutes(engine *gin.Engine) {
	engine.GET("/post/:id", h.GetPostById)
}

func (h *PostHandler) GetPostById(ctx *gin.Context) {
	content := h.serv.GetPostById(ctx, ctx.Param("id"))
	ctx.String(http.StatusOK, content)
}

func NewPostHandler(serv service.IPostService) *PostHandler {
	return &PostHandler{serv: serv}
}
  • 定義 IPostService 介面，並提供了一個具體實現 PostService，接著創建 GetPostById 方法，用於處理查詢文章的邏輯，然後提供初始化函數 NewPostService，該函數返回 IPostService 介面類型：
type IPostService interface {
	GetPostById(ctx context.Context, id string) string
}

var _ IPostService = (*PostService)(nil)

type PostService struct {
}

func (s *PostService) GetPostById(ctx context.Context, id string) string {
	return "歡迎訪問博客"
}

func NewPostService() IPostService {
	return &PostService{}
}
  • 定義一個初始化 gin.Engine 函數 NewGinEngineAndRegisterRoute，該函數依賴於 *handler.PostHandler 類型，函數內部調用相關 handler 結構體的方法創建路由：
func NewGinEngineAndRegisterRoute(postHandler *web.PostHandler) *gin.Engine {
    engine := gin.Default()
    postHandler.RegisterRoutes(engine)
    return engine
}

使用 Wire 工具生成代碼

前置代碼已經準備好了，接下來我們編寫核心代碼，以便 Wire 工具能生成相應的依賴註入代碼。

  • 首先我們需要創建一個 wire 的配置文件，通常命名為 wire.go。在這個文件里，我們需要定義一個或者多個註入器函數（Injector 函數，接下來的內容會對其進行解釋），以便指引 Wire 工具生成代碼。
func InitializeApp() *gin.Engine {
    wire.Build(
        web.NewPostHandler,
        service.NewPostService,
        ioc.NewGinEngineAndRegisterRoute,
    )

    return &gin.Engine{}
}

在上述代碼中，我們定義了一個用於初始化 gin.Engine 的註入器函數，在該函數內部，我們使用了 wire.Build 方法來聲明依賴關係，其中包括 PostHandler、PostService 和 InitGinEngine 作為依賴的構造函數。

wire.Build 的作用是 連接或綁定我們之前定義的所有初始化函數。當我們運行 wire 工具來生成代碼時，它就會根據這些依賴關係來自動創建和註入所需的實例。

註意：文件首行必須加上 //go:build wireinject 或 // +build wireinject(go 1.18 之前的版本使用) 註釋，作用是只有在使用 wire 工具時才會編譯這部分代碼，其他情況下忽略。

  • 接下來在 wire.go 文件所處目錄下執行 wire 命令，生成 wire_gen.go 文件，內容如下所示：
// Code generated by Wire. DO NOT EDIT.

//go:generate go run github.com/google/wire/cmd/wire
//go:build !wireinject
// +build !wireinject

package main

import (
	"github.com/gin-gonic/gin"
	"golang-example/wire/blog/ioc"
	"golang-example/wire/blog/service"
	"golang-example/wire/blog/web"
)

// Injectors from wire.go:

func InitializeApp() *gin.Engine {
	iPostService := service.NewPostService()
	postHandler := web.NewPostHandler(iPostService)
	engine := ioc.NewGinEngineAndRegisterRoute(postHandler)
	return engine
}

生成的代碼和我們手寫區別不大，當我們的組件很多，依賴關係複雜的時候，我們才會感覺到 Wire 工具的好處。

Wire 的核心概念

Wire 有兩個核心概念：提供者（providers）和註入器（injectors）。

Wire 提供者（providers）

提供者：一個可以產生值的函數，也就是有返回值的函數。例如入門代碼里的 NewPostHandler 函數：

func NewPostHandler(serv service.IPostService) *PostHandler {  
	return &PostHandler{serv: serv}  
}

返回值不僅限於一個，如果有需要的話，可以額外添加一個 error 的返回值。

如果提供者過多的時候，我們還可以以分組的形式進行連接，例如將 post 相關的 handler 和 service 進行組合：

package web  
  
var PostSet = wire.NewSet(NewPostHandler, service.NewPostService)

使用 wire.NewSet 函數將提供者進行分組，該函數返回一個 ProviderSet 結構體。不僅如此，wire.NewSet 還能對多個 ProviderSet 進行分組 wire.NewSet(PostSet, XxxSet) 。

對於之前的 InitializeApp 函數，我們可以這樣升級：

func InitializeAppV2() *gin.Engine {  
	wire.Build(  
		web.PostSet,  
		ioc.NewGinEngineAndRegisterRoute,  
	)  
	return &gin.Engine{}  
}

然後通過 Wire 命令生成代碼，和之前的結果一致。

Wire 註入器（injectors）

註入器（injectors）的作用是將所有的提供者（providers）連接起來，回顧一下我們之前的代碼：

func InitializeApp() *gin.Engine {  
	wire.Build(  
		web.NewPostHandler,  
		service.NewPostService,  
		ioc.NewGinEngineAndRegisterRoute,  
	)  
	return &gin.Engine{}  
}

InitializeApp 函數就是一個註入器，函數內部通過 wire.Build 函數連接所有的提供者，然後返回 &gin.Engine{}，該返回值實際上並沒有使用到，只是為了滿足編譯器的要求，避免報錯而已，真正的返回值來自 ioc.NewGinEngineAndRegisterRoute。

Wire 高級應用

綁定介面

回顧我們之前編寫的代碼：

package web

···

func NewPostHandler(serv service.IPostService) *PostHandler {
    return &PostHandler{serv: serv}
}

···

pakacge service

···

func NewPostService() IPostService {
    return &PostService{}
}

···

NewPostHandler 函數依賴於 service.IPostService 介面，NewPostService 函數返回的是 IPostService 介面的值，這兩個地方的類型匹配，因此 Wire 工具能夠正確識別並生成代碼。然而，這並不是推薦的最佳實踐。因為在 Go 中的 最佳實踐 是返回 具體的類型 的值，所以最好讓 NewPostService 返回具體類型 PostService 的值：

func NewPostService() *PostService {  
	return &PostService{}  
}

但是這樣，Wire 工具將認為 IPostService 介面類型與 PostService 類型不匹配，導致生成代碼失敗。因此我們需要修改註入器的代碼：

func InitializeApp() *gin.Engine {  
	wire.Build(  
		web.NewPostHandler,  
		service.NewPostService,  
		ioc.NewGinEngineAndRegisterRoute,  
		wire.Bind(new(service.IPostService), new(*service.PostService)),  
	)  
	return &gin.Engine{}  
}

使用 wire.Bind 來建立介面類型和具體的實現類型之間的綁定關係，這樣 Wire 工具就可以根據這個綁定關係進行類型匹配並生成代碼。

wire.Bind 函數的第一個參數是指向所需介面類型值的指針，第二個實參是指向實現該介面的類型值的指針。

結構體提供者（Struct Providers）

Wire 庫有一個函數是 wire.Struct，它能根據現有的類型進行構造結構體，我們來看看下麵的例子：

package main

type Name string

func NewName() Name {
    return"Jack"
}

type PublicAccount string

func NewPublicAccount() PublicAccount {
    return"Hello World"
}

type User struct {
    MyName          Name
    MyPublicAccount PublicAccount
}

func InitializeUser() *User {
    wire.Build(
       NewName,
       NewPublicAccount,
       wire.Struct(new(User), "MyName", "MyPublicAccount"),
    )
    return &User{}
}

上述代碼中，首先定義了自定義類型 Name 和 PublicAccount 以及結構體類型 User，並分別提供了 Name 和 PublicAccount 的初始化函數（providers）。然後定義一個註入器（injectors）InitializeUser，用於構造連接提供者並構造 *User 實例。

使用 wire.Struct 函數需要傳遞兩個參數，第一個參數是結構體類型的指針值，另一個參數是一個可變參數，表示需要註入的結構體欄位的名稱集。

根據上述代碼，使用 Wire 工具生成的代碼如下所示：

func InitializeUser() *User {
    name := NewName()
    publicAccount := NewPublicAccount()
    user := &User{
       MyName:          name,
       MyPublicAccount: publicAccount,
    }
    return user
}

如果我們不想返回指針類型，只需要修改 InitializeUser 函數的返回值為非指針即可。

綁定值

有時候，我們可以在註入器中通過 值表達式 給一個類型進行賦值，而不是依賴提供者（providers）。

func InjectUser() User {  
	wire.Build(wire.Value(User{MyName: "Jack"}))  
	return User{}  
}

在上述代碼中，使用 wire.Value 函數通過表達式直接指定 MyName 的值，生成的代碼如下所示：

func InjectUser() User {
    user := _wireUserValue
    return user
}

var (
    _wireUserValue = User{MyName: "Jack"}
)

需要註意的是，值表達式將被覆制到生成的代碼文件中。

對於介面類型，可以使用 InterfaceValue：

func InjectPostService() service.IPostService {
    wire.Build(wire.InterfaceValue(new(service.IPostService), &service.PostService{}))
    return nil
}

使用結構體欄位作為提供者（providers）

有些時候，你可以使用結構體的某個欄位作為提供者，從而生成一個類似 GetXXX 的函數。

func GetUserName() Name {
    wire.Build(
       NewUser,
       wire.FieldsOf(new(User), "MyName"),
    )
    return ""
}

你可以使用 wire.FieldsOf 函數添加任意欄位，生成的代碼如下所示：

func GetUserName() Name {
    user := NewUser()
    name := user.MyName
    return name
}

func NewUser() User {
    return User{MyName: Name("Jack"), MyPublicAccount: PublicAccount("HelloWorld")}
}

清理函數

如果一個提供者創建了一個需要清理的值（例如關閉一個文件），那麼它可以返回一個閉包來清理資源。註入器會用它來給調用者返回一個聚合的清理函數，或者在註入器實現中稍後調用的提供商返回錯誤時清理資源。

並且 Wire 對 Provider 的返回值個數及順序有以下限制：

  • 第一個返回值是需要生成的對象
  • 如果有 2 個返回值，第二個返回值必須是 func() 或 error
  • 如果有 3 個返回值，第二個返回值必須是 func()，而第三個返回值必須是
// db.go
func InitGormDB()(*gorm.DB, func(), error) {
    // 初始化db鏈接
    // ...
    cleanFunc := func(){
        db.Close()
    }

    return db, cleanFunc, nil
}

// wire.go
func BuildInjector() (*Injector, func(), error) {
   wire.Build(
      common.InitGormDB,
      // ...
      NewInjector
   )

   return new(Injector), nil, nil
}

// 生成的wire_gen.go
func BuildInjector() (*Injector, func(), error) {
   db, cleanup, err := common.InitGormDB()
   // ...
   return injector, func(){
       // 所有provider的清理函數都會在這裡
       cleanup()
   }, nil
}

// main.go
injector, cleanFunc, err := app.BuildInjector()
defer cleanFunc()

備用註入器語法

如果你不喜歡將類似這種寫法 → return &gin.Engine{} 放在你的註入器函數聲明的末尾，你可以用 panic 來更簡潔地寫它:

func InitializeGin() *gin.Engine {  
	panic(wire.Build(/* ... */))  
}

總結

在本文中，我們詳細探討了 Go Wire 工具的基本用法和高級特性。它是一個專為依賴註入設計的代碼生成工具，它不僅提供了基礎的依賴解析和代碼生成功能，還支持多種高級用法，如介面綁定和構造結構體。

依賴註入的設計模式應用非常廣泛，Wire 工具讓依賴註入在 Go 語言中變得更簡單。

本文的所有代碼在這裡。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java基礎知識篇——Java基本介紹
    一、什麼是 Java Java 是 Sun Microsystems 於 1995 年首次發佈的一種編程語言和計算平臺。編程語言還是比較好理解的，什麼是計算平臺呢？ 計算平臺是電腦中運行應用程式（軟體的環境），包括硬體環境和軟體環境。一般系統平臺包括一臺電腦的硬體體繫結構，操作系統、運行時庫。 Ja ...
  • Python 初學者容易踩的 5 個坑
    哈嘍大家好，我是鹹魚。 今天鹹魚列出了一些大家在初學 Python 的時候容易踩的一些坑，看看你有沒有中招過。 原文：https://www.bitecode.dev/p/unexpected-python-traps-for-beginners 不明顯的字元串拼接 Python 在詞法分析的時候會 ...
  • 【Python使用】python高級進階知識md總結第3篇：靜態Web伺服器-返回指定頁面數據,靜態Web伺服器-多任務版【附代碼文檔】
    InLine_Function How to Write it? example-> inline void func(); inline int sum(int v1 , int v2 ); inline void func(){ std::cout<<"func()"<<std::endl; } ...
  • 一文學會JDBC實現java和mySQL的數據連接(尚矽谷學習課程代碼+筆記+思路總結)
    JDBC是指資料庫連接技術，用於java連接mySQL等資料庫。本文詳細介紹了尚矽谷課程中JDBC的學習內容和補充知識。 概述 java語言只提供規範介面，存在於java.sql.javax.sql包下，然後資料庫軟體根據java提供的規範實現具體的驅動代碼（jar) jar包是java程式打成的一 ...
  • 【主流技術】日常工作中關於 JSON 轉換的經驗大全（Java）
    不知道大家在 Java 日常開發中是否會經常遇到關於 JSON 的各種轉換的場景，我把自己日常工作中遇到的 JSON轉換場景做了一個總結，希望可以對大家有幫助。 註：本文都是基於阿裡的 fastjson 來講解操作的。 ...
  • Redis 故障轉移、高可用方案，都在這了！
    Redis大家都不陌生，就算是沒用過，也都聽說過了。 作為最廣泛使用的KV記憶體資料庫之一，在當今的大流量時代，單機模式略顯單薄，免不了要有一些拓展的方案。 筆者下文會對各種方案進行介紹，並且給出場景，實現 等等概述，還會提到一些新手常見的誤區。 正文 先從基礎的拓展方式開始，這樣更便於理解較高級的模 ...
  • 我為什麼使用Linux做開發
    系統選擇 目前市面上主流的桌面操作系統在大多數人眼裡只有Windows和MacOS，那為什麼我沒選擇它們兩呢？ 首先，不選MacOS的原因，就是太貴。當然這是我的原因不是蘋果的原因，我最早使用Linux寫代碼的時候是2018年，那時候剛畢業上班不久，根本買不起Mac（雖然現在也覺得有點貴）。 在沒有 ...
  • 雲計算 - 內容分髮網絡CDN技術與應用全解
    在這篇全面解析CDN的技術文章中，我們深入探討了CDN的基礎概念、核心架構、多樣化產品和在不同行業中的應用案例。文章揭示了CDN技術如何優化內容分發，提升用戶體驗，並展望了CDN面臨的挑戰和未來發展趨勢。 關註【TechLeadCloud】，分享互聯網架構、雲服務技術的全維度知識。作者擁有10+年互 ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類