SpringBootMockMvc发送JSON请求体方法

最近发现不少小伙伴都对文章很感兴趣，所以今天继续给大家介绍文章相关的知识，本文《Spring Boot MockMvc传JSON请求体方法》主要内容涉及到等等知识点，希望能帮到你！当然如果阅读本文时存在不同想法，可以在评论中表达，但是请勿使用过激的措辞~

本文详细介绍了在Spring Boot应用中，如何使用MockMvc对接收JSON请求体的REST接口进行单元测试。核心步骤包括创建数据传输对象（DTO），利用Jackson的ObjectMapper将其转换为JSON字符串，并通过MockMvc的contentType()和content()方法将JSON数据作为请求体发送，确保测试的准确性和有效性。

核心概念：MockMvc与JSON请求

在Spring Boot应用开发中，RESTful API是常见的交互方式。当我们需要测试一个接收JSON格式请求体的API端点时，MockMvc是Spring Framework提供的一个强大工具，它允许我们在不启动完整HTTP服务器的情况下，对Spring MVC控制器进行端到端（但不涉及网络）的测试。

对于接收JSON请求的API，通常会在控制器方法参数前使用@RequestBody注解，例如：

@PostMapping(value = "/addItemIntoCart", consumes = {"application/json"})
public ResponseEntity<String> addItemToCart(@RequestBody CartDto cartDto) {
   // 业务逻辑处理 cartDto
   return ResponseEntity.ok("Item added successfully");
}

这里，@RequestBody CartDto cartDto表示Spring会自动将传入的JSON请求体反序列化为CartDto对象。因此，在MockMvc测试中，我们需要模拟这一过程，即构造一个JSON字符串并将其作为请求体发送。

准备工作：引入依赖与数据模型

为了在测试中处理JSON，我们需要确保项目中包含了Jackson库。Spring Boot通常会默认引入，但如果需要手动添加，可以检查pom.xml：

<!-- Spring Boot Web Starter通常已包含Jackson -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 或单独引入Jackson -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>

接下来，定义用于请求体的数据传输对象（DTO），例如CartDto：

// CartDto.java
public class CartDto {
    private String itemId;
    private int quantity;

    // 构造函数
    public CartDto() {}

    public CartDto(String itemId, int quantity) {
        this.itemId = itemId;
        this.quantity = quantity;
    }

    // Getter和Setter方法
    public String getItemId() {
        return itemId;
    }

    public void setItemId(String itemId) {
        this.itemId = itemId;
    }

    public int getQuantity() {
        return quantity;
    }

    public void setQuantity(int quantity) {
        this.quantity = quantity;
    }
}

实战：构建MockMvc请求并传递JSON对象

在MockMvc测试中向API传递JSON对象，主要分为以下三个步骤：

步骤一：创建待发送的数据对象

首先，实例化你想要作为请求体发送的DTO对象，并设置其属性。

CartDto cartDto = new CartDto("item123", 2);

步骤二：将对象转换为JSON字符串

使用Jackson库提供的ObjectMapper将Java对象转换为JSON字符串。在Spring Boot的测试环境中，ObjectMapper通常会被自动配置并可以被@Autowired注入。

import com.fasterxml.jackson.databind.ObjectMapper;
// ...

// 在测试类中注入ObjectMapper
@Autowired
private ObjectMapper objectMapper;

// ...

// 在测试方法中将对象转换为JSON字符串
String jsonRequest = objectMapper.writeValueAsString(cartDto);

objectMapper.writeValueAsString()方法会负责将cartDto对象序列化为符合JSON规范的字符串。

步骤三：构建MockMvc请求并发送

在构建MockMvc请求时，需要使用contentType()方法指定请求的MIME类型为application/json，并使用content()方法将上一步生成的JSON字符串作为请求体发送。

import org.springframework.http.MediaType;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
// ...

mockMvc.perform(post("/user/addItemIntoCart") // 指定请求路径和HTTP方法
        .contentType(MediaType.APPLICATION_JSON) // 设置Content-Type头部为application/json
        .content(jsonRequest)) // 将JSON字符串作为请求体
        .andExpect(status().isOk()); // 期望HTTP状态码为200 OK

完整示例代码

下面是一个完整的MockMvc测试类示例，展示了如何测试上述的addItemToCart控制器方法：

import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;

// 假设你的控制器类名为 CartController
@WebMvcTest(CartController.class)
public class CartControllerTest {

