當前位置：首頁 > 科技 > 軟件

Wire：Go語言依賴注入的利器

來源：責編：時間：2024-05-27 08:56:58 212觀看

導讀一、介紹依賴注入可以幫助我們更好地管理代碼之間的依賴關系，從而提高代碼的可維護性、可測試性和可擴展性。但是，手動管理依賴關系往往會導致代碼復雜和冗余，為了解決這個問題，本文我們要介紹的是一款名為 Wire[1] 的依

一、介紹

依賴注入可以幫助我們更好地管理代碼之間的依賴關系，從而提高代碼的可維護性、可測試性和可擴展性。

但是，手動管理依賴關系往往會導致代碼復雜和冗余，為了解決這個問題，本文我們要介紹的是一款名為 Wire^[1] 的依賴注入框。

Wire 是一個靜態類型檢查的依賴注入框架，能夠在編譯時檢測到依賴關系中的錯誤，并提供相應的錯誤提示。這有助于減少錯誤并提高代碼的質量和健壯性

二、提供者（Providers）和注入者（Injectors）

使用 Wire 進行依賴注入時，通常可以將參與注入的組件分為兩類：提供者（Providers）和注入者（Injectors）。

提供者（Providers）：提供者是負責創建和提供依賴項實例的函數或方法。它們通常是構造函數或工廠函數，用于創建特定類型的實例。在 Wire 中，提供者函數應該返回需要創建的實例，并且可以有任意數量的輸入參數，這些參數通常表示依賴項。例如，假設我們有一個NewDatabase()函數，用于創建數據庫連接實例。這個函數就是一個提供者，因為它提供了數據庫連接實例。
注入者（Injectors）：注入者是依賴于提供者所提供的依賴項的組件。它們通常是結構體或方法，需要依賴于其他類型的實例來完成其任務。在 Wire 中，我們將依賴注入到注入者中，使其能夠訪問所需的依賴項實例。例如，假設我們有一個UserService結構體，它需要依賴于數據庫連接實例來執行數據庫操作。在這種情況下，UserService就是一個注入者，因為它依賴于提供者所提供的數據庫連接實例。

在 Wire 中，我們可以通過定義提供者函數和注入者結構體來管理依賴項，并使用 wire.Build() 方法來自動解析和注入依賴關系。提供者負責創建依賴項的實例，而注入者則接受這些實例并使用它們來完成其任務，從而實現了松耦合和可測試性。

三、Wire 的基本使用方式

使用 Go 語言的 Wire 庫可以幫助您在依賴注入時自動解決依賴關系。

下面是一個簡單的示例，演示了如何在 Go 項目中使用 Wire。

安裝 Wire 庫：

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

一個簡單的 Go 應用程序

假設我們有一個簡單的 Go 應用程序，其中包含一些服務和它們的依賴關系。

示例代碼：

// services.gopackage servicestype Database interface {    Query() string}type MySQLDatabase struct{}func (db *MySQLDatabase) Query() string {    return "Executing MySQL query"}type Service struct {    DB Database}func (s *Service) DoSomething() string {    return s.DB.Query()}

使用 Wire 來定義依賴注入的配置

示例代碼：

// wire.go// +build wireinjectpackage servicesimport "github.com/google/wire"func InitializeService() (*Service, error) {    wire.Build(NewService, NewMySQLDatabase)    return nil, nil}func NewService(db Database) *Service {    return &Service{        DB: db,    }}func NewMySQLDatabase() *MySQLDatabase {    return &MySQLDatabase{}}

在 wire.Build() 方法中，函數的參數順序是有一定要求的，但并不是嚴格要求的。參數的順序應該遵循依賴關系的順序，即依賴關系被使用的順序。

在 wire.Build() 方法中，我們可以列出所有的函數，Wire 將會按照它們的依賴關系進行排序和解析。當然，Wire 有能力理解依賴關系并確保它們以正確的順序進行構建，所以我們并不需要擔心過多。

但是，如果代碼中存在循環依賴關系，那么參數的順序就會變得重要。在這種情況下，我們需要確保在 wire.Build() 方法中，被循環依賴關系影響的函數出現在后面的位置，這樣 Wire 才能正確地解析依賴關系。

