使用aop實現全局異常處理

Posted on by

本文實例為大傢分享瞭使用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
  • 異常處理和返回結果得到統一，不怕你的隊友復制錯瞭。

以上就是本文的全部內容，希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

推薦閱讀：