
在 Spring Boot 中,当控制器层的 RESTful API 接口接收 @RequestBody 注解修饰的 Java 对象作为请求体参数时,客户端通常会发送 JSON 格式的数据。为了在 MockMvc 测试中模拟这种行为,我们需要遵循以下两个核心步骤:
下面通过一个具体的示例来演示如何在 MockMvc 测试中传递对象作为请求体参数。
首先,我们定义一个简单的 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);
}
}接着,定义一个接收 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);
}
}最后,编写 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 对象至关重要。
<!-- Maven -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>在 Spring Boot 的 MockMvc 测试中,向带有 @RequestBody 注解的控制器方法传递 Java 对象参数的关键在于:利用 ObjectMapper 将对象序列化为 JSON 字符串,并通过 MockMvcRequestBuilders 的 contentType(MediaType.APPLICATION_JSON) 和 content(jsonString) 方法将其附加到模拟请求中。掌握这一技巧,能有效提升 RESTful API 接口的测试覆盖率和质量,确保应用的数据绑定和业务逻辑的正确性。
以上就是Spring Boot MockMvc 测试中如何传递请求体对象?的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号