基于 SpringBoot 实现单元测试的多种情境 / 方法(二)
本文分享自天翼云开发者社区 @《基于SpringBoot实现单元测试的多种情境/方法(二)》, 作者:才开始学技术的小白
1 Mock 基础回顾
在上一篇分享中我们详细介绍了简单的、用 mock 来模拟接口测试环境的方法,具体的使用样例我们再回顾一下:
1.首先是最简单的不需要传参的示例,需要注意的是,可能 @Resource 这个注解识别不了,没关系,换成 @Autowired 通常是等效的
//进行每一次 mock 模拟 tomcat 容器的时候,使用随机端口启动,这样不会有端口占用的问题 @SpringBootTest(classes = {Springboot01Application.class}, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)//自动配置以及启用 mvc 对象 @AutoConfigureMockMvcpublic class MockMVCTester {
//注入 MockMVC 对象,它是 springtest 依赖中自带的
@Resource
private MockMvc mockMvc;
@Test
public void testMock() throws Exception {
//获取 mock 返回的对象
MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/user"))//perform 模拟一个 http 请求,这里是 get 方法
.andExpect(MockMvcResultMatchers.status().isOk())//添加预期,如果服务器返回的是 200
.andDo(MockMvcResultHandlers.print())//那我们就把请求和响应的信息在控制台中打印输出
.andExpect(MockMvcResultMatchers.content().string("[{\"uid\":1001,\"uname\":\"wu\"," +
"\"password\":\"1212\",\"addrs\":[\"nanchang\",\"sichuan\",\"beijing\"]}," +
"{\"uid\":1002,\"uname\":\"du\",\"password\":\"1313\",\"addrs\"" +
":[\"chang\",\"sica\",\"beng\"]}]"))//content 表示对于返回的请求体数据进行判断,string 表示进行比对
.andReturn();//将结果返回出来
}}
2.如果 get 方法需要传参,通常是在 query 中(也就是问号传参的形式),也有可能是正常传参,而且这种通常有 json 返回,正常传参的示例如下(.param 也可以改为.params);如果是 query 传参,改用.queryparam 即可
@Test@DisplayName("get 方法+有入参+有 json 返回")public void testMock1() throws Exception {
//mock 返回的对象可以不获取,因为单纯的判断对错用不上
mockMvc.perform(MockMvcRequestBuilders.get("/user/para")//perform 模拟一个 http 请求,这里是 get 方法
.header("token", "akakak")//请求头
.param("id","wy")//请求参数
.param("password","asd"))//请求参数
.andExpect(MockMvcResultMatchers.status().isOk())//添加预期,如果服务器回的是 200
.andDo(MockMvcResultHandlers.print())//那我们就把请求和响应的信息在控制台中打印输出
.andExpect(MockMvcResultMatchers.jsonPath("ak").value("asd"))//获取返回的 json 并核对对应的值是否一样
.andReturn();//将结果返回出来}
3.最后就是 post 方法的常用 body 传参,一般都是 json 格式,示例如下;这里用到了 IoC 创建对象,不了解的读者可以看看我专栏的 IoC 相关分享
@Test@DisplayName("post 方法测试用例")public void testMock1() throws Exception {
//IoC
ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("IoC.xml");
User user = context.getBean(User.class);
ObjectMapper mapper = new ObjectMapper();
user.setUname("wy");
//mock 返回的对象可以不获取,因为单纯的判断对错用不上
mockMvc.perform(MockMvcRequestBuilders.post("/user")//perform 模拟一个 http 请求,这里是 get 方法
.content(mapper.writeValueAsString(user))//用 IoC 建立一个 User 对象
.contentType(MediaType.APPLICATION_JSON_VALUE))//添加 json 类数据,转化为入参
.andExpect(MockMvcResultMatchers.status().isOk())//添加预期,如果服务器回的是 200
.andDo(MockMvcResultHandlers.print())//那我们就把请求和响应的信息在控制台中打印输出
.andExpect(MockMvcResultMatchers.jsonPath("uname").value("wy"))//获取返回的 json 并核对对应的值是否一样
.andReturn();//将结果返回出来}
2 Mock 的进阶用法
当然了,Mock 不可能只有这些模拟接口的简单用法,本文就介绍一写些其他的常用模式
2.1 简便创建单元测试
如果你使用的 IDE 和我一样,是 IDEA,那么你可以通过在需要写单元测试的方法上 Ctrl+Shift+T 来快捷创建
之后你当然可以选择是否增加运行在测试之前的 @Before、运行在测试之后的 @After(即 Junit 的相关注解,在这里不赘述)
注:可以自行查阅 JUnit 文档:https://junit.org/junit5/docs/current/user-guide/
2.2 @Mock、@Spy、@InjectMocks
有的时候我们需要测试的单元——比如说某一个类,可能依赖于其他的类,而且这个被依赖的类往往不是很好构造,因为他们可能又依赖于其他的类、库、底层资源等等,这个时候 mock 就帮上了大忙:
1.创建测试用的类
同样我们来举例说明一下,假设我们有一个 UserInfo 类存储了用户信息,他长这个样子:
public class UserInfo {
private UserRepository userRepository;
private UserWord userWord;
public String getUserAddr(){
return userRepository.getUsrAddr();
}}
非常简单的一个 UserInfo 类,可以看到他依赖于两个子类,一个是用户数据库(UserRepository),一个是用户词(UserWord)
**都是随便编的哈不要在意**
这两个子类长这个样子:
@Datapublic class UserWord {
private String word1;
private String word2;}
@Datapublic class UserRepository {
private String repUUID;
private String usrPassword;
private String usrAddr = "Sichuan";}
也一样非常简单,但大家可以看到我们把 UserRepository 的 usrAddr 这个属性赋了一个默认值“Sichuan”,为什么呢?就是为了解释 @Spy 和 @Mock 的作用
2.几个重要注解的定义:
@Mock 非真实执行,用来模拟在测试中不好创建的类
@Spy 真实执行,用来模拟需要真实执行的类
@InjectMocks 真实执行,针对实现类使用,不能作用在接口上
大家可能看的一头雾水,但其实用我们刚刚的 UserInfo 示例来解释,就非常简单:
UserRepository 这个类,虽然在我们这里很简单,但我们把他当做一个数据库类来理解——也就是说,在真实开发中,这样的类在单元测试中是不好处理的,因为你不可能为了测试 UserInfo 这个类的方法,去专门建一个数据库,这个太麻烦了。
那么 @Mock 就起到了这么一个作用,他相当于给所注解的实例套了一个外壳,我们不用关心里面是怎么样的,系统将其全部设置为 null
相当于我们在单元测试的时候,不管 @Mock 所在的类究竟是什么样子,也不需要专门为了他去建数据库、建依赖。
这就是 Mock 的核心作用——依赖解耦,尤其是在单元测试中,我们要斩断复杂的类依赖关系,专心测试某一块的功能。
那么 @Spy 就很好理解了,有些我们需要用到其中功能的类,或者说比较简单的类,就用 @Spy 来注入,@Mock 和 @Spy 都是将实例注入到 @InjectMocks 所标注的地方,用一段测试代码来展示这一点:
@SpringBootTest(classes = {Springboot01Application.class}, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)public class MockTest2 {
@Mock
private UserRepository userRepository;
@Spy
private UserWord userWord;
@InjectMocks
private UserInfo userInfo;
@Test
public void test1(){
Assertions.assertEquals("Sichuan",userInfo.getUserAddr());
}}
可以看到,我们并没有专门创建 UserInfo 的子类,而是直接用了注入的办法;这其实跟 Spring 本身的 @Component+@Autowired 的方法有点类似,
这里如果去运行 test1,是不会通过的;因为 UserRepository 使用 @Mock 来注入的,里面的东西都是 null,如果改成 @Spy,测试就可以通过了。
2.3 桩
有一种情况:UserRepository 不好创建所以我们用 Mock 模拟一个,但万一我还是想要用里面的某个方法呢?万一 UserInfo 的某个方法依赖于 UserRepository 的某一个方法的返回呢?这种情况我显然不能再返回 null 了,所以“桩”就用在了这种情况:
桩函数(stub):使用一些自己定义的测试函数来替换当前需要测试的函数。被替换的函数可能是目前还没写完的,这样能够加速开发,或更好的找错误源。
打桩(存根):模拟要调用的函数(打桩对象),给它提供桩函数,给桩函数返回一个值。简单的说自定义输入输出,不打桩默认返回 null。
也就是说,我可以让 UserRepository 去打桩来返回一个我需要的值!!!
这样一来就非常方便了,举一个非常常用且经典的例子:
@Test
public void test1(){
Mockito.when(userRepository.getUsrAddr()).thenReturn("Beijing");
Assertions.assertEquals("Beijing",userInfo.getUserAddr());
}
可以看到,新的 test1 如上,when...thenReturn 方法设置了这个 Mock 对象的方法被调用的时候应该返回一个什么样的值,即我们自定义了 Mock 方法的出入参(当然了这里没有入参),这个测试案例是可以通过的,因为方法被调用的时候不再返回默认值 null 了
when...thenReturn 就是我们的桩函数,
Mockito.when(userRepository.getUsrAddr()).thenReturn("Beijing");就是我们的打桩过程
实际上 Mockito 库有很多方法可以供我们调用,即使是 @Spy 注入的类也可以使用,大家可以自行去查手册,或者参考下表:
3 Mock 也有解决不了的情况
很多开发都会接触到 Linux 系统,如果有些功能是给 Linux 写的,集成测试、系统测试就需要去搭建一套测试环境,但怎么去做单元测试呢?单元测试就应该尽可能的简单和全面,搭建一套这个环境也太麻烦了吧
没办法这次还真得搭,Mock 也模拟不了虚拟机
我们是可以在 IDEA 中借用一些 xshell 来使用 bash 命令,但真正要跑测试,比较方便的还是自己搭一台虚拟机出来,如果有不熟悉的可以关注我的 Linux 专栏,有搭建虚拟机的经验分享。
搭建并配网好了之后需要给虚拟机安装 Java,这个过程就比较简单了,贴个链接的大家可以参考:https://blog.csdn.net/wcy1900353090/article/details/125121855
安装好了之后就可以按如下流程用 IDEA 链接虚拟机进行测试:
评论