雖然參數的順序有一定要求，但在大多數情況下，Wire 能夠自動解決依賴關系，因此我們不必過于擔心參數的順序問題。

使用 Wire 來自動生成依賴注入的代碼

wire

運行以上命令將生成 wire_gen.go 文件，其中包含自動生成的代碼。然后，我們可以在應用程序中使用 InitializeService 函數來初始化服務。

這只是一個簡單的示例，我們可以根據需求定義更多的服務和依賴關系，并使用 Wire 來自動生成依賴注入的代碼。

四、代碼詳解

首先，我們解釋 wire.go 文件的代碼。

// +build wireinjectpackage services

當我們創建一個名為wire.go的文件時，它的用途是告訴 Wire 庫如何進行依賴注入。

+build wireinject：這是一個特殊的構建標記（build tag），它告訴 Go 編譯器，當使用 Wire 工具自動生成依賴注入代碼時，應該包括這個文件。這樣可以防止在實際編譯應用程序時將這個文件包含進去。

import "github.com/google/wire"

導入 Wire 庫，以便在InitializeService函數中使用 Wire 的構建功能。

func InitializeService() (*Service, error) {    wire.Build(NewService, NewMySQLDatabase)    return nil, nil}

InitializeService 函數是 Wire 的入口。當我們運行 Wire 命令行工具時，它將檢測到這個函數，并使用它來生成依賴注入的代碼。該函數返回 *Service 和 error，但實際上由于我們在這個示例中沒有任何錯誤檢查，所以總是返回 nil。

wire.Build函數是 Wire 的核心。它接受一系列函數作為參數，這些函數定義了依賴關系的創建方式。在這個例子中，我們傳遞了 NewService 和 NewMySQLDatabase 函數，它們定義了如何創建 Service 和 MySQLDatabase 類型的實例。

func NewService(db Database) *Service {    return &Service{        DB: db,    }}

NewService 函數用于創建 Service 類型的實例。它接受一個 Database 類型的參數，并返回一個指向 Service 實例的指針。在依賴注入過程中，Wire 將負責提供適當類型的 Database 實例作為參數。

func NewMySQLDatabase() *MySQLDatabase {    return &MySQLDatabase{}}

NewMySQLDatabase 函數用于創建 MySQLDatabase 類型的實例。它簡單地返回一個指向 MySQLDatabase 實例的指針。在實際應用中，可能會包含更多的邏輯，例如設置數據庫連接等。

通過將這些組件組合在一起，wire.go 文件提供了一個入口，使得 Wire 可以了解應該如何創建我們的應用程序的依賴關系。然后，當我們運行 Wire 命令行工具時，它將自動生成相應的依賴注入代碼。

接下來，我們解釋 wire_gen.go 文件的代碼。

wire_gen.go 文件是由 Wire 工具生成的，其中包含了根據 wire.go 文件中的指令所生成的依賴注入代碼。

// Code generated by Wire. DO NOT EDIT.// This file was generated by the "wire" tool (github.com/google/wire).// Source: wire.go// Package services provides a wire injector for Service.package services

這段注釋指出該文件是由 Wire 工具生成的，不應手動編輯。它還指出了源文件的位置（wire.go）以及生成這個文件的工具（Wire）。

func InitializeService() (*Service, error) {    db := NewMySQLDatabase()    s := NewService(db)    return s, nil}

InitializeService 函數是由 Wire 根據 wire.go 文件中的指令自動生成的。它是我們在 wire.go 中定義的 InitializeService 函數的具體實現。在這里，它簡單地創建了一個 MySQLDatabase 實例，并將其傳遞給 NewService 函數來創建一個 Service 實例。

func NewService(db Database) *Service {    return &Service{        DB: db,    }}

NewService 函數是我們在 wire.go 中定義的 NewService 函數的具體實現。它接受一個 Database 類型的參數，并返回一個指向 Service 實例的指針。在這里，它簡單地將傳入的 Database 實例分配給 Service 結構體的 DB 字段。

func NewMySQLDatabase() *MySQLDatabase {    return &MySQLDatabase{}}

NewMySQLDatabase 函數是我們在 wire.go 中定義的 NewMySQLDatabase 函數的具體實現。它返回一個指向 MySQLDatabase 實例的指針。在這里，它簡單地創建并返回一個新的 MySQLDatabase 實例。

這些代碼都是由 Wire 根據 wire.go 文件中的指令自動生成的，它們定義了如何創建服務的實例以及如何解析它們之間的依賴關系。因此，wire_gen.go 文件提供了一個完整的、可編譯的依賴注入方案，無需手動編寫或管理依賴關系的創建代碼。

五、Wire 的高級特性

除了基本的依賴注入功能外，Wire 還具有一些高級特性，使其成為一個功能強大的依賴注入框架。以下是 Wire 的一些高級特性：

Provider Sets：Provider Sets 允許我們將一組相關的提供者函數組合成一個集合，并在需要時一次性注入到注入者中。這使得依賴注入的配置更加簡潔和可組織，并且可以幫助提高代碼的可讀性和可維護性。
Set Functions：Set Functions 是一種用于將提供者函數組織成可重用的集合的方式。它們類似于 Provider Sets，但提供了更靈活的組織和使用方式。我們可以使用Set函數定義一組提供者函數，并將這些集合傳遞給 wire.Build() 方法，以便 Wire 可以識別和解析其中包含的提供者函數。
Interface Binding：Wire 支持將接口綁定到實現類型。這意味著您可以定義接口和實現類型，并將它們綁定在一起，從而使得在需要接口類型的實例時，Wire 能夠自動為我們提供正確的實現類型。這樣可以提高代碼的靈活性和可測試性。
Custom Wire Functions：我們可以編寫自定義 Wire 函數來執行特定的依賴注入邏輯。這使得我們可以根據我們的應用程序的需求來定制 Wire 的行為，并添加一些自定義的處理邏輯。例如，我們可以編寫一個自定義的 Wire 函數來處理特定類型的依賴項，或者執行一些額外的驗證和處理。
Provider Bindings：Provider Bindings 允許我們將提供者函數綁定到接口或結構體上。這樣，當我們需要某個接口類型的實例時，Wire 將自動為我們提供正確的提供者函數。這提高了代碼的靈活性，并使得依賴注入更加方便和易用。

這些高級特性使得 Wire 成為一個功能豐富且靈活的依賴注入框架，可以滿足不同類型的應用程序的需求，并幫助提高代碼的質量、可維護性和可測試性。

限于篇幅，我們介紹其中 2 個高級特性，Provider Sets 和 Set Functions。

Provider Sets ：我們把之前的示例改寫成使用 Provider Sets 的方式：

// wire.go// +build wireinjectpackage servicesimport "github.com/google/wire"http:// 定義 Provider Setvar ProviderSet = wire.NewSet(NewService, NewMySQLDatabase)// InitializeService 使用 Provider Set 創建服務實例func InitializeService() (*Service, error) { wire.Build(ProviderSet) return nil, nil}// NewService 是 Service 的提供者函數func NewService(db Database) *Service { return &Service{  DB: db, }}// NewMySQLDatabase 是 MySQLDatabase 的提供者函數func NewMySQLDatabase() *MySQLDatabase { return &MySQLDatabase{}}

在這個修改后的 wire.go 文件中，我們定義了一個 ProviderSet，其中包含了兩個提供者函數：NewService 和 NewMySQLDatabase。然后，在 InitializeService 函數中，我們使用 ProviderSet 來構建服務實例。這樣，我們可以更清晰地組織和管理提供者函數，并確保它們在依賴注入過程中被正確地使用。

使用 Provider Sets 的情況可以歸納如下：

組織提供者函數：如果我們有多個提供者函數，而它們之間有一定的相關性或邏輯關系，那么使用 Provider Sets 可以更好地組織這些提供者函數。Provider Sets 允許我們將相關的提供者函數組合成一個集合，使得代碼更具可讀性和可維護性。
復用提供者函數：如果我們的應用程序中存在一些通用的提供者函數，可以在多個地方進行復用，那么使用 Provider Sets 可以更方便地管理和使用這些提供者函數。通過將這些提供者函數放入 Provider Set 中，我們可以在需要時直接使用該集合，并且可以輕松地將其注入到不同的注入者中。
簡化依賴注入配置：對于復雜的依賴注入配置，使用 Provider Sets 可以幫助簡化配置過程。通過將一組相關的提供者函數組合成 Provider Set，并在需要時直接使用該集合，可以減少配置代碼的復雜性和重復性。
提高代碼的可測試性和可維護性：使用 Provider Sets 可以使代碼更具可測試性和可維護性。通過將提供者函數組織成 Provider Set，并將其作為一個整體注入到注入者中，可以更容易地進行單元測試和代碼重構，從而提高代碼的質量和可維護性。

當我們有多個相關的提供者函數需要管理和使用時，或者希望簡化復雜的依賴注入配置時，可以考慮使用 Provider Sets。它可以幫助我們更好地組織和管理提供者函數，從而提高代碼的可讀性、可維護性和可測試性。

Set Functions：

Set Functions 是 Wire 中的一種功能，用于組織提供者函數并創建可重用的集合。使用 Set Functions 可以將一組相關的提供者函數組合成一個集合，從而簡化依賴注入的配置和管理。讓我詳細解釋一下如何使用 Set Functions：

創建 Set Functions：首先，您需要創建一個 Set Functions，其中包含一組提供者函數。每個提供者函數都會返回一個實例，并且通常表示一種依賴項的創建方式。

package servicesimport "github.com/google/wire"http:// 定義一個 Set 函數，包含一組提供者函數var ServiceSet = wire.NewSet(NewService, NewDatabase)

在這個例子中，我們創建了一個名為 ServiceSet 的 Set Functions，其中包含了兩個提供者函數：NewService 和 NewDatabase。這些提供者函數用于創建 Service 和 Database 實例。

使用 Set Functions：然后，您可以在wire.Build()方法中使用這個 Set Functions，以便 Wire 可以識別和解析這些提供者函數。

package servicesimport "github.com/google/wire"http:// 使用Set函數來配置依賴注入func InitializeService() (*Service, error) {    wire.Build(ServiceSet)    return nil, nil}

在這個例子中，我們在 InitializeService 函數中使用了 ServiceSet 函數，以便 Wire 可以識別并解析其中包含的提供者函數。這樣，我們就可以在需要時直接使用這個集合，并且可以輕松地將其注入到不同的注入者中。

Set Functions 使得組織和管理提供者函數變得更加簡單和靈活，可以幫助我們更好地管理依賴注入的配置，提高代碼的可讀性和可維護性。

六、總結

Wire 是一個基于 Go 語言的依賴注入（DI）框架，它旨在簡化和自動化 Go 應用程序中的依賴項管理和注入過程。通過使用 Wire，我們可以更輕松地管理應用程序中的依賴關系，并將它們注入到相應的組件中，從而實現松耦合和更易于測試的代碼。

Wire 的主要特點和功能包括：

自動化依賴注入：Wire 可以自動解析和注入依賴關系，無需手動編寫繁瑣的依賴注入代碼。我們只需定義提供者函數和注入者結構體，Wire 將負責解析依賴關系并生成相應的注入代碼。
類型安全：Wire 是一個靜態類型檢查的依賴注入框架，它能夠在編譯時檢測到依賴關系中的錯誤，并提供相應的錯誤提示。這可以幫助我們在開發過程中及早發現和解決問題，提高代碼的健壯性和可維護性。
簡潔明了：Wire 的使用方式簡單明了，無需復雜的配置或學習曲線。我們只需在代碼中定義提供者函數和注入者結構體，然后使用 Wire 工具生成相應的依賴注入代碼即可。
靈活可擴展：Wire 提供了豐富的功能和選項，可以滿足不同類型應用程序的需求。我們可以使用 Provider Sets、Set Functions 等功能來組織和管理依賴關系，從而實現更靈活、可擴展的依賴注入方案。

