在连线依赖注入中创建每个提供者的记录器

本篇文章主要是结合我之前面试的各种经历和实战开发中遇到的问题解决经验整理的，希望这篇《在连线依赖注入中创建每个提供者的记录器》对你有很大帮助！欢迎收藏，分享给更多的需要的朋友学习~

我正在使用 github.com/google/wire 在我正在开发的开源示例项目中进行依赖项注入。

我在名为 interfaces 的包中有以下接口：

type loginservice interface {
    login(email, password) (*loginresult, error)
}

type jwtservice interface {
    generate(user *models.user) (*jwtgenerateresult, error)
    validate(tokenstring string) (*jwtvalidateresult, error)
}

type userdao interface {
    byemail(email string) (*models.user, error)
}

我的实现如下所示：

我将在这里排除其他工厂函数和实现，因为它们看起来都非常相似。他们可能会返回错误或绝对正确。

我还有另一个有趣的工厂用于创建数据库连接，我将仅显示其接口而不是实现：

func connect(config interfaces.mysqlconfig) (*gorm.db, error) { /* ... */ }

现在，解决问题。在我的命令行入口点中，我正在创建一个记录器：

logger, err := zap.newdevelopment()

对于上面的每个工厂方法，我需要提供一个记录器，而不是相同的记录器实例，就像这些方法是按如下方式调用的：

logger, err := zap.newdevelopment()

// check err

db, err := database.connect(config)

// check err

userdao := dao.newuserdao(db, logger.named("dao.user"))
jwtservice, err := service.newjwtservice(jwtkey)

// check err

loginservice := service.newloginservice(jwtservice, userdao, logger.named("service.login"))

我的 wire.providerset 构造如下所示：

wire.NewSet(
    wire.Bind(new(interfaces.LoginService), new(*service.LoginServiceImpl)),
    wire.Bind(new(interfaces.JWTService), new(*service.JWTServiceImpl)),
    wire.Bind(new(interfaces.UserDao), new(*dao.UserDaoImpl)),
    service.NewLoginService,
    service.NewJWTService,
    dao.NewUserDao,
    database.Connect,
)

我已经阅读了用户指南、教程和最佳实践，但我似乎找不到一种方法将唯一的 zap.logger 路由到每个工厂方法，并路由随机 [32 ]byte 用于 jwt 服务。

由于我的根记录器不是在编译时创建的，并且每个工厂方法都需要自己独特的记录器，因此我如何告诉 wire 将这些实例绑定到相应的工厂方法？我很难了解如何将相同类型的自定义实例路由到不同的工厂方法。

总结：

