Hello大家好,本章我們將請求結果封裝成統一格式。有問題可以聯絡我mr_beany@163.com。另求各路大神指點,感謝
一:這麼做的好處是什麼?
我們呼叫服務返回的型別有String,List,Map,Bean,Int,Boolean等型別,可以統一成result物件返回,方便專案組其他成員呼叫介面
二:定義響應碼列舉
package com.example.demo.core.ret;
/**
* @Description: 響應碼列舉,參考HTTP狀態碼的語義
* @author 張瑤
* @date 2018/4/19 09:42
*/
public enum RetCode {
// 成功
SUCCESS(200),
// 失敗
FAIL(400),
// 未認證(簽名錯誤)
UNAUTHORIZED(401),
// 介面不存在
NOT_FOUND(404),
// 伺服器內部錯誤
INTERNAL_SERVER_ERROR(500);
public int code;
RetCode(int code) {
this.code = code;
}
}複製程式碼
這裡簡單列出幾個,大家可以根據實際業務需求自己定義
三:建立返回物件實體
package com.example.demo.core.ret;
import java.io.Serializable;
import com.alibaba.fastjson.JSON;
/**
* @Description: 返回物件實體
* @author 張瑤
* @date 2018/4/19 09:43
*/
public class RetResult<T> {
public int code;
private String msg;
private T data;
public RetResult<T> setCode(RetCode retCode) {
this.code = retCode.code;
return this;
}
public int getCode() {
return code;
}
public RetResult<T> setCode(int code) {
this.code = code;
return this;
}
public String getMsg() {
return msg;
}
public RetResult<T> setMsg(String msg) {
this.msg = msg;
return this;
}
public T getData() {
return data;
}
public RetResult<T> setData(T data) {
this.data = data;
return this;
}
}複製程式碼
說明:code為狀態碼、msg為提示資訊、data為返回的資料
四:轉換資料格式
package com.example.demo.core.ret;
/**
* @Description: 將結果轉換為封裝後的物件
* @author 張瑤
* @date 2018/4/19 09:45
*/
public class RetResponse {
private final static String SUCCESS = "success";
public static <T> RetResult<T> makeOKRsp() {
return new RetResult<T>().setCode(RetCode.SUCCESS).setMsg(SUCCESS);
}
public static <T> RetResult<T> makeOKRsp(T data) {
return new RetResult<T>().setCode(RetCode.SUCCESS).setMsg(SUCCESS).setData(data);
}
public static <T> RetResult<T> makeErrRsp(String message) {
return new RetResult<T>().setCode(RetCode.FAIL).setMsg(SUCCESS);
}
public static <T> RetResult<T> makeRsp(int code, String msg) {
return new RetResult<T>().setCode(code).setMsg(msg);
}
public static <T> RetResult<T> makeRsp(int code, String msg, T data) {
return new RetResult<T>().setCode(code).setMsg(msg).setData(data);
}
}複製程式碼
五:功能測試
改造controller程式碼
改造前程式碼
@PostMapping("/selectById")
public UserInfo selectById(Integer id){
return userInfoService.selectById(id);
}複製程式碼
改造前請求返回資料格式
{
"id": 1,
"userName": "1"
}複製程式碼
改造後程式碼
@PostMapping("/selectById")
public RetResult<UserInfo> selectById(Integer id){
UserInfo userInfo = userInfoService.selectById(id);
return RetResponse.makeOKRsp(userInfo);
}複製程式碼
改造後請求返回資料格式
{
"code": 200,
"msg": "success",
"data": {
"id": 1,
"userName": "1"
}
}複製程式碼
怎麼樣,是不是感覺清爽許多
專案地址
碼雲地址: gitee.com/beany/mySpr…
GitHub地址: github.com/MyBeany/myS…
寫文章不易,如對您有幫助,請幫忙點下star
結尾
springboot將請求結果封裝成統一格式已完成,後續功能接下來陸續更新,有問題可以聯絡我mr_beany@163.com。另求各路大神指點,感謝大家。