Spring Boot 3.x Web单元测试最佳实践

上一篇：Spring Boot 3.x Rest API统一异常处理最佳实践

下一篇：Spring Boot 3.x Filter实战：记录请求日志

Spring Boot为我们提供了非常便捷的web层Rest API单元测试的API，这种开发能力也是小伙伴必须要掌握的。如何对数据库、中间件服务以及远程调用在开发环境不可使用的情况进行Rest API功能测试，本教程将为小伙伴揭秘。如果觉得对你有帮助，记得点赞收藏，关注小卷，后续更精彩！

依赖与配置

接下来我们通过web单元测试来对之前开发好的API进行测试，先看下build.gradle中跟单元测试相关的配置：

dependencies {
   
    ...
    // 为单元测试环境引入和启用lombok编译功能
    testAnnotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
    ...
}

tasks.named('test') {
   
    useJUnitPlatform()
}

创建单元测试

创建单元测试的方式，在API接口上使用组合键Alt+Enter（这里对idea使用eclipse风格的快捷键），比如：

点击创建Test，选择默认的junit5单元测试框架，并选择要测试的方法，点创建：

mock mvc测试

看下面的单元测试结构：

package com.juan.demo.api;

import ...

import static org.junit.jupiter.api.Assertions.*;

@WebMvcTest(CartAPI.class)
class CartAPITest {
   

    @Resource
    private MockMvc mvc;

    @Test
    void addCartItem() {
   
        assertNotNull(mvc);
    }
}

我们在类的头部使用@WebMvcTest注解，表明要启动一个web测试的应用模拟环境，也就是说并不会启动一个spring boot应用的真正上下文环境，对于需要注入的组件需要额外mock出来，直接运行以上单元测试用例，得到这样的错误：

...
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.juan.demo.service.CartService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@jakarta.annotation.Resource(shareable=true, lookup="", name="", description="", authenticationType=CONTAINER, type=java.lang.Object.class, mappedName="")}
...

@MockBean注解

为此，我们可以通过@MockBean注解来注入一个模拟实现的CartService组件：

...
class CartAPITest {
   
    ...
    
    @MockBean
    private CartService cartService;
    
    ...
}

这样再启动单元测试，执行结果绿条，我们就模拟出了要测试的API的web环境，并对其依赖的后台组件进行模拟注入，以确保模拟上下文可以正常进行依赖注入。但是需要注意：对哪些API接口启动模拟测试环境是由@WebMvcTest注解控制的，默认是所有的API，也可以指定（这里我们指定API接口即可），比如这里我们指定的是CartAPI，而如果我们指定成@WebMvcTest(HelloAPI.class)，则很显然，环境依赖更简单（无需用@@MockBean注解注入任何模拟依赖）。

动一动小手

小伙伴们可以按照上述注意事项，自行做实验来验证结论。

执行请求发送

环境启动ok，有了模拟mvc的MockMvc实例之后，就可以在启动的web模拟环境中借助MockMvc实例来发送和测试API请求了。看下测试用例：

package com.juan.demo.api;

import ...

import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(CartAPI.class)
class CartAPITest {
   

    @Resource
    private MockMvc mvc;

    @MockBean
    private CartService cartService;

    @SneakyThrows
    @Test
    void addCartItem() {
   
        assertNotNull(mvc);

        this.mvc.perform(post("/personal/cart")
                        .accept(MediaType.APPLICATION_JSON_VALUE)
                        .contentType(MediaType.APPLICATION_JSON_VALUE)
                        .content("{\"p\":2,\"q\":4}"))
                .andExpect(status().