IT评测·应用市场-qidao123.com技术社区
标题:
Spring MVC 中，处置惩罚异常的 6种方式
[打印本页]
作者:
自由的羽毛
时间:
2024-12-21 23:09
标题:
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
是利用频率最高的一种方式。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
欢迎光临 IT评测·应用市场-qidao123.com技术社区 (https://dis.qidao123.com/)
Powered by Discuz! X3.4