# 单元测试 ExceptionHandler 和 ControllerAdvice ## 概述此技能提供了使用 MockMvc 单元测试 @ExceptionHandler 方法和 @ControllerAdvice 类的模式。它涵盖测试异常到错误响应转换、HTTP 状态代码、错误消息格式、验证错误处理和自定义权限评估器，而无需完整的集成测试开销。 ## 何时使用在以下情况下使用此技能： * 在@ControllerAdvice中测试@ExceptionHandler方法 * 测试异常到错误响应的转换 * 验证不同异常类型的HTTP状态代码 * 测试错误消息格式和本地化 * 想要快速的异常处理程序测试而不需要完整的集成测试 ## 说明 1. **创建测试控制器** ：创建简单的测试控制器，抛出异常以测试处理程序行为 2. **注册ControllerAdvice** ：构建MockMvc时使用`setControllerAdvice()`来注册异常处理程序 3. **测试所有异常类型** ：验证每个@ExceptionHandler方法处理其特定的异常类型 4. **验证HTTP状态代码** ：使用@ResponseStatus断言来验证正确的状态代码 5. **测试错误响应结构**：验证错误响应包含所有必填字段（时间戳、状态、错误、消息） 6. **测试验证错误**：验证MethodArgumentNotValidException产生字段级错误详细信息 7. **测试日志记录和副作用**：验证异常处理程序记录错误或执行其他副作用 8. **使用模拟控制器** ：从模拟控制器抛出异常以触发异常处理程序 ## 示例 ## 设置：异常处理程序测试 ### Maven <依赖关系> org.springframework.boot spring-boot-starter-web <依赖关系> org.springframework.boot spring-boot-starter-test <范围>测试 <依赖关系> org.assertj assertj-core <范围>测试 ### 摇篮依赖项{ 实现（“org.springframework.boot：spring-boot-starter-web”） testImplementation("org.springframework.boot:spring-boot-starter-test") testImplementation("org.assertj:assertj-core") } ## 基本模式：全局异常处理程序 ### 创建异常处理程序 // 全局异常处理程序 @ControllerAdvice 公共类 GlobalExceptionHandler { @ExceptionHandler(ResourceNotFoundException.class) @ResponseStatus(HttpStatus.NOT_FOUND) 公共ErrorResponsehandleResourceNotFound（ResourceNotFoundException ex）{ 返回新的错误响应（ HttpStatus.NOT_FOUND.value(), “找不到资源”，例如：getMessage() ）； } @ExceptionHandler(ValidationException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) 公共ErrorResponsehandleValidationException（ValidationException ex）{ 返回新的错误响应（ HttpStatus.BAD_REQUEST.value(), “验证失败”，例如：getMessage() ）； } } // 错误响应DTO 公共记录错误响应（整数状态，字符串错误，字符串消息）{} ### 单元测试异常处理程序导入 org.junit.jupiter.api.Test; 导入 org.junit.jupiter.api.extension.ExtendWith; 导入 org.mockito.InjectMocks; 导入 org.mockito.junit.jupiter.MockitoExtension; 导入 org.springframework.test.web.servlet.MockMvc; 导入 org.springframework.test.web.servlet.setup.MockMvcBuilders; 导入静态org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; 导入静态org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; @ExtendWith(MockitoExtension.class) 类 GlobalExceptionHandlerTest { @InjectMocks 私有 GlobalExceptionHandler 异常处理程序；私人 MockMvc 模拟Mvc； @BeforeEach 无效设置（）{ 模拟Mvc = MockMvcBuilders .standaloneSetup(new TestController()) .setControllerAdvice(异常处理程序) .build(); } @测试 void shouldReturnNotFoundWhenResourceNotFoundException() 抛出异常 { mockMvc.perform(get("/api/users/999")) .andExpect(状态().isNotFound()) .andExpect(jsonPath("$.status").value(404)) .andExpect(jsonPath("$.error").value("找不到资源")) .andExpect(jsonPath("$.message").value("未找到用户")); } @测试 void shouldReturnBadRequestWhenValidationException() 抛出异常 { mockMvc.perform(post("/api/users") .contentType(“应用程序/json”) .content("{\"名称\":\"\"}")) .andExpect(status().isBadRequest()) .andExpect(jsonPath("$.status").value(400)) .andExpect(jsonPath("$.error").value("验证失败")); } } // 测试抛出异常的控制器 @RestController @RequestMapping("/api") 类测试控制器{ @GetMapping("/users/{id}") 公共用户 getUser(@PathVariable Long id) { 抛出新的ResourceNotFoundException（“找不到用户”）； } } ## 测试多种异常类型 ### 处理各种异常类型 @ControllerAdvice 公共类 GlobalExceptionHandler { @ExceptionHandler(ResourceNotFoundException.class) @ResponseStatus(HttpStatus.NOT_FOUND) 公共ErrorResponsehandleResourceNotFound（ResourceNotFoundException ex）{ 返回新的 ErrorResponse(404, "未找到", ex.getMessage()); } @ExceptionHandler(DuplicateResourceException.class) @ResponseStatus(HttpStatus.CONFLICT) 公共ErrorResponsehandleDuplicateResource（DuplicateResourceException ex）{ 返回新的 ErrorResponse(409, "冲突", ex.getMessage()); } @ExceptionHandler(UnauthorizedException.class) @ResponseStatus(HttpStatus.UNAUTHORIZED) 公共ErrorResponsehandleUnauthorized（UnauthorizedException ex）{ 返回新的 ErrorResponse(401, "未经授权", ex.getMessage()); } @ExceptionHandler(AccessDeniedException.class) @ResponseStatus(HttpStatus.FORBIDDEN) 公共ErrorResponsehandleAccessDenied（AccessDeniedException ex）{ 返回新的 ErrorResponse(403, "Forbidden", ex.getMessage()); } @ExceptionHandler(Exception.class) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 公共ErrorResponsehandleGenericException（异常前）{ return new ErrorResponse(500, "内部服务器错误", "发生意外错误"); } } 类 MultiExceptionHandlerTest { 私人 MockMvc 模拟Mvc；私有 GlobalExceptionHandler 处理程序； @BeforeEach 无效设置（）{ 处理程序 = new GlobalExceptionHandler(); 模拟Mvc = MockMvcBuilders .standaloneSetup(new TestController()) .setControllerAdvice(处理程序) .build(); } @测试 void shouldReturn404ForNotFound() 抛出异常 { mockMvc.perform(get("/api/users/999")) .andExpect(状态().isNotFound()) .andExpect(jsonPath("$.status").value(404)); } @测试 void shouldReturn409ForDuplicate() 抛出异常 { mockMvc.perform(post("/api/users") .contentType(“应用程序/json”) .content("{\"电子邮件\":\"现有@example.com\"}")) .andExpect(status().isConflict()) .andExpect(jsonPath("$.status").value(409)); } @测试 void shouldReturn401ForUnauthorized() 抛出异常 { mockMvc.perform(get("/api/admin/dashboard")) .andExpect(status().isUnauthorized()) .andExpect(jsonPath("$.status").value(401)); } @测试 void shouldReturn403ForAccessDenied() 抛出异常 { mockMvc.perform(get("/api/admin/users")) .andExpect(status().isForbidden()) .andExpect(jsonPath("$.status").value(403)); } @测试 void shouldReturn500ForGenericException() 抛出异常 { mockMvc.perform(get("/api/error")) .andExpect(status().isInternalServerError()) .andExpect(jsonPath("$.status").value(500)); } } ## 测试错误响应结构 ### 验证错误响应格式 @ControllerAdvice 公共类 GlobalExceptionHandler { @ExceptionHandler(BadRequestException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) 公共 ResponseEntity handleBadRequest(BadRequestException ex) { 错误详细信息 = 新的错误详细信息( System.currentTimeMillis(), HttpStatus.BAD_REQUEST.value(), “错误的请求”，例如.getMessage(), 新日期() ）；返回新的 ResponseEntity<>(详细信息, HttpStatus.BAD_REQUEST); } } 类错误响应结构测试{ 私人 MockMvc 模拟Mvc； @BeforeEach 无效设置（）{ 模拟Mvc = MockMvcBuilders .standaloneSetup(new TestController()) .setControllerAdvice(new GlobalExceptionHandler()) .build(); } @测试 void shouldInincludeTimestampInErrorResponse() 抛出异常 { mockMvc.perform(post("/api/data") .contentType(“应用程序/json”) .内容(“{}”)) .andExpect(status().isBadRequest()) .andExpect(jsonPath("$.timestamp").exists()) .andExpect(jsonPath("$.status").value(400)) .andExpect(jsonPath("$.error").value("错误请求")) .andExpect(jsonPath("$.message").exists()) .andExpect(jsonPath("$.date").exists()); } @测试 void shouldInincludeAllRequiredErrorFields() 抛出异常 { MvcResult 结果 = mockMvc.perform(get("/api/invalid")) .andExpect(status().isBadRequest()) .andReturn(); 字符串响应 = result.getResponse().getContentAsString(); assertThat(response).contains(“时间戳”); 断言（响应）。包含（“状态”）； assertThat(response).contains(“错误”); assertThat(response).contains(“消息”); } } ## 测试验证错误处理 ### 处理 MethodArgumentNotValidException @ControllerAdvice 公共类 GlobalExceptionHandler { @ExceptionHandler(MethodArgumentNotValidException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) 公共验证错误响应处理验证异常（ MethodArgumentNotValidException ex) { Map 错误 = new HashMap<>(); ex.getBindingResult().getFieldErrors().forEach(错误 -> 错误.put(错误.getField(), 错误.getDefaultMessage()) ）；返回新的验证错误响应（ HttpStatus.BAD_REQUEST.value(), “验证失败”，错误）； } } 类 ValidationExceptionHandlerTest { 私人 MockMvc 模拟Mvc； @BeforeEach 无效设置（）{ 模拟Mvc = MockMvcBuilders .standaloneSetup(new UserController()) .setControllerAdvice(new GlobalExceptionHandler()) .build(); } @测试 void shouldReturnValidationErrorsForInvalidInput() 抛出异常 { mockMvc.perform(post("/api/users") .contentType(“应用程序/json”) .content("{\"姓名\":\"\",\"年龄\":-5}")) .andExpect(status().isBadRequest()) .andExpect(jsonPath("$.status").value(400)) .andExpect(jsonPath("$.errors.name").exists()) .andExpect(jsonPath("$.errors.age").exists()); } @测试 void shouldInincludeErrorMessageForEachField() 抛出异常 { mockMvc.perform(post("/api/users") .contentType(“应用程序/json”) .content("{\"姓名\":\"\",\"电子邮件\":\"无效\"}")) .andExpect(status().isBadRequest()) .andExpect(jsonPath("$.errors.name").value("不能为空")) .andExpect(jsonPath("$.errors.email").value("必须是有效的电子邮件")); } } ## 使用自定义逻辑测试异常处理程序 ### 带上下文的异常处理程序 @ControllerAdvice 公共类 GlobalExceptionHandler { 私有最终 MessageService 消息服务；私有最终 LoggingService 日志服务；公共GlobalExceptionHandler（MessageService消息服务，LoggingService日志服务）{ this.messageService = messageService; this.loggingService =loggingService; } @ExceptionHandler(BusinessException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) 公共ErrorResponse handleBusinessException（BusinessException ex，HttpServletRequest请求）{ loggingService.logException(例如 request.getRequestURI()); String localizedMessage = messageService.getMessage(ex.getErrorCode()); 返回新的错误响应（ HttpStatus.BAD_REQUEST.value(), “业务错误”，本地化消息）； } } 类 ExceptionHandlerWithContextTest { 私人 MockMvc 模拟Mvc；私有 GlobalExceptionHandler 处理程序；私有消息服务消息服务；私有 LoggingService 日志服务； @BeforeEach 无效设置（）{ messageService = mock(MessageService.class); loggingService = 模拟(LoggingService.class); 处理程序 = new GlobalExceptionHandler(messageService,loggingService); 模拟Mvc = MockMvcBuilders .standaloneSetup(new TestController()) .setControllerAdvice(处理程序) .build(); } @测试 void shouldLocalizeErrorMessage() 抛出异常 { 当（messageService.getMessage（“USER_NOT_FOUND”）） .thenReturn("L'utilisateur n'a pas été trouvé"); mockMvc.perform(get("/api/users/999")) .andExpect(status().isBadRequest()) .andExpect(jsonPath("$.message").value("L'utilisateur n'a pas été trouvé")); 验证（messageService）.getMessage（“USER_NOT_FOUND”）; } @测试 void shouldLogExceptionOccurrence() 抛出异常 { mockMvc.perform(get("/api/users/999")) .andExpect(status().isBadRequest()); 验证(loggingService).logException(any(BusinessException.class),anyString()); } } ## 最佳实践 * **使用真实的异常抛出来测试所有异常处理程序** * **验证每种异常类型的 HTTP 状态代码** * **测试错误响应结构**以确保一致性 * **验证日志记录**是否被适当触发 * **使用模拟控制器**在测试中抛出异常 * **测试快乐路径和错误路径** * **保持错误消息用户友好**且一致 ## 常见陷阱 * 不测试完整的请求路径（将 MockMvc 与控制器一起使用） * 忘记在 MockMvc 设置中包含 `@ControllerAdvice` * 未验证错误响应中的所有必填字段 * 测试处理程序逻辑而不是异常处理行为 * 不测试边缘情况（空异常、异常消息） ## 限制和警告 * **@ControllerAdvice执行顺序** : 可以使用@Order注解对多个@ControllerAdvice处理程序进行排序 * **异常处理程序特异性**：更具体的异常类型优先于通用处理程序 * **需要 ResponseStatus** ：没有 @ResponseStatus 或返回 ResponseEntity，状态默认为 200 * **全局处理程序与本地处理程序**：@ControllerAdvice 中的 @ExceptionHandler 是全局处理程序；在控制器中它是该控制器本地的 * **记录注意事项**：异常处理程序应在返回响应之前在适当的级别记录异常 * **消息本地化** ：使用本地化消息时，使用不同的区域设置进行测试 * **安全上下文**：异常处理程序可以访问安全上下文以进行身份验证/授权错误 ## 故障排除 **未调用异常处理程序**：确保控制器已向 MockMvc 注册并实际引发异常。 **JsonPath 匹配器不匹配** ：使用 `.andDo(print())` 查看实际的响应结构。 **状态代码不匹配**：验证处理程序方法上的“@ResponseStatus”注释。 ## 参考文献 * [Spring ControllerAdvice文档]() * [Spring 异常处理程序]() * [MockMvc 测试]()

单元测试异常处理程序

包含技能