wire 似乎倾向于在编译时执行所有操作，将依赖项注入配置存储在静态包级变量中。对于我的大多数用例来说，这是可以的。 对于我的其余用例，我需要在运行依赖项注入之前手动创建一些实例，并能够将各种 *zap.logger 实例路由到每个需要它的服务。 本质上，我需要有wire do services.newuserdao(connect(mysqlconfig), logger.named("dao.user")，但我不知道如何在wire中表达这一点，并在运行时与wire的编译时合并变量方法。

如何在 wire 中执行此操作？

正确答案

我必须按照 documentation 中的建议稍微改变一下我正在做的事情：

添加自定义类型

文档确实非常简洁，但我最终所做的是创建一堆类型：

type jwtkey [32]byte
type jwtservicelogger *zap.logger
type loginservicelogger *zap.logger
type userdaologger *zap.logger

更新生产者函数

我更新了我的生产者方法以接受这些类型，但不必更新我的结构：

// loginserviceimpl implements interfaces.loginservice
var _ interfaces.loginservice = (*loginserviceimpl)(nil)

type loginserviceimpl struct {
    dao interfaces.userdao
    jwt interfaces.jwtservice
    logger *zap.logger
}

func newloginservice(dao interfaces.userdao, jwt interfaces.jwtservice, 
        logger loginservicelogger) *loginserviceimpl {
    return &loginserviceimpl {
        dao: dao,
        jwt: jwt,
        logger: logger,
    }
}

以上部分是有道理的；给出不同的类型意味着 wire 需要弄清楚的事情更少。

创建注入器

接下来，我必须创建虚拟注入器，然后使用 wire 生成相应的 wire_gen.go。这并不容易，而且非常不直观。当遵循文档时，事情不断发生故障并给我带来非常无用的错误消息。

我有一个 cmd/ 软件包，我的 cli 入口点位于 cmd/serve/root.go 中，它从命令行作为 ./apiserve 运行。我在 cmd/serve/injectors.go 中创建了注入器函数，请注意 // +buildwireinject 和以下换行符需要通知 go 该文件用于代码生成而不是代码本身。

经过多次尝试和错误，我最终得到了以下代码：

// +build wireinject

package serve

import /*...*/

func initializeloginservice(
        config interfaces.mysqlconfig,
        jwtkey service.jwtkey,
        loginservicelogger service.loginservicelogger,
        jwtservicelogger service.jwtservicelogger,
        userdaologger service.userdaologger,
        databaselogger database.databaselogger,
    ) (interfaces.loginservice, error) {
    
    wire.build(
        // bind interfaces to implementations
        wire.bind(new(interfaces.loginservice), new(*service.loginserviceimpl)),
        wire.bind(new(interfaces.jwtservice), new(*service.jwtserviceimpl)),
        wire.bind(new(interfaces.userdao), new(*dao.userdao)),
        // services
        service.newloginservice,
        service.newjwtservice,
        // daos
        dao.newuserdao,
        // database
        database.connect,
    )

    return nil, nil
}

wire.bind 调用通知 wire 对于给定接口使用哪个实现，以便它知道返回 *loginserviceimpl 的 service.newloginservice 应该用作 interfaces.loginservice。

调用 wire.build 中的其余实体只是工厂函数。

将值传递给注入器

我遇到的问题之一是我试图将值传递到 wire.build like the documentation describes：

这就是让我困惑的地方；听起来你在尝试运行注入器时只能真正使用常量值，但是 there are two lines in the docs in the "injectors" section：

这些行附有以下代码：

func initializebaz(ctx context.context) (foobarbaz.baz, error) {
    wire.build(foobarbaz.megaset)
    return foobarbaz.baz{}, nil
}

这就是我错过的，也是导致我在这方面浪费大量时间的原因。 context.context 似乎没有在这段代码中传递到任何地方，而且它是一种常见类型，所以我只是耸耸肩，没有从中学习。

我定义了注入器函数来获取 jwt 键、mysql 配置和记录器类型的参数：

func initializeloginservice(
        config interfaces.mysqlconfig,
        jwtkey service.jwtkey,
        loginservicelogger service.loginservicelogger,
        jwtservicelogger service.jwtservicelogger,
        userdaologger service.userdaologger,
        databaselogger database.databaselogger,
    ) (interfaces.loginservice, error) {
    // ...
    return nil, nil
}

然后，我尝试将它们注入到 wire.build 中：

wire.Build(
    // ...
    wire.Value(config),
    wire.Value(jwtKey),
    wire.Value(loginServiceLogger),
    // ...
)

当我尝试运行 wire 时，它抱怨这些类型被定义了两次。我对这种行为感到非常困惑，但最终了解到 wire 自动将所有函数参数发送到 wire.build。

再一次：wire 自动将所有注入器功能参数发送到 wire.build。

这对我来说并不直观，但我经历了惨痛的教训才知道这就是 wire 的工作方式。

摘要

wire 没有提供一种方法来区分其依赖注入系统中相同类型的值。因此，您需要用类型定义包装这些简单类型，让 wire 知道如何路由它们，因此不要使用 [32]byte，而是 type jwtkey [32]byte。

要将实时值注入到 wire.build 调用中，只需更改注入器函数签名以将这些值包含在函数参数中，wire 就会自动将它们注入到 wire.build 中。

运行 cd pkg/my/package &&wire 在该目录中为您定义的注入器创建 wire_gen.go。完成此操作后，以后对 gogenerate 的调用将在发生更改时自动更新 wire_gen.go。

我已将 wire_gen.go 文件签入到我的版本控制系统 (vcs)（即 git）中，由于这些生成的构建工件，这感觉很奇怪，但这似乎是通常完成此操作的方式。排除 wire_gen.go 可能会更有利，但如果这样做，您需要找到包含带有 // +buildwireinject 标头的文件的每个包，在该目录中运行 wire，然后 go 生成 可以肯定的是。

希望这能够澄清 wire 处理实际值的方式：使用类型包装器使它们类型安全，然后只需将它们传递给您的注入器函数，wire 就会完成剩下的工作。

本篇关于《在连线依赖注入中创建每个提供者的记录器》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于Golang的相关知识，请关注golang学习网公众号！