一，統一傳回資料結構
- 定義傳回的資料結構
package com.futao.springmvcdemo.model.system;
import org.joda.time.DateTime;
import java.sql.Timestamp;
/**
* @author futao
* Created on 2018/9/22-21:47.
* 統一傳回Rest風格的資料結構
*/
public class RestResult {
/**
* 請求是否成功
*/
private boolean success;
/**
* 成功或者失敗的code錯誤碼
*/
private String code;
/**
* 成功時傳回的資料，失敗時傳回具體的異常資訊
*/
private Object data;
/**
* 請求失敗傳回的提示資訊，給前端進行頁面展示的資訊
*/
private Object errorMessage;
/**
* 伺服器目前時間（添加該字段的原因是便于查找定位請求時間，因為實際開發過程中伺服器時間可能跟本地時間不一緻，加上這個時間戳便于日後定位）
*/
private Timestamp currentTime;
public RestResult() {
}
@Override
public String toString() {
return "RestResult{" +
"success=" + success +
", code='" + code + '\'' +
", data=" + data +
", errorMessage=" + errorMessage +
", currentTime=" + currentTime +
'}';
}
public RestResult(boolean success, String code, Object data, Object errorMessage) {
this.success = success;
this.code = code;
this.data = data;
this.errorMessage = errorMessage;
this.currentTime = new Timestamp(new DateTime().getMillis());
}
public boolean isSuccess() {
return success;
}
public void setSuccess(boolean success) {
this.success = success;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
public Object getErrorMessage() {
return errorMessage;
}
public void setErrorMessage(Object errorMessage) {
this.errorMessage = errorMessage;
}
public Timestamp getCurrentTime() {
return currentTime;
}
public void setCurrentTime(Timestamp currentTime) {
this.currentTime = currentTime;
}
}
-
将傳回資料包裝成Rest風格
實作
ResponseBodyAdvice<T>
package com.futao.springmvcdemo.foundation;
import com.alibaba.fastjson.JSONObject;
import com.futao.springmvcdemo.model.system.RestResult;
import org.apache.commons.lang3.StringUtils;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
/**
* @author futao
* Created on 2018/9/22-20:24.
* 傳回Rest風格的資料
*/
@ControllerAdvice(basePackages = "com.futao.springmvcdemo.controller")
public class RestResultWrapper implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return true;
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
RestResult result = new RestResult(true, "0", body, null);
return JSONObject.toJSON(result);
}
}
- 請求測試
@GetMapping("get")
public User get() {
User user = new User();
user.setUsername("NiuBist");
user.setId("123");
user.setAge("18");
user.setEmail("[email protected]");
user.setMobile("12312321312");
user.setAddress("浙江省杭州市");
return user;
}
結果：
請求結果
二，統一異常處理，傳回統一異常資料結構
- 定義一個類來存放是以的異常提示資訊，便于管理
package com.futao.springmvcdemo.model.entity.constvar;
/**
* @author futao
* Created on 2018/9/21-15:29.
* 錯誤提示集合類
* 錯誤碼構成： 01程式員編号
* 001該程式員定義的錯誤碼
* 後面再跟上錯誤資訊
*/
public final class ErrorMessage {
public static final String SYSTEM_EXCEPTION = "系統繁忙，請稍後再試";
public static final String NOT_LOGIN = "01001_您還未登陸或者登陸已逾時，請重新登陸";
public static final String MOBILE_ALREADY_REGISTER = "01002_該手機号已經被注冊了";
public static final String LOGIC_EXCEPTION = "01003_對不起，你是真的沒有我帥";
}
- 定義邏輯異常類
package com.futao.springmvcdemo.foundation;
/**
* @author futao
* Created on 2018/9/20-15:22.
* 業務邏輯異常類
*/
public class LogicException extends RuntimeException {
/**
* 異常資訊
*/
private String errorMsg;
/**
* 錯誤碼
*/
private String code;
public String getErrorMsg() {
return errorMsg;
}
public void setErrorMsg(String errorMsg) {
this.errorMsg = errorMsg;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
private LogicException(String errorMsg) {
super(errorMsg);
this.code = errorMsg.substring(0, 5);
this.errorMsg = errorMsg.substring(6);
}
/**
* 抛出邏輯異常
*
* @param errorMsg
* @return
*/
public static LogicException le(String errorMsg) {
return new LogicException(errorMsg);
}
}
- 對異常（包括系統異常與業務邏輯異常）進行統一處理
package com.futao.springmvcdemo.foundation;
import com.alibaba.fastjson.JSONObject;
import com.futao.springmvcdemo.model.entity.constvar.ErrorMessage;
import com.futao.springmvcdemo.model.system.RestResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* @author futao
* Created on 2018/9/21-15:13.
* 異常統一處理，
*/
@ControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(value = Exception.class)
@ResponseBody
public Object logicExceptionHandler(HttpServletRequest request, Exception e, HttpServletResponse response) {
//系統級異常，錯誤碼固定為-1，提示語固定為系統繁忙，請稍後再試
RestResult result = new RestResult(false, "-1", e.getMessage(), ErrorMessage.SYSTEM_EXCEPTION);
//如果是業務邏輯異常，傳回具體的錯誤碼與提示資訊
if (e instanceof LogicException) {
LogicException logicException = (LogicException) e;
result.setCode(logicException.getCode());
result.setErrorMessage(logicException.getErrorMsg());
} else {
//對系統級異常進行日志記錄
logger.error("系統異常:" + e.getMessage(), e);
}
return JSONObject.toJSON(result);
}
}
- 測試
package com.futao.springmvcdemo.controller;
import com.futao.springmvcdemo.foundation.LogicException;
import com.futao.springmvcdemo.model.entity.constvar.ErrorMessage;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author futao
* Created on 2018/9/23-0:28.
* 統一異常處理測試接口
*/
@RequestMapping(path = "exception", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@RestController
public class ExceptionTestController {
/**
* 業務邏輯異常
*/
@GetMapping(path = "logicException")
public void logicException() {
throw LogicException.le(ErrorMessage.LOGIC_EXCEPTION);
}
/**
* 系統異常
*/
@GetMapping(path = "systemException")
public void systemException() {
throw new NullPointerException("空指針了，哥門!!!");
}
}
邏輯異常
系統級異常