
本文详解 Spring Boot 单元测试中因 Mockito 参数匹配失败导致 ResponseEntity 返回空 JSON 的根本原因,并提供基于 ArgumentMatchers.any() 的标准修复方案,同时澄清 @JsonProperty(access = Access.WRITE_ONLY/READ_ONLY) 在序列化中的正确行为。
本文详解 spring boot 单元测试中因 mockito 参数匹配失败导致 `responseentity` 返回空 json 的根本原因,并提供基于 `argumentmatchers.any()` 的标准修复方案,同时澄清 `@jsonproperty(access = access.write_only/read_only)` 在序列化中的正确行为。
在 Spring Boot 单元测试中,使用 MockMvc 调用 @PutMapping 接口时返回空响应(如 ""),而非预期的 JSON(如 {"balance":3000.0}),通常并非 JSON 序列化配置问题,而是 Mockito 方法存根(stubbing)未成功触发 所致——即被测控制器实际调用的 userService.updateUserBalance(...) 并未命中你预设的 when(...).thenReturn(...) 规则,从而返回 null,最终 ResponseEntity 包裹 null 对象,Jackson 序列化后生成空字符串。
根本原因在于:对象引用不匹配。
你在测试中创建了 userAmountDTO = new UserAmountDTO(2000.0, 3000.0),并在 when(...) 中使用该实例作为参数进行存根。但控制器内部接收的是由 @RequestBody 反序列化生成的 全新对象实例(内存地址不同),即使字段值完全相同,Mockito 默认的 equals() 匹配(基于引用或未重写 equals() 的类)也会失败。UserAmountDTO 未重写 equals() 和 hashCode(),因此两个字段相同的实例被视为“不相等”,导致 when(...) 不生效,userService.updateUserBalance() 实际返回 null。
✅ 正确修复方式是使用 Mockito 的参数匹配器(Argument Matcher),忽略具体实例差异,仅关注类型和逻辑语义:
@Test
public void Test_DepositUserBalance() throws Exception {
// Arrange
UserAmountDTO expectedResponse = new UserAmountDTO(2000.0, 3000.0); // 注意:此对象仅用于定义返回值
HttpServletRequest request = mock(HttpServletRequest.class);
when(request.getAttribute("userId")).thenReturn(1);
// ✅ 关键修复:使用 ArgumentMatchers.any() 匹配任意 UserAmountDTO 实例
when(userService.updateUserBalance(eq(1), any(UserAmountDTO.class)))
.thenReturn(expectedResponse);
String requestBody = objectMapper.writeValueAsString(
new UserAmountDTO(2000.0, 0.0) // 请求体只需含 WRITE_ONLY 字段(amount)
);
System.out.println("Request body: " + requestBody); // 输出: {"amount":2000.0}
// Act
MvcResult mvcResult = mockMvc.perform(put(DEPOSIT_PATH)
.contentType(MediaType.APPLICATION_JSON)
.content(requestBody)
.sessionAttr("userId", 1)) // 更推荐使用 sessionAttr 或自定义 RequestPostProcessor
.andExpect(status().isOk())
.andReturn();
// Assert
String content = mvcResult.getResponse().getContentAsString();
// 预期响应只含 READ_ONLY 字段 balance(因 amount 是 WRITE_ONLY,不参与序列化输出)
String expectedJson = "{\"balance\":3000.0}";
assertEquals(expectedJson, content);
}
? 关键要点说明:
- @JsonProperty(access = Access.WRITE_ONLY) 作用于 amount:该字段仅接受请求 JSON 输入,不参与响应序列化输出;
- @JsonProperty(access = Access.READ_ONLY) 作用于 balance:该字段仅出现在响应 JSON 中,不可通过请求设置;
- 因此,requestBody 正确打印为 {"amount":2000.0}(符合预期),而 response 应为 {"balance":3000.0};
- 使用 any(UserAmountDTO.class) 后,无论控制器传入哪个 UserAmountDTO 实例,只要参数类型匹配,存根即生效;
- 补充建议:避免直接 mock HttpServletRequest 设置 attribute,改用 MockMvcRequestBuilders 提供的 .sessionAttr() 或自定义 RequestPostProcessor,更符合测试最佳实践。
总结:REST 控制器单元测试中 JSON 响应为空,90% 源于服务层 mock 未命中。务必检查参数匹配逻辑——对 DTO 类型,优先使用 any(Class) 而非具体实例,辅以合理的 Jackson 注解语义理解,即可快速定位并解决此类“神秘空响应”问题。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南











