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 gRPC进阶教程gRPC转换HTTP

    Go gRPC进阶教程gRPC转换HTTP

    这篇文章主要为大家介绍了Go gRPC进阶教程gRPC转换HTTP教程示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • golang如何操作csv文件详解

    golang如何操作csv文件详解

    这篇文章主要给大家介绍了关于golang如何操作csv文件的相关资料,以及使用Golang导出CSV数据并解决数据乱码问题的解决办法,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-02-02
  • 深入了解Go语言中context的用法

    深入了解Go语言中context的用法

    这篇文章主要为大家详细介绍了Go语言中context用法的相关知识,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-07-07
  • 在Go中实现高效可靠的链路追踪系统

    在Go中实现高效可靠的链路追踪系统

    在当今互联网应用的架构中,分布式系统已经成为主流,分布式系统的优势在于能够提供高可用性、高并发性和可扩展性,本文将介绍链路追踪的概念和原理,并重点介绍如何在Golang中实现高效可靠的链路追踪系统,需要的朋友可以参考下
    2023-10-10
  • Go引用github包的详细流程步骤

    Go引用github包的详细流程步骤

    这篇文章主要给大家介绍了关于Go引用github包的详细流程步骤,文中通过图文介绍的非常详细,对大家学习或者使用Go具有一定的参考价值,需要的朋友可以参考下
    2024-02-02
  • Golang语言实现gRPC的具体使用

    Golang语言实现gRPC的具体使用

    本文主要介绍了Golang语言实现gRPC的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Golang如何实现任意进制转换的方法示例

    Golang如何实现任意进制转换的方法示例

    进制转换是人们利用符号来计数的方法,进制转换由一组数码符号和两个基本因素“基数”与“位权”构成,这篇文章主要给大家介绍了关于Golang如何实现10进制转换62进制的方法,文中给出了详细的示例代码供大家参考学习学习,下面随着小编来一起学习学习吧。
    2017-09-09
  • golang channel读取数据的几种情况

    golang channel读取数据的几种情况

    本文主要介绍了golang channel读取数据的几种情况,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-02-02
  • Go语言结构体定义和使用方法

    Go语言结构体定义和使用方法

    这篇文章主要介绍了Go语言结构体定义和使用方法,以实例形式分析了Go语言中结构体的定义和使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • Go语言动态并发控制sync.WaitGroup的灵活运用示例详解

    Go语言动态并发控制sync.WaitGroup的灵活运用示例详解

    本文将讲解 sync.WaitGroup 的使用方法、原理以及在实际项目中的应用场景,用清晰的代码示例和详细的注释,助力读者掌握并发编程中等待组的使用技巧
    2023-11-11

最新评论