使用 @MockBean 和 @SpyBean 解决 SpringBoot 单元测试中 Mock 类装配的问题

最近在做某个项目的时候一直使用 @MockBean 来解决单元测试中 Mock 类装配到被测试类的问题。这篇文章主要介绍了 @MockBean 的使用例子以及不使用 @MockBean 而使用@SpyBean 的情景和原因。

文章中的所有代码均为 Kotlin 语言，与 Java 略有不同。但是 Kotlin 的语法比较容易理解，原生 Java 的读者在阅读时应该不会有太大的障碍。

请看下面的代码：

import java.net.URI

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.http.HttpHeaders
import org.springframework.http.HttpStatus
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController

@RestController
@RequestMapping(path = “/api/users”)
class UserResource {
@Autowired
private val userRepository:UserRepository

@PostMapping
fun create(request:CreateUserRequest):ResponseEntity {
val user = userRepository.save(request.toUser())
val headers = HttpHeaders()
headers.setLocation(URI.create("/api/users/" + user.getId()))
return ResponseEntity(headers, HttpStatus.CREATED)
}
}
这是一个简单的 Spring controller ，向外暴露了一个 /api/users 接口，并且注入了一个自定义的 repository（ UserRepository ）用来和 MongoDB 的数据库交流（限于篇幅，自定义的 repository 的实现代码没有给出）。

我们现在要对它做单元测试，下面是单元测试的代码：

import org.junit.Test
import org.junit.runner.RunWith
import org.mockito.Mockito

import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.mock.mockito.MockBean
import org.springframework.http.MediaType
import org.springframework.test.context.junit4.SpringRunner
import org.springframework.test.web.servlet.MockMvc

import org.mockito.Mockito.when
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
import org.springframework.test.web.servlet.result.MockMvcResultHandlers.print
import org.springframework.test.web.servlet.result.MockMvcResultMatchers.header
import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status

@SpringBootTest
@RunWith(SpringRunner::class)
@AutoConfigureMockMvc
class UserResourceTests {
@Autowired
private val mockMvc:MockMvc

@MockBean
private val userRepository:UserRepository

@Test
fun should_create_a_user() {
val json = “{“username”:“shekhargulati”,“name”:“Shekhar Gulati”}”
when(userRepository.save(Mockito.any(User::class.java))).thenReturn(User(“123”))
this.mockMvc
.perform(post("/api/users").contentType(MediaType.APPLICATION_JSON).content(json))
.andDo(print())
.andExpect(status().isCreated())
.andExpect(header().string(“Location”, “/api/users/123”))
}
}
可以看到，在做单元测试时，如果想要 mock UserRepository 的逻辑，只需要声明一个变量并在上面加上 @MockBean 的注释即可，之后使用 when().thenReturn() 来设定 mock UserRepository 的行为。在运行时 SpringBoot 会扫描到你注释的 mock ，并自动装配到被测试的 controller 里面。这也是和 @Mock 注释不同的地方，后者只能生成一个 Mock 类，但是并不能自动装配到其它类里面。

MongoTemplate 的单元测试
现在假设你并没有使用自己实现的 UserRepository 来与数据库交流，而是使用 SpringBoot 自带的 MongoTemplate 装配到 controller 里面，那么代码大概是下面这样的：

@RestController
@RequestMapping(path = “/api/users”)
class UserResource {
@Autowired
private val mongoTemplate:MongoTemplate

@PostMapping
fun create(@RequestBody request:CreateUserRequest):ResponseEntity {
val user = this.mongoTemplate.findOne(
Query.query(Criteria.where(“username”).is(request.username)),
User::class.java
)
if (user != null)
{
return ResponseEntity(HttpStatus.CONFLICT)
}
mongoTemplate.save(request.toUser(), “user”)
return ResponseEntity(HttpStatus.CREATED)
}
}
可以看到代码的结构没有大的变化，只是不同的接口在方法调用的细节上不太一样。现在我们要对它做单元测试。

