快捷導(dǎo)航

go依賴(lài)注入庫(kù)samber/do使用示例講解

更新時(shí)間：2024年02月20日 15:12:34 作者：easy-learning

這篇文章主要介紹了go依賴(lài)注入庫(kù)samber/do使用,在本文中,我們學(xué)習(xí)了如何使用samber/do在?Go?中提供依賴(lài)注入,需要的朋友可以參考下

介紹

以簡(jiǎn)單和高效而聞名的Go語(yǔ)言在其1.18版本中引入了泛型，這可以顯著減少大量代碼生成的需要，使該語(yǔ)言更加強(qiáng)大和靈活。如果您有興趣， Go 泛型教程是很好的學(xué)習(xí)資源。

通過(guò)使用 Go 的泛型，samber/do庫(kù)為依賴(lài)注入 (DI) 提供了一個(gè)很好的解決方案。依賴(lài)注入是一種重要的設(shè)計(jì)模式，它促進(jìn)對(duì)象及其依賴(lài)關(guān)系之間的松散耦合，從而提高代碼模塊化性、可測(cè)試性和可維護(hù)性。泛型和依賴(lài)注入的結(jié)合進(jìn)一步提升了 Go 在創(chuàng)建高效、可擴(kuò)展軟件方面的潛力。在本文中，您將學(xué)習(xí)如何使用 samber/do 提供依賴(lài)注入。

代碼結(jié)構(gòu)

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

我們使用與這篇博客相同的示例，但使用samber/do 庫(kù)來(lái)實(shí)現(xiàn) DI 而不是 Google Wire。正如我們所看到的，代碼的結(jié)構(gòu)變得更加簡(jiǎn)單。您可以在 https://github.com/Shujie-Tan/do-example 找到源代碼。

服務(wù)關(guān)系
domain /user.go定義了業(yè)務(wù)邏輯結(jié)構(gòu)和接口，如下所示。

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
	}
)

在用戶(hù)目錄下可以看到這些接口的實(shí)現(xiàn)。其關(guān)系可以表示為

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

這意味著UserHandler依賴(lài)于UserService，而 UserService 又依賴(lài)于UserRepository，最后UserRepository依賴(lài)于sql.DB進(jìn)行數(shù)據(jù)庫(kù)操作。這些依賴(lài)關(guān)系可通過(guò)使用接口來(lái)反轉(zhuǎn)。

這是一個(gè)很簡(jiǎn)單的例子。現(xiàn)在我們構(gòu)建對(duì)象及其依賴(lài)關(guān)系。

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 函數(shù)首先使用 injector := do.New() 創(chuàng)建一個(gè)新的 DI 容器。該容器將用于管理應(yīng)用程序?qū)ο蟮囊蕾?lài)關(guān)系。
使用sql.Open函數(shù)建立與 PostgreSQL 數(shù)據(jù)庫(kù)的連接。
使用do.ProvideNamed函數(shù)將數(shù)據(jù)庫(kù)連接添加到 DI 容器。
該函數(shù)采用三個(gè)參數(shù)：DI 容器、依賴(lài)項(xiàng)的名稱(chēng)以及返回依賴(lài)項(xiàng)和錯(cuò)誤的提供程序函數(shù)。在本例中，依賴(lài)項(xiàng)是數(shù)據(jù)庫(kù)連接，該函數(shù)僅返回連接并返回 nil 來(lái)表示錯(cuò)誤。使用do.Provide函數(shù)將repository、service和handler添加到 DI 容器。該函數(shù)有兩個(gè)參數(shù)：DI 容器和返回依賴(lài)項(xiàng)和錯(cuò)誤的函數(shù)。
在本例中，函數(shù)是user.NewRepository、user.NewService和user.NewHandler，它們分別創(chuàng)建repository、service和handler的實(shí)例。請(qǐng)注意提供程序函數(shù)的返回類(lèi)型應(yīng)該是接口，而不是具體類(lèi)型。Go語(yǔ)言模式『接受接口，返回結(jié)構(gòu)』將在 v2版本支持。使用do.MustInvoke函數(shù)從 DI 容器檢索userHandler并將其注冊(cè)到 http 包。
該函數(shù)采用兩個(gè)參數(shù)：DI 容器和要檢索的依賴(lài)項(xiàng)的類(lèi)型。在本例中，它檢索用戶(hù)處理程序并將其FetchByUsername方法注冊(cè)為 /user 路由的處理程序。

用戶(hù)/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
}

結(jié)論

在本文中，我們學(xué)習(xí)了如何使用samber/do在 Go 中提供依賴(lài)注入。我們已經(jīng)了解了如何創(chuàng)建 DI 容器、向容器添加依賴(lài)項(xiàng)以及從容器中檢索依賴(lài)項(xiàng)。我們還了解了如何使用容器來(lái)管理應(yīng)用程序的依賴(lài)項(xiàng)。通過(guò)使用samber/do，我們可以創(chuàng)建更加模塊化、可測(cè)試和可維護(hù)的代碼，并充分利用 Go 的新泛型功能。

到此這篇關(guān)于go依賴(lài)注入庫(kù)samber/do使用示例講解的文章就介紹到這了,更多相關(guān)go依賴(lài)注入庫(kù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: