使用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
  • 异常处理和返回结果得到统一,不怕你的队友复制错了。


目录
相关文章
|
JSON 前端开发 Java
Spring AOP【统一异常处理与统一数据格式封装】
Spring AOP【统一异常处理与统一数据格式封装】
Spring AOP【统一异常处理与统一数据格式封装】
|
Web App开发 前端开发 Java
|
2月前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
AOP(面向切面编程)能够帮助我们在不修改现有代码的前提下,为应用程序添加新的功能或行为。Micronaut框架中的AOP模块通过动态代理机制实现了这一目标。AOP将横切关注点(如日志记录、事务管理等)从业务逻辑中分离出来,提高模块化程度。在Micronaut中,带有特定注解的类会在启动时生成代理对象,在运行时拦截方法调用并执行额外逻辑。例如,可以通过创建切面类并在目标类上添加注解来记录方法调用信息,从而在不侵入原有代码的情况下增强应用功能,提高代码的可维护性和可扩展性。
61 1
|
14天前
|
安全 Java 编译器
什么是AOP面向切面编程?怎么简单理解?
本文介绍了面向切面编程(AOP)的基本概念和原理,解释了如何通过分离横切关注点(如日志、事务管理等)来增强代码的模块化和可维护性。AOP的核心概念包括切面、连接点、切入点、通知和织入。文章还提供了一个使用Spring AOP的简单示例,展示了如何定义和应用切面。
49 1
什么是AOP面向切面编程?怎么简单理解?
|
19天前
|
XML Java 开发者
论面向方面的编程技术及其应用(AOP)
【11月更文挑战第2天】随着软件系统的规模和复杂度不断增加,传统的面向过程编程和面向对象编程(OOP)在应对横切关注点(如日志记录、事务管理、安全性检查等)时显得力不从心。面向方面的编程(Aspect-Oriented Programming,简称AOP)作为一种新的编程范式,通过将横切关注点与业务逻辑分离,提高了代码的可维护性、可重用性和可读性。本文首先概述了AOP的基本概念和技术原理,然后结合一个实际项目,详细阐述了在项目实践中使用AOP技术开发的具体步骤,最后分析了使用AOP的原因、开发过程中存在的问题及所使用的技术带来的实际应用效果。
47 5
|
1月前
|
Java 容器
AOP面向切面编程
AOP面向切面编程
41 0
|
2月前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
【9月更文挑战第9天】AOP(面向切面编程)通过分离横切关注点提高模块化程度,如日志记录、事务管理等。Micronaut AOP基于动态代理机制,在应用启动时为带有特定注解的类生成代理对象,实现在运行时拦截方法调用并执行额外逻辑。通过简单示例展示了如何在不修改 `CalculatorService` 类的情况下记录 `add` 方法的参数和结果,仅需添加 `@Loggable` 注解即可。这不仅提高了代码的可维护性和可扩展性,还降低了引入新错误的风险。
46 13
|
3月前
|
XML Java 数据格式
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
这篇文章是Spring5框架的AOP切面编程教程,通过XML配置方式,详细讲解了如何创建被增强类和增强类,如何在Spring配置文件中定义切入点和切面,以及如何将增强逻辑应用到具体方法上。文章通过具体的代码示例和测试结果,展示了使用XML配置实现AOP的过程,并强调了虽然注解开发更为便捷,但掌握XML配置也是非常重要的。
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
|
3月前
|
Java Spring XML
掌握面向切面编程的秘密武器:Spring AOP 让你的代码优雅转身,横切关注点再也不是难题!
【8月更文挑战第31天】面向切面编程(AOP)通过切面封装横切关注点,如日志记录、事务管理等,使业务逻辑更清晰。Spring AOP提供强大工具,无需在业务代码中硬编码这些功能。本文将深入探讨Spring AOP的概念、工作原理及实际应用,展示如何通过基于注解的配置创建切面,优化代码结构并提高可维护性。通过示例说明如何定义切面类、通知方法及其应用时机,实现方法调用前后的日志记录,展示AOP在分离关注点和添加新功能方面的优势。
53 0