go依赖注入库samber/do使用示例讲解

 更新时间:2024年02月20日 15:12:34   作者:easy-learning  
这篇文章主要介绍了go依赖注入库samber/do使用,在本文中,我们学习了如何使用samber/do在 Go 中提供依赖注入,需要的朋友可以参考下

介绍

以简单和高效而闻名的Go语言在其1.18版本中引入了泛型,这可以显着减少大量代码生成的需要,使该语言更加强大和灵活。如果您有兴趣, Go 泛型教程 是很好的学习资源。

通过使用 Go 的泛型,samber/do库为依赖注入 (DI) 提供了一个很好的解决方案。依赖注入是一种重要的设计模式,它促进对象及其依赖关系之间的松散耦合,从而提高代码模块化性、可测试性和可维护性。泛型和依赖注入的结合进一步提升了 Go 在创建高效、可扩展软件方面的潜力。在本文中,您将学习如何使用 samber/do 提供依赖注入。

代码结构

.
├── cmd
│   └── web
│       └── main.go
├── domain
│   └── user.go
├── go.mod
├── go.sum
└── user
    ├── handler.go
    ├── repository.go
    └── service.go

我们使用与这篇博客相同的示例,但使用samber/do 库来实现 DI 而不是 Google Wire。正如我们所看到的,代码的结构变得更加简单。您可以在 https://github.com/Shujie-Tan/do-example 找到源代码。

服务关系
domain /user.go定义了业务逻辑结构和接口,如下所示。

type (
	User struct {
		ID       string `json:"id"`
		Username string `json:"username"`
	}
	UserEntity struct {
		ID       string
		Username string
		Password string
	}
	UserRepository interface {
		FetchByUsername(ctx context.Context, username string) (*UserEntity, error)
	}
	UserService interface {
		FetchByUsername(ctx context.Context, username string) (*User, error)
	}
	UserHandler interface {
		FetchByUsername() http.HandlerFunc
	}
)

在用户目录下可以看到这些接口的实现。其关系可以表示为

UserHandler -> UserService -> UserRepository -> sql.DB

这意味着UserHandler依赖于UserService,而 UserService 又依赖于UserRepository,最后UserRepository依赖于sql.DB进行数据库操作。这些依赖关系可通过使用接口来反转。

这是一个很简单的例子。现在我们构建对象及其依赖关系。

cmd/web/main.go

package main
import (
	"database/sql"
	"example/domain"
	"example/user"
	"fmt"
	"net/http"
	_ "github.com/lib/pq"
	"github.com/samber/do"
)
func main() {
	injector := do.New() // 1
	connStr := "user=root dbname=mydb"
	db, err := sql.Open("postgres", connStr) // 2
	if err != nil {
		panic(err)
	}
	defer db.Close()
	do.ProvideNamed[*sql.DB](injector, "user", func(i *do.Injector) (*sql.DB, error) {
		return db, nil
	}) // 3
    do.Provide(injector, user.NewRepository)
	do.Provide(injector, user.NewService)
	do.Provide(injector, user.NewHandler) // 4
	userHandler := do.MustInvoke[domain.UserHandler](injector) // 5
	http.Handle("/user", userHandler.FetchByUsername())
	fmt.Printf("Try run server at :%d\n", 8080)
	if err := http.ListenAndServe(":8080", nil); err != nil {
		fmt.Printf("Error: %v", err)
	}
}

我们逐步分析一下代码:

  • main 函数首先使用 injector := do.New() 创建一个新的 DI 容器。该容器将用于管理应用程序对象的依赖关系。
  • 使用sql.Open函数建立与 PostgreSQL 数据库的连接。
  • 使用do.ProvideNamed函数将数据库连接添加到 DI 容器。
  • 该函数采用三个参数:DI 容器、依赖项的名称以及返回依赖项和错误的提供程序函数。在本例中,依赖项是数据库连接,该函数仅返回连接并返回 nil 来表示错误。使用do.Provide函数将repository、service和handler添加到 DI 容器。该函数有两个参数:DI 容器和返回依赖项和错误的函数。
  • 在本例中,函数是user.NewRepositoryuser.NewServiceuser.NewHandler,它们分别创建repository、service和handler的实例。请注意提供程序函数的返回类型应该是接口,而不是具体类型。Go语言模式『接受接口,返回结构』将在 v2版本支持。使用do.MustInvoke函数从 DI 容器检索userHandler并将其注册到 http 包。
  • 该函数采用两个参数:DI 容器和要检索的依赖项的类型。在本例中,它检索用户处理程序并将其FetchByUsername方法注册为 /user 路由的处理程序。

