Restful API返回統一響應體
阿新 • • 發佈:2019-01-08
參考文件:
https://github.com/kuitos/kuitos.github.io/issues/9
對於客戶端開發或者網站開發而言,呼叫介面返回有統一的響應體,可以針對性的設計介面,程式碼結構更加清晰,層次也更加分明。
所以需要呼叫api時,要求返回結構的資料實體。以下就分享以下我的實現方法;
1、建立統一資料結構類
2、建立結果返回靜態方法@JsonInclude(JsonInclude.Include.NON_EMPTY) public class ResponseResult<T> { private boolean success; private String message; private T data; private String errorcode; public boolean isSuccess() { return success; } public void setSuccess(boolean success) { this.success = success; } public String getMessage() { return message; } public void setMessage(String message) { this.message = message; } public T getData() { return data; } public void setData(T data) { this.data = data; } public String getErrorcode() { return errorcode; } public void setErrorcode(String errorcode) { this.errorcode = errorcode; } public ResponseResult() { } }
3、在Controller層所有的介面返回都可以定義成 ResponseResult,而在Service層做邏輯處理,根據特定的業務來返回特定的結果;public class RestResultGenerator { public static <T> ResponseResult<T> genResult(T data,String message){ ResponseResult<T> result = new ResponseResult<T>(); result.setData(data); result.setSuccess(true); result.setMessage(message); return result; } }