Go微服务开源框架kratos的依赖注入关系总结

该文章为学习开源微服务框架kratos的学习笔记！官方文档见：简介 | Kratos

Kratos 一套轻量级 Go 微服务框架，包含大量微服务相关框架及工具。

一、Kratos 项目结构简介

通过 Kratos 工具生成的 Go工程化项目模板如下：

application
|____api
| |____helloworld
| | |____v1
| | |____errors
|____cmd
| |____helloworld
|____configs
|____internal
| |____conf
| |____data
| |____biz
| |____service
| |____server
|____test
|____pkg
|____go.mod
|____go.sum
|____LICENSE
|____README.md

二、kratos 依赖注入关系图

 其中有关依赖注入的详细文档见：Go工程化 - 依赖注入 | Kratos

以下是我自己总结的kratos依赖注入关系图：

特别注意：data层的 NewXxxRepo 返回的是 biz 层定义的实体数仓的接口类型！！！

这样做的目的：正常情况是 data 层定义好数据操作函数后被 biz 层调用，但这里是 biz 层定义好操作数据层的接口，然后让 data 层去实现，从而实现 data 层对 biz 层的反向依赖。这样做的好处是方便 data 层重构（比如数据存储由 mysql 改为 sqlServer 等），而不需要修改任何 biz 层的代码。

//下面代码位于 data/article.go
// 注意返回参数为 biz 层的接口，ArticleRepo 需要实现 biz.ArticleRepo 接口
func NewArticleRepo(data *Data, logger log.Logger) biz.ArticleRepo {
	return &articleRepo{
		data: data,
		log:  log.NewHelper(logger),
	}
}


// 下面代码位于 biz/article.go
// 在 biz 层定义好数据操作层（data层）的接口，以便让 data 层实现，不管 data 层今后如何实现或重构，都不影响 biz 层的业务代码
type ArticleRepo interface {
	// db
	ListArticle(ctx context.Context) ([]*Article, error)
	GetArticle(ctx context.Context, id int64) (*Article, error)
	CreateArticle(ctx context.Context, article *Article) error
	UpdateArticle(ctx context.Context, id int64, article *Article) error
	DeleteArticle(ctx context.Context, id int64) error
}

三、依赖注入生成的代码实例

运用 google/wire 工具将上述依赖注入生成具体的kratos项目代码示例：

原始 wire.go 代码：

// initApp init kratos application.
func initApp(*conf.Server, *conf.Data, *conf.Auth, log.Logger) (*kratos.App, func(), error) {
	panic(wire.Build(server.ProviderSet, data.ProviderSet, biz.ProviderSet, service.ProviderSet, newApp))
}

 工具生成的代码wire_gen.go：

// initApp init kratos application.
func initApp(confServer *conf.Server, confData *conf.Data, auth *conf.Auth, logger log.Logger) (*kratos.App, func(), error) {
	dataData, cleanup, err := data.NewData(confData, logger)
	if err != nil {
		return nil, nil, err
	}
	articleRepo := data.NewArticleRepo(dataData, logger)
	articleUsecase := biz.NewArticleUsecase(articleRepo, logger)
	blogService := service.NewBlogService(articleUsecase, logger)
	userRepo := data.NewUserRepo(dataData, logger)
	encryptService := biz.NewEncryptService(auth)
	accountUseCase := biz.NewAccountUseCase(logger, auth, userRepo, encryptService)
	accountService := service.NewAccountService(logger, accountUseCase)
	httpServer := server.NewHTTPServer(confServer, logger, blogService, accountService)
	grpcServer := server.NewGRPCServer(confServer, logger, blogService, accountService)
	app := newApp(logger, httpServer, grpcServer)
	return app, func() {
		cleanup()
	}, nil
}