Wire：Go语言依赖注入的利器

frank.

发布于 2024-05-30 20:32:58

1120

发布于 2024-05-30 20:32:58

文章被收录于专栏：Golang语言开发栈Golang语言开发栈

大家好，我是 frank。欢迎大家点击标题下方蓝色文字「Golang 语言开发栈」关注公众号。公众号主页点击右上角三个点图标， 设为星标，第一时间接收推送文章。 文末扫码，加群一起学 Golang 语言。

01 、介绍

依赖注入可以帮助我们更好地管理代码之间的依赖关系，从而提高代码的可维护性、可测试性和可扩展性。

但是，手动管理依赖关系往往会导致代码复杂和冗余，为了解决这个问题，本文我们要介绍的是一款名为 Wire[1] 的依赖注入框。

Wire 是一个静态类型检查的依赖注入框架，能够在编译时检测到依赖关系中的错误，并提供相应的错误提示。这有助于减少错误并提高代码的质量和健壮性。

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

使用 Wire 进行依赖注入时，通常可以将参与注入的组件分为两类：提供者（Providers）和注入者（Injectors）。

提供者（Providers）： 提供者是负责创建和提供依赖项实例的函数或方法。它们通常是构造函数或工厂函数，用于创建特定类型的实例。在 Wire 中，提供者函数应该返回需要创建的实例，并且可以有任意数量的输入参数，这些参数通常表示依赖项。例如，假设我们有一个NewDatabase()函数，用于创建数据库连接实例。这个函数就是一个提供者，因为它提供了数据库连接实例。
注入者（Injectors）： 注入者是依赖于提供者所提供的依赖项的组件。它们通常是结构体或方法，需要依赖于其他类型的实例来完成其任务。在 Wire 中，我们将依赖注入到注入者中，使其能够访问所需的依赖项实例。例如，假设我们有一个UserService结构体，它需要依赖于数据库连接实例来执行数据库操作。在这种情况下，UserService就是一个注入者，因为它依赖于提供者所提供的数据库连接实例。

在 Wire 中，我们可以通过定义提供者函数和注入者结构体来管理依赖项，并使用 wire.Build() 方法来自动解析和注入依赖关系。提供者负责创建依赖项的实例，而注入者则接受这些实例并使用它们来完成其任务，从而实现了松耦合和可测试性。

03 、Wire 的基本使用方式

使用 Go 语言的 Wire 库可以帮助您在依赖注入时自动解决依赖关系。

下面是一个简单的示例，演示了如何在 Go 项目中使用 Wire。

安装 Wire 库：

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

一个简单的 Go 应用程序

假设我们有一个简单的 Go 应用程序，其中包含一些服务和它们的依赖关系。

示例代码：

// services.go
package services

type 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 wireinject

package services

import "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 来自动生成依赖注入的代码。

04、代码详解

首先，我们解释 wire.go 文件的代码。

// +build wireinject

package 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 文件提供了一个完整的、可编译的依赖注入方案，无需手动编写或管理依赖关系的创建代码。

05 、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 wireinject

package services

import "github.com/google/wire"

// 定义 Provider Set
var 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 services

import "github.com/google/wire"

// 定义一个 Set 函数，包含一组提供者函数
var ServiceSet = wire.NewSet(NewService, NewDatabase)

在这个例子中，我们创建了一个名为 ServiceSet 的 Set Functions，其中包含了两个提供者函数：NewService 和 NewDatabase。这些提供者函数用于创建 Service 和 Database 实例。

使用 Set Functions：

然后，您可以在 wire.Build() 方法中使用这个 Set Functions，以便 Wire 可以识别和解析这些提供者函数。

package services

import "github.com/google/wire"

// 使用Set函数来配置依赖注入
func InitializeService() (*Service, error) {
    wire.Build(ServiceSet)
    return nil, nil
}

在这个例子中，我们在 InitializeService 函数中使用了 ServiceSet 函数，以便 Wire 可以识别并解析其中包含的提供者函数。这样，我们就可以在需要时直接使用这个集合，并且可以轻松地将其注入到不同的注入者中。

Set Functions 使得组织和管理提供者函数变得更加简单和灵活，可以帮助我们更好地管理依赖注入的配置，提高代码的可读性和可维护性。

06 、总结

Wire 是一个基于 Go 语言的依赖注入（DI）框架，它旨在简化和自动化 Go 应用程序中的依赖项管理和注入过程。通过使用 Wire，我们可以更轻松地管理应用程序中的依赖关系，并将它们注入到相应的组件中，从而实现松耦合和更易于测试的代码。

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

自动化依赖注入：Wire 可以自动解析和注入依赖关系，无需手动编写繁琐的依赖注入代码。我们只需定义提供者函数和注入者结构体，Wire 将负责解析依赖关系并生成相应的注入代码。
类型安全：Wire 是一个静态类型检查的依赖注入框架，它能够在编译时检测到依赖关系中的错误，并提供相应的错误提示。这可以帮助我们在开发过程中及早发现和解决问题，提高代码的健壮性和可维护性。
简洁明了：Wire 的使用方式简单明了，无需复杂的配置或学习曲线。我们只需在代码中定义提供者函数和注入者结构体，然后使用 Wire 工具生成相应的依赖注入代码即可。
灵活可扩展：Wire 提供了丰富的功能和选项，可以满足不同类型应用程序的需求。我们可以使用 Provider Sets、Set Functions 等功能来组织和管理依赖关系，从而实现更灵活、可扩展的依赖注入方案。

Wire 是一个强大而简单的依赖注入框架，它可以帮助我们更轻松地管理和注入依赖关系，从而提高代码的质量、可维护性和可测试性。

参考资料

[1]

Wire: https://github.com/google/wire

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2024-05-26，如有侵权请联系 cloudcommunity@tencent.com 删除