Wire 是一個強大而簡單的依賴注入框架，它可以幫助我們更輕松地管理和注入依賴關系，從而提高代碼的質量、可維護性和可測試性。

參考資料：[1]Wire: https://github.com/google/wire

本文鏈接：http://m.www897cc.com/showinfo-26-90857-0.htmlWire：Go語言依賴注入的利器

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇： WinForm跨線程UI操作的救星：常用控件類一網打盡！

下一篇： Java Nio FileChannel堆內堆外數據讀寫全流程分析及使用

標簽：

熱門焦點

摸魚心法第一章——和配置文件說拜拜

為了能摸魚我們團隊做了容器化，但是帶來的問題是服務配置文件很麻煩，然后大家在群里進行了“親切友好”的溝通圖片圖片圖片圖片對比就對比，簡單對比下獨立配置中心和k8s作為配
2023 年的 Node.js 生態系統

隨著技術的不斷演進和創新，Node.js 在 2023 年達到了一個新的高度。Node.js 擁有一個龐大的生態系統，可以幫助開發人員更快地實現復雜的應用。本文就來看看 Node.js 最新的生
CSS單標簽實現轉轉logo

轉轉品牌升級后更新了全新的Logo，今天我們用純CSS來實現轉轉的新Logo，為了有一定的挑戰性，這里我們只使用一個標簽實現，將最大化的使用CSS能力完成Logo的繪制與動畫效果。新logo
之家push系統迭代之路

前言在這個信息爆炸的互聯網時代，能夠及時準確獲取信息是當今社會要解決的關鍵問題之一。隨著之家用戶體量和內容規模的不斷增大，傳統的靠"主動拉"獲取信息的方式已不能滿足用
一篇文章帶你了解 CSS 屬性選擇器

屬性選擇器對帶有指定屬性的 HTML 元素設置樣式。可以為擁有指定屬性的 HTML 元素設置樣式，而不僅限于 class 和 id 屬性。一、了解屬性選擇器CSS屬性選擇器提供了一種簡單而
華為Mate 60系列用上可變靈動島：正式版體驗將會更出色

這段時間以來，關于華為新旗艦的爆料日漸密集。據此前多方爆料，今年華為將開始恢復一年雙旗艦戰略，除上半年推出的P60系列外，往年下半年的Mate系列也將
華為Mate60系列模具曝光：采用碩大圓形后置相機模組+拼接配色方案

據此前多方爆料，今年華為將開始恢復一年雙旗艦戰略，除上半年推出的P60系列外，往年下半年的Mate系列也將迎來更新，有望在9-10月份帶來全新的華為Mate60
iQOO 11S新品發布會

iQOO將在7月4日19:00舉行新品發布會，推出杭州亞運會電競賽事官方用機iQOO 11S。
“買真退假” 這種“羊毛”不能薅

□ 法治日報記者王春　　□ 本報通訊員胡佳麗　　2020年初，還在上大學的小東加入了一個大學生兼職QQ群。群主“七王”在群里介紹一些刷單賺

日韩成人免费在线_国产成人一二_精品国产免费人成电影在线观..._日本一区二区三区久久久久久久久不

Wire：Go語言依賴注入的利器

一、介紹

二、提供者（Providers）和注入者（Injectors）

三、Wire 的基本使用方式

一個簡單的 Go 應用程序

使用 Wire 來定義依賴注入的配置

使用 Wire 來自動生成依賴注入的代碼

四、代碼詳解

五、Wire 的高級特性

六、總結

摸魚心法第一章——和配置文件說拜拜

2023 年的 Node.js 生態系統

CSS單標簽實現轉轉logo

之家push系統迭代之路

一篇文章帶你了解 CSS 屬性選擇器

華為Mate 60系列用上可變靈動島：正式版體驗將會更出色

華為Mate60系列模具曝光：采用碩大圓形后置相機模組+拼接配色方案

iQOO 11S新品發布會

“買真退假” 這種“羊毛”不能薅

最新推薦

猜你喜歡

熱門推薦

相關資訊