日常業務中存在的問題

• 使用大量的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統一處理異常，統一返回後端介面的結果。
• 使用一個自定義異常和一個錯誤前端提示列舉來逐層傳遞訊息
• 一個錯誤列舉來代替新建異常資訊類，減少業務異常資訊檔案的數量

幾個核心類程式碼

• ErrorMsgEnum 錯誤列舉public enum ErrorMsgEnum {

    //正常返回的列舉
    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
• 異常處理和返回結果得到統一，不怕你的隊友複製錯了。