    @Autowired
    private MockMvc mockMvc; // 注入MockMvc实例

    @Autowired
    private ObjectMapper objectMapper; // 注入ObjectMapper，用于JSON序列化/反序列化

    // 如果你的控制器依赖于服务层，需要Mock该服务
    @MockBean
    private CartService cartService; // 假设CartController依赖于CartService

    // 可选：在每个测试方法执行前进行一些通用设置
    @BeforeEach
    void setUp() {
        // 例如，重置Mock对象的行为
        // Mockito.reset(cartService);
    }

    @Test
    void testAddItemIntoCart_Success() throws Exception {
        // 1. 创建待发送的CartDto对象
        CartDto cartDto = new CartDto("item123", 2);

        // 2. 将CartDto对象转换为JSON字符串
        String jsonRequest = objectMapper.writeValueAsString(cartDto);

        // 3. 模拟cartService的行为（如果控制器会调用服务）
        // 当cartService.addItemIntoCart被调用时，返回一个成功的ResponseEntity
        when(cartService.addItemIntoCart(any(CartDto.class)))
              .thenReturn(ResponseEntity.ok("Item added successfully"));

        // 4. 构建并执行MockMvc请求
        mockMvc.perform(post("/user/addItemIntoCart")
                .contentType(MediaType.APPLICATION_JSON) // 设置请求头Content-Type
                .content(jsonRequest)) // 设置请求体为JSON字符串
                .andExpect(status().isOk()); // 验证HTTP状态码是否为200 OK
    }

    @Test
    void testAddItemIntoCart_BadRequest() throws Exception {
        // 示例：测试无效输入（例如，如果quantity不能为负数，但DTO中未包含验证逻辑）
        // 这里仅作示例，实际应根据DTO的验证规则来构造无效JSON
        CartDto invalidCartDto = new CartDto("item456", -1); // 假设-1是无效数量
        String invalidJsonRequest = objectMapper.writeValueAsString(invalidCartDto);

        // 模拟服务层可能抛出异常或返回错误状态（如果控制器有处理）
        // 或者，如果控制器有@Valid注解，这里可能直接返回400 BAD_REQUEST
        when(cartService.addItemIntoCart(any(CartDto.class)))
              .thenReturn(ResponseEntity.badRequest().body("Invalid quantity"));

        mockMvc.perform(post("/user/addItemIntoCart")
                .contentType(MediaType.APPLICATION_JSON)
                .content(invalidJsonRequest))
                .andExpect(status().isBadRequest()); // 期望HTTP状态码为400 Bad Request
    }
}

注意事项

1. ObjectMapper配置： ObjectMapper提供了丰富的配置选项，例如日期格式、空值处理、未知属性忽略等。如果你的DTO或JSON有特殊格式要求，可以通过配置ObjectMapper来满足。在@WebMvcTest或@SpringBootTest中，Spring Boot会自动配置一个默认的ObjectMapper实例，通常足以满足大部分需求。
2. MediaType的准确性： 确保contentType()中使用的MediaType与控制器方法@PostMapping或@PutMapping中consumes属性声明的类型一致，通常是MediaType.APPLICATION_JSON。
3. 服务层Mocking： 当使用@WebMvcTest进行测试时，它只会加载与Web层相关的组件。因此，如果你的控制器依赖于服务层（Service）或其他组件，你需要使用@MockBean来模拟这些依赖，以隔离测试范围，专注于控制器逻辑。
4. JSON字符串的复杂性： 对于更复杂的JSON结构（如嵌套对象、数组），ObjectMapper也能很好地处理。只需构造对应的Java对象层次结构即可。
5. 异常处理： 在实际应用中，JSON解析失败（如请求体格式错误）或业务逻辑验证失败都可能导致异常。在测试中，也应覆盖这些场景，验证控制器是否返回了预期的错误状态码和错误信息。

总结

通过上述步骤，我们可以有效地在Spring Boot中使用MockMvc对接收JSON请求体的RESTful API进行单元测试。关键在于利用ObjectMapper将Java对象转换为JSON字符串，并通过MockMvcRequestBuilders的contentType()和content()方法将JSON数据作为请求体发送。这种测试方法能够确保API接口在接收到正确格式的JSON数据时，能够按照预期进行处理，从而提高代码质量和可靠性。

好了，本文到此结束，带大家了解了《SpringBootMockMvc发送JSON请求体方法》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！