全局异常处理器的使用代码
package com.imddysc.supertest.exceptionhandler;
import com.imddysc.supertest.utils.AjaxResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
@ControllerAdvice
public class GlobalDefaultExceptionHandler {
private static final Logger log = LoggerFactory.getLogger(GlobalDefaultExceptionHandler.class);
@ExceptionHandler(Exception.class)
@ResponseBody
public AjaxResult exception(Exception e) {
e.printStackTrace();
log.error("发生了Exception异常: " + e.getMessage());
return AjaxResult.error("发生了未知异常");
}
}
一、Java服务端异常处理:全局异常处理
在 Java 后端服务中,异常处理是一个关键的环节,它不仅关系到服务的稳定性,还直接影响到用户体验。全局异常处理器能够统一处理服务中抛出的异常,使得错误处理逻辑更加集中和一致。
异常处理的重要性
异常处理在 Java 服务端点中扮演着重要的角色:
- 提高代码的可维护性:通过集中处理异常,可以减少代码重复,提高代码的可读性和可维护性。
- 增强服务的健壮性:合理处理异常可以防止服务因未捕获的异常而崩溃。
- 改善用户体验:通过友好的错误信息和恰当的错误处理逻辑,可以提升用户的使用体验。
实现全局异常处理器
在 Spring 框架中,我们可以通过 @ControllerAdvice
和 @ExceptionHandler
注解来实现全局异常处理器。
定义全局异常处理器类
首先,我们需要定义一个全局异常处理器类,并使用 @ControllerAdvice
注解标注。
package cn.juwatech.exception;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestController;
@RestController
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ResponseEntity<errorresponse> handleException(Exception ex) {
ErrorResponse errorResponse = new ErrorResponse("Error: " + ex.getMessage());
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
// 定义错误响应类
public static class ErrorResponse {
private String message;
public ErrorResponse(String message) {
this.message = message;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
}
处理特定类型的异常
除了处理所有异常的通用处理器外,我们还可以针对特定类型的异常定义处理器。
@ExceptionHandler(CustomException.class)
public ResponseEntity<errorresponse> handleCustomException(CustomException ex) {
ErrorResponse errorResponse = new ErrorResponse("Custom Error: " + ex.getMessage());
return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
}
自定义异常类
在实际应用中,我们通常会定义一些自定义异常类,以区分不同的错误情况。
package cn.juwatech.exception;
public class CustomException extends RuntimeException {
public CustomException(String message) {
super(message);
}
}
使用全局异常处理器
在服务端点中,我们可以通过抛出异常来触发全局异常处理器。
package cn.juwatech.controller;
import cn.juwatech.exception.CustomException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ServiceEndpoint {
@GetMapping("/test")
public String testEndpoint() {
throw new CustomException("Something went wrong in test endpoint");
}
}
异常处理的高级配置
在某些情况下,我们可能需要对全局异常处理器进行更细粒度的配置。
异常处理的优先级
我们可以通过 @Order
或 @Priority
注解来指定异常处理器的优先级。
@ControllerAdvice(order = 1)
public class HighPriorityExceptionHandler {
// 定义异常处理逻辑
}
异常处理的响应数据格式
在某些情况下,我们可能需要根据不同的请求(如 API 版本或客户端类型)返回不同格式的错误响应。
@ExceptionHandler(Exception.class)
public ResponseEntity<errorresponse> handleException(Exception ex, HttpServletRequest request) {
String accept = request.getHeader("Accept");
if (accept.contains("application/json")) {
ErrorResponse errorResponse = new ErrorResponse("Error: " + ex.getMessage());
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
} else {
// 返回其他格式的错误响应
}
}
总结
通过上述内容,我们学习了如何在 Java 中实现服务端点的全局异常处理器。通过合理配置和使用全局异常处理器,我们可以有效地统一处理服务中的异常,提高服务的稳定性和用户体验。
转自:https://my.oschina.net/u/8013211/blog/15674882
二、Spring @ControllerAdvice @ExceptionHandler 全局处理异常
本文讲解使用 @ControllerAdvice + @ExceptionHandler 进行全局的 Controller 层异常处理,只要设计得当,就再也不用在 Controller 层进行 try-catch 了!而且,@Validated 校验器注解的异常,也可以一起处理,无需手动判断绑定校验结果 BindingResult/Errors 了!
优缺点
- 优点:将 Controller 层的异常和数据校验的异常进行统一处理,减少模板代码,减少编码量,提升扩展性和可维护性。
- 缺点:只能处理 Controller 层未捕获(往外抛)的异常,对于 Interceptor(拦截器)层的异常,Spring 框架层的异常,就无能为力了。
基本使用示例
2.1 @ControllerAdvice 注解定义全局异常处理类
@ControllerAdvice
public class GlobalExceptionHandler { }
请确保此 GlobalExceptionHandler 类能被扫描到并装载进 Spring 容器中。
2.2 @ExceptionHandler 注解声明异常处理方法
@ControllerAdvice
public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) @ResponseBody String handleException(){ return "Exception Deal!"; } }
方法 handleException () 就会处理所有 Controller 层抛出的 Exception 及其子类的异常,这是最基本的用法了。
全局异常类应用范围设置
⒈@ControllerAdvice 简介
在 spring 3.2 中,新增了 @ControllerAdvice 注解可以用于定义 @ExceptionHandler、@InitBinder、@ModelAttribute, 并应用到所有 @RequestMapping 中。
这里我们全局异常只应用到 @ExceptionHandler
⒉设置 @ControllerAdvice 应用范围
设置了 @ControllerAdvice 应用范围,即就设置了异常类的应用范围
@ControllerAdvice 的范围有:
①basePackages:应用在 xx 包
②basePackageClasses:应用在 xx 类
③assignableTypes:应用在加了 @Controller 的类
④annotations:应用在带有 xx 注解的类或者方法
————————————————————
≥简单用法例子:
————————————————————
@ControllerAdvice(basePackages={"com.springboot.controller"})
只捕捉 com.springboot.controller 包中的异常
@ControllerAdvice(basePackageClasses={TestController.class})
只捕捉 TestController.class 中的异常
@ControllerAdvice(assignableTypes={TestController.class})
只捕捉 TestController.class 中的异常
@ControllerAdvice(annotations=TestException.class)
只捕捉带有 @TestException 注解的类
上面四个注解一个应用包,然后的两个用在类,而最后一个只应用于带有 XX 注解的类