代码如下：

@SpringBootTest
@RunWith(SpringRunner::class)
@AutoConfigureMockMvc
class UserResourceTests {
@Autowired
private val mockMvc:MockMvc

@MockBean
private val mongoTemplate:MongoTemplate

@Test
fun should_create_a_user() {
val json = “{“username”:“shekhargulati”,“name”:“Shekhar Gulati”}”
when(mongoTemplate.findOne(Mockito.any(Query::class.java), Mockito.eq(User::class.java))).thenReturn(User(“123”))
this.mockMvc
.perform(post("/api/users").contentType(MediaType.APPLICATION_JSON).content(json))
.andDo(print())
.andExpect(status().isCreated())
verify(mongoTemplate).save(Mockito.any(User::class.java))
}
}
但是当运行的时候却出现了 NullPointerException。

Caused by: java.lang.NullPointerException
at org.springframework.data.mongodb.repository.support.MongoRepositoryFactory.(MongoRepositoryFactory.java:73)
at org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean.getFactoryInstance(MongoRepositoryFactoryBean.java:104)
at org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean.createRepositoryFactory(MongoRepositoryFactoryBean.java:88)
at org.springframework.data.repository.core.support.RepositoryFactoryBeanSupport.afterPropertiesSet(RepositoryFactoryBeanSupport.java:248)
at org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean.afterPropertiesSet(MongoRepositoryFactoryBean.java:117)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1687)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1624)
之所以会出现空指针异常，是因为 MongoTemplate 是一个 SpringBoot 库的一个内部接口，而 @MockBean 只能 mock 本地的代码——或者说是自己写的代码，对于储存在库中而且又是以 Bean 的形式装配到代码中的类无能为力。

该 @SpyBean 上场了
@SpyBean 与 @Spy 的关系类似于 @MockBean 与 @Mock 的关系。和 @MockBean 不同的是，它不会生成一个 Bean 的替代品装配到类中，而是会监听一个真正的 Bean 中某些特定的方法，并在调用这些方法时给出指定的反馈。却不会影响这个 Bean 其它的功能。

于是测试代码变成了下面这样。

@SpringBootTest
@RunWith(SpringRunner::class)
@AutoConfigureMockMvc
class UserResourceTests {
@Autowired
private val mockMvc:MockMvc

@SpyBean
private val mongoTemplate:MongoTemplate

@Test
fun should_create_a_user() {
val json = “{“username”:“shekhargulati”,“name”:“Shekhar Gulati”}”
doReturn(null)
.when(mongoTemplate).findOne(Mockito.any(Query::class.java), Mockito.eq(User::class.java))
doNothing().when(mongoTemplate).save(Mockito.any(User::class.java))
this.mockMvc
.perform(post("/api/users").contentType(MediaType.APPLICATION_JSON).content(json))
.andDo(print())
.andExpect(status().isCreated())
verify(mongoTemplate).save(Mockito.any(User::class.java))
}
}
@SpyBean 包裹着真正的 Bean 装配到了 controller 中，并对特定的行为作出反应。

需要注意的是，设置 spy 逻辑时不能再使用 when(某对象.某方法).thenReturn(某对象) 的语法，而是需要使用 doReturn(某对象).when(某对象).某方法 或者 doNothing(某对象).when(某对象).某方法。

总结
@SpyBean 解决了 SpringBoot 的单元测试中 @MockBean 不能 mock 库中自动装配的 Bean 的局限。使 SpringBoot 的单元测试更灵活也更简单。

假设你是一个大型团队的后端程序员，你负责的项目需要使用同事发布在仓库中的依赖，而这些依赖储存在库里但是最终以 Bean 的形式注入到你的代码中的。这个时候为了测试你的代码逻辑，@MockBean 就无法满足你的需求了。而 @SpyBean 便成为了最优雅的解决方案。