## 一、該如何設計數據結構 1. CustomException 自定義異常。核心要素：異常錯誤編碼（200正常,400,500），異常錯誤信息message。 2. ExceptionTypeEnum 枚舉異常分類，將異常分類固化下來，防止開發人員思維發散。 核心要素 異常分類編碼（200正常,400,500），異常分類描述。 3. AjaxResponse 用于響應Ajax請求。核心要素：是否請求成功 isok；響應code零與非零，零表示成功（200,400,500）；響應成功與否信息描述message；響應成功的數據data。 4. error.html 另外還需要有一個統一處理CustomException的地方。即@ControllerAdvice和@ExceptionHandler，后文會說明 ## 二、枚舉異常的類型 為了防止開發人員大腦發散，每個開發人員都不斷的發明自己的異常類型，我們需要規定好異常的類型(枚舉)。比如：系統異常、用戶（輸入）操作導致的異常、其他異常等。  ~~~ public enum CustomExceptionType { USER_INPUT_ERROR(400,"用戶輸入異常"), SYSTEM_ERROR (500,"系統服務異常"), OTHER_ERROR(999,"其他未知異常"); CustomExceptionType(int code, String typeDesc) { this.code = code; this.typeDesc = typeDesc; } private String typeDesc;//異常類型中文描述 private int code; //code public String getTypeDesc() { return typeDesc; } public int getCode() { return code; } } ~~~ * 以筆者的經驗，最好不要超過5個，否則開發人員將會記不住，也不愿意去記。對于我來說上面的三種異常類型就足夠了。 * 這里的code表示異常類型的唯一編碼，為了方便大家記憶，就使用Http狀態碼400、500 ## 三、自定義異常 * 自定義異常有兩個核心內容，一個是code。使用CustomExceptionType 來限定范圍。 * 另外一個是message，這個message信息是要最后返回給前端的，所以需要用友好的提示來表達異常發生的原因或內容 ~~~ public class CustomException extends RuntimeException { //異常錯誤編碼 private int code ; //異常信息 private String message; private CustomException(){} public CustomException(CustomExceptionType exceptionTypeEnum, String message) { this.code = exceptionTypeEnum.getCode(); this.message = message; } public int getCode() { return code; } @Override public String getMessage() { return message; } } ~~~ ## 四、統一響應數據結構 為了解決不同的開發人員使用不同的結構來響應給前端，導致規范不統一，開發混亂的問題。我們使用如下代碼定義統一數據響應結構 * isok表示該請求是否處理成功（即是否發生異常）。true表示請求處理成功，false表示處理失敗。 * code對響應結果進一步細化，200表示請求成功，400表示用戶操作導致的異常，500表示系統異常，999表示其他異常。與CustomExceptionType枚舉一致。 * message：友好的提示信息，或者請求結果提示信息。如果請求成功這個信息通常沒什么用，如果請求失敗，該信息需要展示給用戶。 * data：通常用于查詢數據請求，成功之后將查詢數據響應給前端。 ~~~ /** * 接口數據請求統一響應數據結構 */ @Data public class AjaxResponse { private boolean isok; private int code; private String message; private Object data; private AjaxResponse() { } //請求出現異常時的響應數據封裝 public static AjaxResponse error(CustomException e) { AjaxResponse resultBean = new AjaxResponse(); resultBean.setIsok(false); resultBean.setCode(e.getCode()); if(e.getCode() == CustomExceptionType.USER_INPUT_ERROR.getCode()){ resultBean.setMessage(e.getMessage()); }else if(e.getCode() == CustomExceptionType.SYSTEM_ERROR.getCode()){ resultBean.setMessage(e.getMessage() + ",請將該異常信息發送給管理員!"); }else{ resultBean.setMessage("系統出現未知異常，請聯系管理員!"); } //TODO 這里最好將異常信息持久化 return resultBean; } //請求出現異常時的響應數據封裝 public static AjaxResponse error(CustomExceptionType customExceptionType, String errorMessage) { AjaxResponse resultBean = new AjaxResponse(); resultBean.setIsok(false); resultBean.setCode(customExceptionType.getCode()); resultBean.setMessage(errorMessage); return resultBean; } //請求處理成功時的數據響應 public static AjaxResponse success() { AjaxResponse resultBean = new AjaxResponse(); resultBean.setIsok(true); resultBean.setCode(200); resultBean.setMessage("success"); return resultBean; } //請求處理成功，并響應結果數據 public static AjaxResponse success(Object data) { AjaxResponse resultBean = AjaxResponse.success(); resultBean.setData(data); return resultBean; } } ~~~ 對于不同的場景，提供了四種構建AjaxResponse 的方法。 * 當請求成功的情況下，可以使用`AjaxResponse.success()`構建返回結果給前端。 * 當查詢請求等需要返回業務數據，請求成功的情況下，可以使用`AjaxResponse.success(data)`構建返回結果給前端。攜帶結果數據。 * 當請求處理過程中發生異常，需要將異常轉換為CustomException ，然后在控制層使用`AjaxResponse error(CustomException)`構建返回結果給前端。 * 在某些情況下，沒有任何異常產生，我們判斷某些條件也認為請求失敗。這種使用`AjaxResponse error(customExceptionType,errorMessage)`構建響應結果。 ## 五、使用示例如下： 例如：更新操作，Controller無需返回額外的數據 ~~~ return AjaxResponse.success(); ~~~  例如：查詢接口，Controller需返回結果數據(data可以是任何類型數據) ~~~ return AjaxResponse.success(data); ~~~