使用aop实现全局异常处理
作者：T-OPEN
这篇文章主要为大家详细介绍了使用aop实现全局异常处理，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
本文实例为大家分享了使用aop实现全局异常处理的具体代码，供大家参考，具体内容如下
日常业务中存在的问题
- 使用大量的try/catch来捕获异常
- 导致整个控制层代码可读性极差，并且此类工作重复枯燥、容易复制错。
- 一份糟糕的控制器代码如下：@RequestMapping("test/run/old")
public JsonResponse testRunOld() {
try {
exampleService.runTest();
System.out.println("正常运行");
return JsonResponse.newOk();
}catch (DataNotCompleteException e) {
logger.error("something error occured!");
return JsonResponse.newError(ErrorMsgEnum.DATA_NO_COMPLETE);
} catch (Exception e) {
return JsonResponse.newError();
}
}我们要把代码变成这样：
@Controller
public class TestController {
@Autowired
private IExampleService exampleService;
@RequestMapping("test/run/aop")
public JsonResponse testRunAop() throws Exception {
exampleService.runTest();
System.out.println("正常运行");
return JsonResponse.newOk();
}
}@Service
public class ExampleService implements IExampleService{
@Override
public void runTest() throws Exception {
// do something
System.out.println("run something");
throw new CustomException(ErrorMsgEnum.DATA_NO_COMPLETE);
}
}- 这样做以后，代码里少了很多try和catch，这些到处复制的代码本来就应该统一起来，只是在aop以前没有什么更好的处理方式，只能复制。
- 其次，service抛出异常后，不用再去controller里加一段catch，这种操作每次都要浪费5-15秒（如果你不熟悉IDE中的快捷键，这就是噩梦）
- 现在你的异常只要往上抛出去就不管了(throws Exception)，可以专心写业务代码
如何完成？其实原理相当简单。
把那些烦人的try丢到AOP中处理
- 我们将采用Spring AOP统一处理异常，统一返回后端接口的结果。
- 使用一个自定义异常和一个错误前端提示枚举来逐层传递消息
- 一个错误枚举来代替新建异常信息类，减少业务异常信息文件的数量
几个核心类代码
//正常返回的枚举
SUCCESS(true, 2000,"正常返回", "操作成功"),
// 系统错误，50开头
SYS_ERROR(false, 5000, "系统错误", "亲，系统出错了哦~"),
PARAM_INVILAD(false, 5001, "参数出现异常", "参数出现异常"),
DATA_NO_COMPLETE(false, 5002, "数据填写不完整，请检查", "数据填写不完整，请检查");
private ErrorMsgEnum(boolean ok, int code, String msg ,String userMsg) {
this.ok = ok;
this.code = code;
this.msg = msg;
this.userMsg = userMsg;
}
private boolean ok;
private int code;
private String msg;
private String userMsg;
}控制层返回结果POJO类
public class JsonResponse{
String msg;
Object data;
public JsonResponse() {
msg = "";
data = null;
}
public static JsonResponse newOk() {
JsonResponse response = new JsonResponse();
response.setState(State.newOk());
return response;
}
public static JsonResponse newOk(Object data) {
JsonResponse response = new JsonResponse();
response.setData(data);
response.setState(State.newOk());
return response;
}
public static JsonResponse newError() {
JsonResponse response = new JsonResponse();
response.setMsg("无情的系统异常!");
return response;
}
public static JsonResponse newError(ErrorMsgEnum errorMsgEnum) {
JsonResponse response = new JsonResponse();
state.setMsg(errorMsgEnum.getErrorMsg());
return response;
}
}
自定义异常类
public class CustomException extends Exception {
private ErrorMsgEnum errorMsgEnum;
public CustomException(ErrorMsgEnum errorMsgEnum) {
this.errorMsgEnum = errorMsgEnum;
}
}AOP捕获异常处理类
@Around("execution(public * com.jason.*.controller..*.*(..))")
public JsonResponse serviceAOP(ProceedingJoinPoint pjp) throws Exception {
JsonResponse newResultVo = null;
try {
return (JsonResponse) pjp.proceed();
} catch (CustomException e) {
logger.info("自定义业务异常:" + e.getMessage());
ErrorMsgEnum errorMsgEnum = e.getErrorMsgEnum();
if (Objects.nonNull(errorMsgEnum)) {
newResultVo = JsonResponse.newError(errorMsgEnum);
} else {
newResultVo = JsonResponse.newError(e.getMessage());
}
} catch (Exception e) {
//可以顺便处理你的日志，此处能取到方法名，参数等等
logger.error("出现运行时异常：", e);
newResultVo = JsonResponse.newError();
}
return newResultVo;
}Test && End
至此，我们已经可以直接在 Service 或 Controller 中随意抛出一个异常，
直接每个控制器方法抛出的异常定义为 throws Exception 即可
经过这次处理：
- 最大的好处是：没有try
- 异常处理和返回结果得到统一，不怕你的队友复制错了。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。