為什麼要統一返回值
在我們做後端應用的時候，前後端分離的情況下，我們經常會定義一個資料格式，通常會包含code，message，data這三個必不可少的資訊來方便我們的交流，下面我們直接來看程式碼
ReturnVO
package indi.viyoung.viboot.util;
import java.util.Properties;
/**
* 統一定義返回類
*
* @author yangwei
* @since 2018/12/20
*/
public class ReturnVO {
private static final Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + "/viboot-common/src/main/resources/response.properties");
/**
* 返回程式碼
*/
private String code;
/**
* 返回資訊
*/
private String message;
/**
* 返回資料
*/
private Object data;
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
/**
* 預設構造，返回操作正確的返回程式碼和資訊
*/
public ReturnVO() {
this.setCode(properties.getProperty(ReturnCode.SUCCESS.val()));
this.setMessage(properties.getProperty(ReturnCode.SUCCESS.msg()));
}
/**
* 構造一個返回特定程式碼的ReturnVO物件
* @param code
*/
public ReturnVO(ReturnCode code) {
this.setCode(properties.getProperty(code.val()));
this.setMessage(properties.getProperty(code.msg()));
}
/**
* 預設值返回，預設返回正確的code和message
* @param data
*/
public ReturnVO(Object data) {
this.setCode(properties.getProperty(ReturnCode.SUCCESS.val()));
this.setMessage(properties.getProperty(ReturnCode.SUCCESS.msg()));
this.setData(data);
}
/**
* 構造返回程式碼，以及自定義的錯誤資訊
* @param code
* @param message
*/
public ReturnVO(ReturnCode code, String message) {
this.setCode(properties.getProperty(code.val()));
this.setMessage(message);
}
/**
* 構造自定義的code，message，以及data
* @param code
* @param message
* @param data
*/
public ReturnVO(ReturnCode code, String message, Object data) {
this.setCode(code.val());
this.setMessage(message);
this.setData(data);
}
@Override
public String toString() {
return "ReturnVO{" +
"code='" + code + '\'' +
", message='" + message + '\'' +
", data=" + data +
'}';
}
}
複製程式碼在這裡，我提供了幾個構造方法以供不同情況下使用。程式碼的註釋已經寫得很清楚了，大家也可以應該看的比較清楚~
ReturnCode
細心的同學可能發現了，我單獨定義了一個ReturnCode列舉類用於儲存程式碼和返回的Message：
package indi.viyoung.viboot.util;
/**
* @author yangwei
* @since 2018/12/20
*/
public enum ReturnCode {
/** 操作成功 */
SUCCESS("SUCCESS_CODE", "SUCCESS_MSG"),
/** 操作失敗 */
FAIL("FAIL_CODE", "FAIL_MSG"),
/** 空指標異常 */
NullpointerException("NPE_CODE", "NPE_MSG"),
/** 自定義異常之返回值為空 */
NullResponseException("NRE_CODE", "NRE_MSG");
private ReturnCode(String value, String msg){
this.val = value;
this.msg = msg;
}
public String val() {
return val;
}
public String msg() {
return msg;
}
private String val;
private String msg;
}
複製程式碼這裡，我並沒有將需要儲存的資料直接放到列舉中，而是放到了一個配置檔案中，這樣既可以方便我們進行相關資訊的修改，並且閱讀起來也是比較方便。
SUCCESS_CODE=2000
SUCCESS_MSG=操作成功
FAIL_CODE=5000
FAIL_MSG=操作失敗
NPE_CODE=5001
NPE_MSG=空指標異常
NRE_CODE=5002
NRE_MSG=返回值為空
複製程式碼注意，這裡的屬性名和屬性值分別與列舉類中的value和msg相對應，這樣，我們才可以方便的去通過I/O流去讀取。
這裡需要注意一點，如果你使用的是IDEA編輯器，需要修改以下的配置，這樣你編輯配置檔案的時候寫的是中文，實際上儲存的是ASCII位元組碼。
下面，來看一下讀取的工具類：
package indi.viyoung.viboot.util;
import java.io.*;
import java.util.Iterator;
import java.util.Properties;
/**
* 讀取*.properties中的屬性
* @author vi
* @since 2018/12/24 7:33 PM
*/
public class ReadPropertiesUtil {
public static Properties getProperties(String propertiesPath){
Properties properties = new Properties();
try {
InputStream inputStream = new BufferedInputStream(new FileInputStream(propertiesPath));
properties.load(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
return properties;
}
}
複製程式碼這裡我直接寫了一個靜態的方法，傳入的引數是properties檔案的位置，這樣的話，本文最初程式碼中的也就得到了解釋。
private static final Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + "/viboot-common/src/main/resources/response.properties");
複製程式碼使用ReturnVO
@RequestMapping("/test")
public ReturnVO test(){
try {
//省略
//省略
} catch (Exception e) {
e.printStackTrace();
}
return new ReturnVO();
}
複製程式碼下面我們可以去訪問這個介面，看看會得到什麼：
但是，現在問題又來了，因為try...catch...的存在，總是會讓程式碼變得重複度很高，一個介面你都至少要去花三到十秒去寫這個介面，如果不知道編輯器的快捷鍵，更是一種噩夢。我們只想全心全意的去關注實現業務，而不是花費大量的時間在編寫一些重複的"剛需"程式碼上。
使用AOP進行全域性異常的處理
（這裡，我只是對全域性異常處理進行一個簡單的講解，後面也就是下一節中會詳細的講述）
/**
* 統一封裝返回值和異常處理
*
* @author vi
* @since 2018/12/20 6:09 AM
*/
@Slf4j
@Aspect
@Order(5)
@Component
public class ResponseAop {
private static final Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + "/viboot-common/src/main/resources/response.properties");
/**
* 切點
*/
@Pointcut("execution(public * indi.viyoung.viboot.*.controller..*(..))")
public void httpResponse() {
}
/**
* 環切
*/
@Around("httpResponse()")
public ReturnVO handlerController(ProceedingJoinPoint proceedingJoinPoint) {
ReturnVO returnVO = new ReturnVO();
try {
//獲取方法的執行結果
Object proceed = proceedingJoinPoint.proceed();
//如果方法的執行結果是ReturnVO，則將該物件直接返回
if (proceed instanceof ReturnVO) {
returnVO = (ReturnVO) proceed;
} else {
//否則，就要封裝到ReturnVO的data中
returnVO.setData(proceed);
}
} catch (Throwable throwable) {
//如果出現了異常，呼叫異常處理方法將錯誤資訊封裝到ReturnVO中並返回
returnVO = handlerException(throwable);
}
return returnVO;
}
/**
* 異常處理
*/
private ReturnVO handlerException(Throwable throwable) {
ReturnVO returnVO = new ReturnVO();
//這裡需要注意，返回列舉類中的列舉在寫的時候應該和異常的名稱相對應，以便動態的獲取異常程式碼和異常資訊
//獲取異常名稱的方法
String errorName = throwable.toString();
errorName = errorName.substring(errorName.lastIndexOf(".") + 1);
//直接獲取properties檔案中的內容
returnVO.setMessage(properties.getProperty(ReturnCode.valueOf(errorName).msg()));
returnVO.setCode(properties.getProperty(ReturnCode.valueOf(errorName).val()));
return returnVO;
}
}
複製程式碼如果，我們需要在每一個專案中都可以這麼去做，需要將這個類放到一個公用的模組中，然後在pom中匯入這個模組
<dependency>
<groupId>indi.viyoung.course</groupId>
<artifactId>viboot-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
複製程式碼這裡需要注意一點，必須保證你的切點的正確書寫！！否則就會導致切點無效，同時需要在啟動類中配置：
@ComponentScan(value = "indi.viyoung.viboot.*")
複製程式碼匯入的正是common包下的所有檔案，以保證可以將ResponseAop這個類載入到Spring的容器中。
下面我們來測試一下，訪問我們經過修改後的編寫的findAll介面：
@RequestMapping("/findAll")
public Object findAll(){
return userService.list();
}
複製程式碼PS：這裡我將返回值統一為Object，以便資料存入data，實際型別應是Service介面的返回型別。如果沒有返回值的話，那就可以new一個ReturnVO物件直接通過構造方法賦值即可。關於返回型別為ReturnVO的判斷，程式碼中也已經做了特殊的處理，並非存入data，而是直接返回。
下面，我們修改一下test方法，讓他丟擲一個我們自定義的查詢返回值為空的異常：
@RequestMapping("/test")
public ReturnVO test(){
throw new NullResponseException();
}
複製程式碼下面，我們再來訪問以下test介面：
可以看到，正如我們properties中定義的那樣，我們得到了我們想要的訊息。
原始碼可以去github或者碼雲上進行下載，後續的例子都會同步更新。
公眾號
原創文章，文筆有限，才疏學淺，文中若有不正之處，萬望告知。