详解Spring MVC优雅处理异常的6种方式
异常处理是每个 Java程序员需要面对的一个问题，在Spring中，提供了多种机制来处理控制器抛出的异常，确保应用程序在面对各种错误情况时能够优雅地响应。这篇文章，我们来详细分析Spring MVC中，几种优雅处理异常的方式。
1. 使用@ExceptionHandler注解
@ExceptionHandler注解允许在单个Controller中定义处理特定异常的方法。当 Controller的方法抛出指定的异常时，Spring会调用相应的处理方法。
如下示例，展示了如何在 Controller层优雅处理异常：
@Controller
public class MyController {
@RequestMapping("/example")
public String example() {
// 可能抛出异常的业务逻辑
if (1/0) {
throw new CustomException("自定义异常发生");
}
return "success";
}
@ExceptionHandler(CustomException.class)
public ModelAndView handleCustomException(CustomException ex) {
ModelAndView mav = new ModelAndView();
mav.addObject("message", ex.getMessage());
mav.setViewName("errorPage");
return mav;
}
}
优点： 简单直观，适用于单个控制器的异常处理。
缺点： 如果多个控制器需要相同的异常处理逻辑，需要在每个控制器中重复定义。
2. 使用@ControllerAdvice注解
@ControllerAdvice是一种全局的异常处理方式，可以应用于所有 Controller。通过将异常处理逻辑集中在一个地方，可以避免代码重复，提高维护性。
如下示例，展示了如何使用@ControllerAdvice优雅处理全局异常：
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(CustomException.class)
public ModelAndView handleCustomException(CustomException ex) {
ModelAndView mav = new ModelAndView();
mav.addObject("message", ex.getMessage());
mav.setViewName("errorPage");
return mav;
}
@ExceptionHandler(Exception.class)
public ModelAndView handleGeneralException(Exception ex) {
ModelAndView mav = new ModelAndView();
mav.addObject("message", "发生了一个错误: " + ex.getMessage());
mav.setViewName("errorPage");
return mav;
}
}
优点：
- 全局统一管理异常处理逻辑。
- 代码更清晰，易于维护。
缺点：
- 全局处理不适用于需要针对某些控制器有特殊处理需求的情况，需结合其他方法使用。
3. 实现HandlerExceptionResolver接口
HandlerExceptionResolver 是一种更底层的异常处理机制，通过实现该接口，开发者可以自定义异常解析逻辑。
如下示例，展示了如何实现HandlerExceptionResolver接口优雅处理异常：
public class MyExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex) {
ModelAndView mav = new ModelAndView();
if (ex instanceof CustomException) {
mav.addObject("message", ex.getMessage());
mav.setViewName("customErrorPage");
} else {
mav.addObject("message", "未知错误");
mav.setViewName("errorPage");
}
return mav;
}
}
配置：
在 Spring 配置文件中注册自定义异常解析器：
<bean class="com.example.MyExceptionResolver"/>
优点：
高度灵活，可以处理各种复杂的异常情景。
缺点：
- 需要更多的配置和实现工作。
- 不如注解方式直观，适用性较低。
4. 使用@ResponseStatus注解
@ResponseStatus注解可以用于自定义异常对应的 HTTP 状态码和错误信息，当抛出带有该注解的异常时，Spring会自动设置相应的状态码。
如下示例，展示了如何使用@ResponseStatus注解优雅处理异常：
@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "资源未找到")
public class ResourceNotFoundException extends RuntimeException {
public ResourceNotFoundException(String message) {
super(message);
}
}
使用：
@Controller
public class MyController {
@RequestMapping("/resource")
public String getResource() {
// 假设资源未找到
throw new ResourceNotFoundException("资源ID不存在");
}
}
优点：
简单快捷，适用于直接映射到特定 HTTP 状态码的异常情况。
缺点：
无法返回自定义的错误页面或更复杂的错误信息。
5. 使用ResponseEntity和@RestControllerAdvice
在构建 RESTful API时，常用ResponseEntity来返回自定义的错误响应，并结合@RestControllerAdvice可以全局处理异常并返回 JSON 格式的错误信息。
如下示例，展示了如何使用ResponseEntity和@RestControllerAdvice来处理 RESTful API的异常：
@RestControllerAdvice
public class RestExceptionHandler {
@ExceptionHandler(CustomException.class)
public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
ErrorResponse error = new ErrorResponse("CUSTOM_ERROR", ex.getMessage());
return new ResponseEntity<>(error, HttpStatus.BAD_REQUEST);
}
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
ErrorResponse error = new ErrorResponse("GENERAL_ERROR", "内部服务器错误");
return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
}
}
public class ErrorResponse {
private String errorCode;
private String errorMessage;
// 构造方法、getter 和 setter
}
优点：
- 适用于 RESTful 服务，能够返回结构化的错误信息（如 JSON）。
- 全局统一管理，易于维护。
缺点：
需要定义额外的错误响应类。
6. 使用@ControllerAdvice和@ExceptionHandler
如果使用 Spring Boot，可以更便捷地使用 @ControllerAdvice 结合自动配置实现异常处理。
如下示例，展示了如何使用@ControllerAdvice和@ExceptionHandler来处理异常：
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<ValidationErrorResponse> handleValidationExceptions(
MethodArgumentNotValidException ex) {
ValidationErrorResponse errors = new ValidationErrorResponse();
ex.getBindingResult().getAllErrors().forEach((error) -> {
errors.addError(((FieldError) error).getField(), error.getDefaultMessage());
});
return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
}
// 其它异常处理方法
}
优点：
- 与 Spring Boot 无缝集成，减少配置。
- 提供了诸多便利的功能，如自动处理验证错误等。
7. 总结
本文，我们分析了 Spring MVC优雅处理异常的几种方法以及代码示例，我们可以根据具体需求选择合适的方法：
- 局部控制器处理：使用
@ExceptionHandler注解，适用于单个控制器的特定异常处理。 - 全局处理：使用
@ControllerAdvice或@RestControllerAdvice，适用于跨多个控制器的统一异常处理。 - 自定义解析：实现
HandlerExceptionResolver接口，适用于需要高度自定义的异常处理逻辑。 - 状态码注解：使用
@ResponseStatus注解，适用于简单的异常状态码映射。 - RESTful API：结合
ResponseEntity和全局异常处理，返回结构化的错误响应。
从实际工作来看，@ControllerAdvice 或 @RestControllerAdvice是使用频率最高的一种方式。
到此这篇关于详解Spring MVC优雅处理异常的6种方式的文章就介绍到这了,更多相关Spring MVC处理异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
注意Java中 new BigDecimal(double val) 的使用
这篇文章主要介绍了注意Java中 new BigDecimal(double val) 的使用，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下2022-07-07
这篇文章主要介绍了java数据类型与二进制详细介绍的相关资料,这里对数据类型进行了一一介绍分析，并说明自动转换和强制转换，需要的朋友可以参考下2017-07-07
这篇文章主要介绍了SpringBoot中的多个事务管理详解,事务管理是一种组织和协调各种活动和资源的方法,以实现特定目标,它涉及规划、执行和监控各种任务,以确保项目或组织的顺利运行,需要的朋友可以参考下2023-10-10
这篇文章主要给大家总结介绍了关于Spring注入Bean的一些方式，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2021-07-07
这篇文章主要介绍了java实现遍历Map的方法,以简单实例形式分析了java针对HashMap的遍历技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-09-09
这篇文章主要介绍了JWT与cookie和token的区别说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-10-10
Springboot+ElementUi实现评论、回复、点赞功能
这篇文章主要介绍了通过Springboot ElementUi实现评论、回复、点赞功能。如果是自己评论的还可以删除，删除的规则是如果该评论下还有回复，也一并删除。需要的可以参考一下2022-01-01
这几天看SFTP资料时，无意中看到了Ganymed SSH-2，写了个简单demo，通过，感觉挺好用的，下面就和大家分享下。需要的朋友可以过来参考参考2013-08-08
单例模式是一种常用的软件设计模式,它确保一个类只有一个实例,并提供一个全局访问点,在多线程环境下,确保单例模式的线程安全性是非常重要的,因为多个线程可能会同时尝试创建实例,导致实例不唯一的问题,本文介绍了在Java中实现线程安全的单例模式有几种常见的方式2024-09-09
java定时任务如何取消,并比如,我之前想每周二晚上6点自动生成一条devops流水线,现在我想停掉,下面给大家分享java定时任务取消的示例代码,演示如何创建一个每周二晚上6点自动生成一条devops流水线的定时任务,感兴趣的朋友一起看看吧2024-02-02
最新评论