搞定Go单元测试(四)—— 依赖注入框架(wire)

https://juejin.im/post/5ce935dcf265da1ba431c998

在第一篇文章中提到过,为了让代码可测,需要用依赖注入的方式来构建我们的对象,而通常我们会在main.go做依赖注入,这就导致main.go会越来越臃肿。为了让单元测试得以顺利进行,main.go牺牲了它本应该纤细苗条的身材。太胖的main.go可不是什么好的信号,本篇将介绍依赖注入框架(wire),致力于帮助main.go恢复身材。

臃肿的main

main.go中做依赖注入,意味着在初始化代码中我们要管理:

  1. 依赖的初始化顺序
  2. 依赖之间的关系

对于小型项目而言,依赖的数量比较少,初始化代码不会很多,不需要引入依赖注入框架。但对于依赖较多的中大型项目,初始化代码又臭又长,可读性和维护性变的很差,随意感受一下:

  1. func main() {
  2. config := NewConfig()
  3. // db依赖配置
  4. db, err := ConnectDatabase(config)
  5. if err != nil {
  6. panic(err)
  7. }
  8. // PersonRepository 依赖db
  9. personRepository := NewPersonRepository(db)
  10. // PersonService 依赖配置 和 PersonRepository
  11. personService := NewPersonService(config, personRepository)
  12. // NewServer 依赖配置和PersonService
  13. server := NewServer(config, personService)
  14. server.Run()
  15. }

实践表明,修改有大量依赖关系的初始化代码是一项乏味且耗时的工作。这个时候,我们就需要依赖注入框架来帮忙,简化初始化代码。

上述代码来自:blog.drewolson.org/dependency-…

使用依赖注入框架——wire

What is wire?

wire是google开源的依赖注入框架。或者引用官方的话来说:“Wire is a code generation tool that automates connecting components using dependency injection”。

github.com/google/wire

Why wire?

除了wire,Go的依赖注入框架还有Uber的dig和Facebook的inject,它们都是使用反射机制来实现运行时依赖注入(runtime dependency injection),而wire则是采用代码生成的方式来达到编译时依赖注入(compile-time dependency injection)。使用反射带来的性能损失倒是其次,更重要的是反射使得代码难以追踪和调试(反射会令Ctrl+左键失效…)。而wire生成的代码是符合程序员常规使用习惯的代码,十分容易理解和调试。
关于wire的优点,在官方博文上有更详细的的介绍:blog.golang.org/wire

How does it work?

本部分内容参考官方博文:blog.golang.org/wire

wire有两个基本的概念:provider和injector。

provider

provider就是普通的Go函数,可以把它看作是某对象的构造函数,我们通过provider告诉wire该对象的依赖情况:

  1. // NewUserStore是*UserStore的provider,表明*UserStore依赖于*Config和 *mysql.DB.
  2. func NewUserStore(cfg *Config, db *mysql.DB) (*UserStore, error) {...}
  3. // NewDefaultConfig是*Config的provider,没有依赖
  4. func NewDefaultConfig() *Config {...}
  5. // NewDB是*mysql.DB的provider,依赖于ConnectionInfo
  6. func NewDB(info ConnectionInfo) (*mysql.DB, error) {...}
  7. // UserStoreSet 可选项,可以使用wire.NewSet将通常会一起使用的依赖组合起来。
  8. var UserStoreSet = wire.NewSet(NewUserStore, NewDefaultConfig)

injector

injector是wire生成的函数,我们通过调用injector来获取我们所需的对象或值,injector会按照依赖关系,按顺序调用provider函数:

  1. // File: wire_gen.go
  2. // Code generated by Wire. DO NOT EDIT.
  3. //go:generate wire
  4. //+build !wireinject
  5. // initUserStore是由wire生成的injector
  6. func initUserStore(info ConnectionInfo) (*UserStore, error) {
  7. // *Config的provider函数
  8. defaultConfig := NewDefaultConfig()
  9. // *mysql.DB的provider函数
  10. db, err := NewDB(info)
  11. if err != nil {
  12. return nil, err
  13. }
  14. // *UserStore的provider函数
  15. userStore, err := NewUserStore(defaultConfig, db)
  16. if err != nil {
  17. return nil, err
  18. }
  19. return userStore, nil
  20. }

injector帮我们把按顺序初始化依赖的步骤给做了,我们在main.go中只需要调用initUserStore方法就能得到我们想要的对象了。

那么wire是怎么知道如何生成injector的呢?我们需要写一个函数来告诉它:

  • 定义injector的函数签名
  • 在函数中使用wire.Build方法列举生成injector所需的provider

例如:

  1. // initUserStore用于声明injector的函数签名
  2. func initUserStore(info ConnectionInfo) (*UserStore, error) {
  3. // wire.Build声明要获取一个UserStore需要调用到哪些provider函数
  4. wire.Build(UserStoreSet, NewDB)
  5. return nil, nil // 这些返回值wire并不关心。
  6. }

有了上面的函数,wire就可以得知如何生成injector了。wire生成injector的步骤描述如下:

  1. 确定所生成injector函数的函数签名:func initUserStore(info ConnectionInfo) (*UserStore, error)
  2. 感知返回值第一个参数是*UserStore
  3. 检查wire.Build列表,找到*UserStore的provider:NewUserStore
  4. 由函数签名func NewUserStore(cfg *Config, db *mysql.DB)得知NewUserStore依赖于*Config, 和*mysql.DB
  5. 检查wire.Build列表,找到*Config*mysql.DB的provider:NewDefaultConfigNewDB
  6. 由函数签名func NewDefaultConfig() *Config得知*Config没有其他依赖了。
  7. 由函数签名func NewDB(info *ConnectionInfo) (*mysql.DB, error)得知*mysql.DB依赖于ConnectionInfo
  8. 检查wire.Build列表,找不到ConnectionInfo的provider,但在injector函数签名中发现匹配的入参类型,直接使用该参数作为NewDB的入参。
  9. 感知返回值第二个参数是error
  10. ….
  11. 按依赖关系,按顺序调用provider函数,拼装injector函数。

举个栗子

栗子传送门:wire-examples

注意

截止本文发布前,官方表明wire的项目状态是alpha,还不适合到生产环境,API存在变化的可能。
虽然是alpha,但其主要作用是为我们生成依赖注入代码,其生成的代码十分通俗易懂,在做好版本控制的前提下,即使是API发生变化,也不会对生成环境造成多坏的影响。我认为还是可以放心使用的。

总结一下

本篇是本系列的最后一篇,回顾前几篇文章,我们以单元测试的原理与基本思想为基础,介绍了表格驱动测试方法,gomock,testify,wire这几样实用工具,经历了“能写单元测试”到“写好单元测试”不断优化的过程。希望本系列文章能让你有所收获。

ft_authoradmin  ft_create_time2019-11-19 13:57
 ft_update_time2019-11-19 13:58