主要思路是:使用MockMvc发起请求,然后执行相应的代码,在执行的过程中使用Mockito的mock模拟底层数据的返回,最后结果验证。
1、首先需要增加相应的依赖:
/pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
需要在测试类中增加如下注解:
@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class MockXXXTest {
}
注解的大概使用是(想知道详细的可自行去网上找一下):
@RunWith(SpringRunner.class),就是指用SpringRunner来运行,其中
SpringJUnit4ClassRunner 和 SpringRunner 区别是什么?
在官方文档中有如下这句话:
SpringRunner is an alias for the SpringJUnit4ClassRunner
@SpringBootTest是SpringBoot的一个用于测试的注解,通过SpringApplication在测试中创建ApplicationContext。
@AutoConfigureMockMvc是用于自动配置MockMvc
2、接着需要使用@MockBean模拟相应对象
这里的主要作用是:使用mock对象代替原来spring的bean,然后模拟底层数据的返回,而不是调用原本真正的实现。
注:与@MockBean 对应的还有@SpyBean(有兴趣可以去找一下相关的内容)。 @SpyBean与 @Spy 的关系类似于 @MockBean 与 @Mock 的关系。和 @MockBean 不同的是,它不会生成一个 Bean 的替代品装配到类中,而是会监听一个真正的 Bean 中某些特定的方法,并在调用这些方法时给出指定的反馈。
- 首先增加
@MockBean
注解
public class MockXXXTest {
@MockBean
private XXXDao xxxtDao;
}
SpringBoot 中, @MockBean 会将mock的bean替换掉 SpringBoot 管理的原生bean,从而达到mock的效果。
mock:在软件开发的世界之外, "mock"一词是指模仿或者效仿. 因此可以将“mock”理解为一个替身,替代者. 在软件开发中提及"mock",通常理解为模拟对象或者Fake
- 然后 Stub 打桩
Mockito.when(
xxxDao.findMapBySql(
Mockito.anyString(),Mockito.anyList()
)
).thenReturn(dataList);
这里的when(…).thenReturn(…)
表示的是:当定义(when)对象、方法和参数(输入),然后(thenReturn) 中返回结果(输出)。默认情况下,所有的函数都有返回值。mock函数默认返回的是null,一个空的集合或者一个被对象类型包装的内置类型,例如:0、false对应的对象类型为Integer、Boolean。
这里值得注意的是:方法中使用的参数可以使用参数匹配器,如:Mockito.anyString(),Mockito.anyList()
,当其中有一个参数使用了参数匹配器,其实的所有参数也需要使用参数匹配器,否则会出现异常。
3 使用MockMvc发送请求
这里的主要作用是:使用MockMvc发起一个请求,然后进行验证规则、进一步处理返回结果等。
//配置MockMvc
@Autowired
protected MockMvc mockMvc;
@Test
public void TestXXX() throws Exception {
MvcResult result = mockMvc.perform(
MockMvcRequestBuilders.get("/xxxController/xxx_query")
.contentType(MediaType.APPLICATION_JSON_UTF8)
.param("xxx","xxx")
)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print())
.andReturn();
}
}
.perform()
执行一个MockMvcRequestBuilders请求。其中.get()
表示发送get请求(可以使用get、post、put、delete等);.contentType()
设置编码格式;.param()
请求参数,可以带多个。
andExpect()
添加 MockMvcResultMatchers验证规则,验证执行结果是否正确。
.andDo()
添加 MockMvcResultHandlers结果处理器,这是可以用于打印结果输出。
.andReturn()
结果还回,然后可以进行下一步的处理。
完整例子如下:
@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class MockXXXTest {
@Autowired
protected MockMvc mockMvc;
@MockBean
private XXXDao xxxtDao;
@Test
public void TestXXX() throws Exception {
List<Map<String,Object>> dataList= new ArrayList<>();
Map m=new HashMap();
m.put("name","test");
dataList.add(m);
Mockito.when(xxxDao.findMapBySql(Mockito.anyString(),Mockito.anyList())).thenReturn(dataList);
Mockito.when(xxxDao.findTotalCountBySql(Mockito.anyString(),Mockito.any())).thenReturn((long)1);
MvcResult result = mockMvc.perform(
MockMvcRequestBuilders.get("/xxxController/xxx_query")
.contentType(MediaType.APPLICATION_JSON_UTF8)
.param("xxx","xxx")
)
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print())
.andReturn();
System.out.println(result);
}
}