用户/repository.go

package user
import (
	"context"
	"database/sql"
	"example/domain"
	"github.com/samber/do"
)
type repository struct {
	db *sql.DB
}
func (r *repository) FetchByUsername(ctx context.Context, username string) (*domain.UserEntity, error) {
	// use db here
}
// the return type of NewRepository should be interface, rather than the concrete type!
func NewRepository(i *do.Injector) (domain.UserRepository, error) {
	db := do.MustInvokeNamed[*sql.DB](i, "user")
	return &repository{db: db}, nil
}

user/service.go

package user
import (
	"context"
	"example/domain"
	"github.com/samber/do"
)
type service struct {
	repo domain.UserRepository
}
func (s *service) FetchByUsername(ctx context.Context, username string) (*domain.User, error) {
	// use repository here
}
func NewService(i *do.Injector) (domain.UserService, error) {
	repo := do.MustInvoke[domain.UserRepository](i)
	return &service{repo: repo}, nil
}

user/handler.go

package user
import (
	"example/domain"
	"net/http"
	"github.com/samber/do"
)
type handler struct {
	svc domain.UserService
}
func (h *handler) FetchByUsername() http.HandlerFunc {
    // use service here
}
func NewHandler(i *do.Injector) (domain.UserHandler, error) {
	svc := do.MustInvoke[domain.UserService](i)
	return &handler{svc: svc}, nil
}

结论

在本文中,我们学习了如何使用samber/do在 Go 中提供依赖注入。我们已经了解了如何创建 DI 容器、向容器添加依赖项以及从容器中检索依赖项。我们还了解了如何使用容器来管理应用程序的依赖项。通过使用samber/do,我们可以创建更加模块化、可测试和可维护的代码,并充分利用 Go 的新泛型功能。

到此这篇关于go依赖注入库samber/do使用示例讲解的文章就介绍到这了,更多相关go依赖注入库内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go REFLECT Library反射类型详解

    Go REFLECT Library反射类型详解

    这篇文章主要为大家介绍了Go REFLECT Library反射类型详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • Golang并发操作中常见的读写锁详析

    Golang并发操作中常见的读写锁详析

    Golang中的锁机制主要包含互斥锁和读写锁互斥锁互斥锁是传统并发程序对共享资源进行控制访问的主要手段,这篇文章主要给大家介绍了关于Golang并发操作中常见的读写锁的相关资料,需要的朋友可以参考下
    2021-08-08
  • Go基础Slice教程详解

    Go基础Slice教程详解

    这篇文章主要介绍了Go基础Slice教程详解,需要的朋友可以参考下
    2018-02-02
  • Go tablewriter库提升命令行输出专业度实例详解

    Go tablewriter库提升命令行输出专业度实例详解

    命令行工具大家都用过,如果是运维人员可能会编写命令行工具来完成各种任务,命令行输出的美观和易读性往往容易被忽视,很烂的输出会让人感觉不专业,本文将介绍Go语言中牛逼的实战工具tablewriter库,使你在命令行输出中展现出专业的一面
    2023-11-11
  • Go语言中的iota关键字的使用

    Go语言中的iota关键字的使用

    这篇文章主要介绍了Go语言中的iota关键字的使用的相关资料,需要的朋友可以参考下
    2023-08-08
  • Go 结构体序列化的实现

    Go 结构体序列化的实现

    本文主要介绍了Go 结构体序列化的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Go 语言 IDE 中的 VSCode 配置使用教程

    Go 语言 IDE 中的 VSCode 配置使用教程

    Gogland 是 JetBrains 公司推出的Go语言集成开发环境。这篇文章主要介绍了Go 语言 IDE 中的 VSCode 配置使用教程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-05-05
  • Go1.21新增slices包的用法详解

    Go1.21新增slices包的用法详解

    Go 1.21新增的 slices 包提供了很多和切片相关的函数,可以用于任何类型的切片,这篇文章主要来和大家介绍一下slices包中相关函数的用法,需要的可以参考一下
    2023-08-08
  • golang 阻止主goroutine退出的操作

    golang 阻止主goroutine退出的操作

    这篇文章主要介绍了golang 阻止主goroutine退出的操作方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • go中string、int、float相互转换方式

    go中string、int、float相互转换方式

    这篇文章主要介绍了go中string、int、float相互转换方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07

最新评论