核心方法：对象到 JSON 的转换与请求构建
在 Spring Boot 中，当控制器层的 RESTful API 接口接收 @RequestBody 注解修饰的 Java 对象作为请求体参数时，客户端通常会发送 JSON 格式的数据。为了在 MockMvc 测试中模拟这种行为，我们需要遵循以下两个核心步骤：
- 对象序列化： 将要作为请求体发送的 Java 对象（例如数据传输对象 DTO）转换为 JSON 格式的字符串。这通常通过 Jackson 库提供的 ObjectMapper 类来实现。
- 请求体附加： 在构建 MockMvcRequest 时，使用 contentType() 方法指定请求的内容类型为 application/json，并使用 content() 方法将序列化后的 JSON 字符串作为请求体附加进去。
实战示例
下面通过一个具体的示例来演示如何在 MockMvc 测试中传递对象作为请求体参数。
1. 定义数据传输对象 (DTO)
首先，我们定义一个简单的 CartDto 类，它将作为请求体被发送。
// src/main/java/com/example/demo/dto/CartDto.java
package com.example.demo.dto;
import java.util.Objects;
public class CartDto {
private String itemId;
private int quantity;
public CartDto() {
}
public CartDto(String itemId, int quantity) {
this.itemId = itemId;
this.quantity = quantity;
}
// Getters and Setters
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;
}
@Override
public String toString() {
return "CartDto{" +
"itemId='" + itemId + '\'' +
", quantity=" + quantity +
'}';
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CartDto cartDto = (CartDto) o;
return quantity == cartDto.quantity && Objects.equals(itemId, cartDto.itemId);
}
@Override
public int hashCode() {
return Objects.hash(itemId, quantity);
}
}2. 控制器层接口
接着，定义一个接收 CartDto 作为请求体参数的 RESTful 控制器接口。
// src/main/java/com/example/demo/controller/UserController.java
package com.example.demo.controller;
import com.example.demo.dto.CartDto;
import com.example.demo.service.CartService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/user")
public class UserController {
// 假设 CartService 处理业务逻辑
@Autowired
private CartService cartService;
@PostMapping(value = "/addItemIntoCart", consumes = {"application/json"})
public ResponseEntity<String> addItemToCart(@RequestBody CartDto cartDto) {
System.out.println("Received CartDto: " + cartDto);
// 调用服务层处理业务逻辑
String result = cartService.addItemIntoCart(cartDto);
return ResponseEntity.ok(result);
}
}3. MockMvc 测试实现
最后，编写 MockMvc 测试类，演示如何传递 CartDto 对象。
// src/test/java/com/example/demo/controller/UserControllerTest.java
package com.example.demo.controller;
import com.example.demo.dto.CartDto;
import com.example.demo.service.CartService;
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.test.web.servlet.MockMvc;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@WebMvcTest(UserController.class) // 专注于测试 Web 层，不加载完整的 Spring 应用上下文
public class UserControllerTest {
@Autowired
private MockMvc mockMvc; // MockMvc 实例，用于执行模拟请求
@MockBean // 模拟 CartService，避免加载实际的业务逻辑和数据库依赖
private CartService cartService;
private ObjectMapper objectMapper; // 用于对象和 JSON 之间的转换
@BeforeEach // JUnit 5 的 @BeforeEach，JUnit 4 对应 @Before
void setUp() {
objectMapper = new ObjectMapper(); // 初始化 ObjectMapper
// 如果需要，可以在此处配置 ObjectMapper，例如禁用日期时间戳等
}
@Test
void testAddItemIntoCart() throws Exception {
// 1. 创建要作为请求体发送的 DTO 对象
CartDto cartDto = new CartDto("PROD-001", 3);
// 2. 使用 ObjectMapper 将 DTO 对象转换为 JSON 字符串
String cartDtoJson = objectMapper.writeValueAsString(cartDto);
// 3. 模拟 CartService 的行为，当调用 addItemIntoCart 时返回指定字符串
when(cartService.addItemIntoCart(any(CartDto.class))).thenReturn("Item PROD-001 added to cart successfully.");
// 4. 执行 MockMvc 请求
mockMvc.perform(post("/user/addItemIntoCart") // 指定 POST 请求和 URL
.contentType(MediaType.APPLICATION_JSON) // 设置请求的 Content-Type 为 JSON
.content(cartDtoJson)) // 将 JSON 字符串作为请求体内容
.andExpect(status().isOk()) // 验证 HTTP 状态码是否为 200 OK
.andExpect(content().string("Item PROD-001 added to cart successfully.")) // 验证响应体内容
.andReturn(); // 获取 MvcResult，如果需要进一步的断言
}
}关键组件解析
ObjectMapper 的作用：ObjectMapper 是 Jackson 库的核心类，用于在 Java 对象和 JSON 数据之间进行序列化（Java 对象 -> JSON 字符串）和反序列化（JSON 字符串 -> Java 对象）。在 MockMvc 测试中，我们利用它的 writeValueAsString() 方法将 Java 对象转换为 JSON 字符串，以便作为请求体发送。
MediaType.APPLICATION_JSON 的重要性：MediaType.APPLICATION_JSON 是 Spring Framework 提供的一个常量，代表 application/json MIME 类型。在 mockMvc.perform() 调用中，通过 contentType(MediaType.APPLICATION_JSON) 设置请求头，明确告知服务器请求体是 JSON 格式。这对于 Spring MVC 框架正确地识别并使用 HttpMessageConverter（如 Jackson 的 MappingJackson2HttpMessageConverter）将 JSON 请求体反序列化为 @RequestBody 注解的 Java 对象至关重要。
注意事项与最佳实践
-
依赖管理： 确保项目中已引入 Jackson 库的依赖。对于 Spring Boot 项目，通常 spring-boot-starter-web 会自动引入 Jackson。
<!-- Maven --> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> </dependency> -
测试注解选择：
- @WebMvcTest(Controller.class)：推荐用于仅测试 Web 层（Controller、Filter、Interceptor等）的场景。它只会加载与 Web 层相关的 Spring Bean，并自动配置 MockMvc。对于控制器依赖的服务层组件，需要使用 @MockBean 进行模拟。
- @SpringBootTest 结合 @AutoConfigureMockMvc：用于进行更全面的集成测试，会加载完整的 Spring 应用上下文。当需要测试控制器与服务层、数据访问层等多个组件的集成时使用。
- ObjectMapper 配置： 如果你的 DTO 对象包含日期、枚举或其他特殊类型，或者有特定的序列化/反序列化需求，你可能需要对 ObjectMapper 进行额外的配置，例如设置日期格式、禁用未知属性失败等。
- 其他 HTTP 方法： 类似地，对于 PUT 请求，也可以使用 MockMvcRequestBuilders.put() 并结合 contentType() 和 content() 来传递请求体对象。对于 GET 请求，请求体通常不用于传递复杂对象，参数一般通过 URL 参数或路径变量传递。
- 断言丰富性： 除了验证 HTTP 状态码 (status().isOk()) 和响应内容 (content().string())，还可以使用 jsonPath() 来验证 JSON 响应体的特定字段，或使用 header() 验证响应头等。
总结
在 Spring Boot 的 MockMvc 测试中，向带有 @RequestBody 注解的控制器方法传递 Java 对象参数的关键在于：利用 ObjectMapper 将对象序列化为 JSON 字符串，并通过 MockMvcRequestBuilders 的 contentType(MediaType.APPLICATION_JSON) 和 content(jsonString) 方法将其附加到模拟请求中。掌握这一技巧，能有效提升 RESTful API 接口的测试覆盖率和质量，确保应用的数据绑定和业务逻辑的正确性。
