Go 语言中怎么使用依赖注入

news/发布时间2024/5/18 16:50:30

Go 语言中怎么使用依赖注入？

原创 frank Golang语言开发栈 2024-03-31 23:01 北京听全文

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

介绍

在 Go 语言项目开发中，我们处理组件层级之间的依赖关系时，通常我们会先在依赖层级的代码中实例化被依赖层级，然后调用它的方法，即依赖方需要主动获取被依赖方。

但是，当被依赖层级的代码发生变化时，依赖层级的代码也需要修改，耦合性比较高，代码不方便扩展。

所谓依赖注入，即依赖方不再需要主动获取被依赖方，而是被依赖方主动传递给依赖方。

本文我们介绍 Go 语言怎么使用依赖注入。

Go 语言使用依赖注入

在 Go 语言中，怎么使用依赖注入呢？我准备以 clean arch 架构的代码讲解。

推荐读者朋友们先阅读我之前写的一遍文章「Go 语言整洁架构实践」。

参照 Bob 大叔的一篇关于整洁架构的文章 The Clean Architecture，我们分 4 个层级：

Models
Repository
Usecase
Delivery

限于篇幅，本文主要介绍在 Go 语言中使用构造函数的方式实现依赖注入，读者朋友们可以在留言区分享其它实现方式。

示例代码：

// Models 层
type Todolist struct {
 Id      int64  `json:"id"`
 Title   string `json:"title"`
 Status  int    `json:"status"`
 Created int    `json:"created"`
 Updated int    `json:"updated"`
}

type TodoListRepository interface {
 Create(ctx context.Context, t *Todolist) (err error)
}

type TodoListUsecase interface {
 Create(context.Context, *Todolist) (err error)
}

// Repository 层
type mysqlTodoListRepository struct {
 Conn *sql.DB
}

func NewMysqlTodoListRepository(Conn *sql.DB) models.TodoListRepository {
 return &mysqlTodoListRepository{Conn}
}

func (m *mysqlTodoListRepository) Create(ctx context.Context, t *models.Todolist) (err error) {
 // ...
 return
}

// Usecase 层
type todoListUsecase struct {
 todoListRepo models.TodoListRepository
}

func NewTodoListUsecase(t models.TodoListRepository) models.TodoListRepository {
 return &todoListUsecase{
  todoListRepo: t,
 }
}

func (tl *todoListUsecase) Create(ctx context.Context, t *models.Todolist) (err error) {
 if t.Title == "" {
  return fmt.Errorf("illegal parameter")
 }
 return tl.todoListRepo.Create(ctx, t)
}

// Delivery 层
type TodoListHandler struct {
 TodoListUsecase models.TodoListUsecase
}

func NewTodoListHandler(r *gin.Engine, todoListUsecase models.TodoListUsecase) {
 handler := &TodoListHandler{
  TodoListUsecase: todoListUsecase,
 }
 r.POST("/create", handler.Create)
 r.Run()
}

// main 函数
func main() {
 conn, err := sql.Open(`mysql`, "root:root@tcp(127.0.0.1:3306)/todolist")
 if err != nil {
  log.Fatal(err)
 }
 r := gin.Default()
 todoListRepository := mysql.NewMysqlTodoListRepository(conn)
 todoListUsecase := usecase.NewTodoListUsecase(todoListRepository)
 http.NewTodoListHandler(r, todoListUsecase)
}

阅读上面这段代码，我们可以发现 Repository 层依赖数据库驱动 conn，Usecase 层依赖 Repository 层，Delivery 层依赖 Usecase 层。

以 Repository 层和 Usecase 层为例，我们可以发现 Usecase 层通过构造函数 func NewTodoListUsecase(t models.TodoListRepository) models.TodoListRepository 将其依赖项 models.TodoListRepository 以参数的形式传递过来，并将其放入 todoListUsecase 结构体中。

所以，我们使用 Usecase 层的构造函数 NewTodoListUsecase 创建 Usecase 对象时，需要先使用 Repository 层的构造函数 NewMysqlTodoListRepository 创建 Repository 对象，并将其以参数的形式传递给 Usecase 层的构造函数 NewTodoListUsecase。

通过依赖注入的方式，可以有效降低组件层级之间的耦合性，方便代码的扩展。比如示例代码中 Repository 层的方法修改代码，不会影响 Usecase 层的代码。

依赖注入工具

除了手写依赖注入代码，我们也可以使用依赖注入工具，开源社区有很多依赖注入工具，其中比较流行的主要有以下 3 个。

Google 开源的依赖注入工具 Wire^[1]，它是一个代码生成工具，也就是说它是在编译时自动生成代码。

另外 2 个依赖注入工具是在运行时基于 Go 反射实现，分别是 uber开源的依赖注入工具 Dig^[2] 和 facebook 开源的依赖注入工具^[3]。

读者朋友们可以根据实际开发中的需求，选择合适的工具。

总结

读者朋友们可能已经发现，依赖注入实际上就是面向对象五大原则之一，依赖倒置原则的实现方式。

我们可以在 Go 项目开发中，使用依赖注入的方式，降低组件层级之间的代码耦合性，使代码更方便扩展。