您的当前位置:首页>全部文章>文章详情

【Go】go依赖注入库samber/do使用

CrazyPanda发表于:2024-02-24 22:08:56浏览:351次TAG:


介绍

以简单和高效而闻名的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)
	}
}

我们逐步分析一下代码:

  1. main 函数首先使用 injector := do.New() 创建一个新的 DI 容器。该容器将用于管理应用程序对象的依赖关系。

  2. 使用sql.Open函数建立与 PostgreSQL 数据库的连接。

  3. 使用do.ProvideNamed函数将数据库连接添加到 DI 容器。该函数采用三个参数:DI 容器、依赖项的名称以及返回依赖项和错误的提供程序函数。在本例中,依赖项是数据库连接,该函数仅返回连接并返回 nil 来表示错误。

  4. 使用do.Provide函数将repository、service和handler添加到 DI 容器。该函数有两个参数:DI 容器和返回依赖项和错误的函数。在本例中,函数是user.NewRepositoryuser.NewServiceuser.NewHandler,它们分别创建repository、service和handler的实例。请注意提供程序函数的返回类型应该是接口,而不是具体类型。Go语言模式『接受接口,返回结构』将在 v2版本支持。

  5. 使用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】Go语言的发展历程和未来展望
Go语言的发展历程和未来展望Go语言(也称为Golang)是由Google开发的一种新兴的编程语言,自2007年首次亮相以来,逐渐成为了程序员们喜爱的语言之一。Go语言具有本地支持并发的内置特性、优秀的性能和简洁的语法,这些特点使其在云计算、网络编程等领域有着广泛的应用。发展历程Go语言的发展历程可以追溯到2007年1月,当时Robert Griesemer、Rob Pike和Ken Thompson开始着手开发这门语言。2009年11月,Go语言的第一个稳定版本1.0发布,随着社区的不断发展壮
发表于:2024-03-14 浏览:310 TAG:
【Go】Go语言常用命令详解(一)
前言Go语言是一种开源的编程语言,由Google开发并于2009年首次发布。它以其简洁、高效和并发性能而备受开发者的喜爱。作为一门相对年轻的语言,Go语言的学习和使用对于初学者来说可能会有一些挑战。因此,本文将介绍一些常用的Go语言命令,帮助读者更好地理解和使用这门语言。常用命令以下是一些常用的Go命令,这些命令可以帮助您在Go开发中进行编译、测试、运行和管理依赖项等任务。命令描述go build编译Go程序包及其依赖项。go test运行包的测试。go run编译并运行Go程序。go clea
发表于:2024-03-07 浏览:316 TAG:
【Go】Linux下搭建go开发环境
配置go编译器下载go从go官方网站下载最新的安装包  以go1.18.1.linux-amd64.tar.gz为例,放在用户的home目录。解压使用命令 tar -xzvf go1.18.1.linux-amd64.tar.gz 解压配置打开~/.bashrc文件,写入如下配置:export GOPATH=$HOME/go export PATH=$PATH:$GOPATH/bin export PATH=$PATH:$GOPATH/bin:/usr/local
发表于:2024-02-25 浏览:290 TAG:
【Go】常用的6款Go语言Web框架
前言由于工作需要,这些年来也接触了不少的开发框架,Golang的开发框架比较多,不过基本都是Web”框架”为主。这里稍微打了个引号,因为大部分”框架”从设计和功能定位上来讲,充其量都只能算是一个组件,需要项目使用的话得自己四处再去找找其他的组件,或者自己造轮子。如果用于Web开发,这些”框架”的Web开发能力均已完备,无太大差别,且均是自标准库net/http.Server的二次封装。由于框架众多,这里笔者只选择了几个曾做过技术选型评估、较为熟悉,且目前比较流行和典型的Golang”框架”,从适
发表于:2024-02-26 浏览:336 TAG:
【Go】VSCode配置Go语言开发库
1. Go插件配置安装好vscode后,打开插件页面,搜索Go相关插件,如图,选择第一个安装。插件安装完成后,点击设置图标,选择Extension Setting选项,进入插件设置页面。在插件设置选项中,选择待遇Edit in setting.json的选项,点击进入setting.json配置文件。将GOPATH和GOROOT配置到setting.json文件,如下图所示:配置完成后,就可以开始写go文件。2. Go开发语言包设置这时候vscode会提示未安装ygo语言包,根据右下角提示,点击
发表于:2024-06-07 浏览:330 TAG:
【Go】Go的数据挖掘与机器学习框架
1.背景介绍Go是一种现代的、高性能的、静态类型的编程语言,它由Google开发并于2009年发布。Go语言的设计目标是简单、可靠和高性能。Go语言的特点是简单的语法、强大的标准库、垃圾回收、并发处理等。Go语言的发展非常快速,已经被广泛应用于云计算、大数据、机器学习等领域。在大数据和机器学习领域,Go语言的优势在于其高性能、并发处理能力和简单易用的语法。Go语言的标准库提供了丰富的数据处理和并发处理功能,这使得Go语言成为处理大量数据和实时处理数据的理想语言。在本文中,我们将讨论Go语言在数据
发表于:2024-02-27 浏览:326 TAG:
【Go】Golang标准库介绍(二)
1. debug 库 (各种调试文件格式访问及调试功能在 Go 语言的标准库中,并没有一个名为 debug 的独立库。然而,Go 提供了一系列的工具和包,用于调试和性能分析。这些工具和包包括 debug/pprof、runtime/pprof、net/http/pprof 等,用于生成和分析性能剖析数据。相关的包和工具:1. runtime/pprof: 提供了运行时性能分析的功能,可以用于查看 CPU 和内存的使用情况。它通过在代码中插入特殊的语句来收集
发表于:2024-03-03 浏览:279 TAG:
【Go】golang六个常用的web 框架
1 Gin 68.5k starsGin是一个轻量级的高性能的Web框架,具有快速、高效、易用等特点,可以用于快速构建RESTful API和Web应用程序。它采用了类似于Martini的API设计,但性能更好。Gin具有以下优点:- 性能高:Gin采用了基于radix树的路由实现,可以快速匹配URL和处理请求,性能非常高。- 功能丰富:Gin提供了丰富的中间件支持,可以方便地进行路由、参数解析、日志记录等操作。- 易于学习:Gin的API设计简洁明了,易于学习和使用。缺点:- Gin的文档相对
发表于:2024-03-09 浏览:378 TAG:
【Go】Go语言支持哪些常见函数
Go语言是一门开源的编程语言,由Google开发,在云计算和大数据领域广泛应用。它支持丰富的标准库,提供了许多常见的函数来帮助开发者编写高效、可靠的代码。在本文中,我们将探讨Go语言支持的一些常见函数,并提供具体的代码示例。1. 字符串处理函数Go语言提供了丰富的字符串处理函数,帮助开发者对字符串进行各种操作,比如拼接、分割、替换、查找等。以下是一些常见的字符串处理函数及其代码示例:package main   import (    
发表于:2024-03-22 浏览:314 TAG:
【Go】Go语言起源与应用
目录一.Go语言来源二.Go语言应用一.Go语言来源    Go语言,又称Golang,是Google公司于2009年11月正式对外公开的一门编程语言。它是一门静态强类型、编译型的语言,其语法与C相近,但在功能上有所改进和增加,如内存安全、垃圾回收、结构形态及CSP-style并发计算等。    Go语言的主要目标是兼具Python等动态语言的开发速度和C/C++等编译型语言的性能与安全性。它不仅可以让程序员访问底层操作系统,还提供了强大的网络编程和并发编
发表于:2024-02-24 浏览:351 TAG: