Restful之通用返回格式類設計
更新時間：2023年12月15日 16:07:39 作者：VergilOpen
這篇文章主要介紹了Restful之通用返回格式類設計,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
Restful通用返回格式類設計
restful 接口返回遵循統(tǒng)一格式，設計參考類 Optional
遵循函數(shù)式編程規(guī)范
普通格式
{
"data": "waht",
"msg": null,
"state": 1,
"is_redirect": true,
"redirect_url": "http://baidu.com",
"token": null
}帶頁碼的格式
{
"data": {
"list": null,
"pagebar": {
"page": 1,
"total": 2,
"limit": 10
}
},
"msg": "error",
"state": 0,
"is_redirect": true,
"redirect_url": "http://qq.com",
"token": null
}樣例代碼
@RequestMapping("/get")
public Result<String> get(@RequestParam(value = "msg", required = false) String msg) {
return Result.success(msg).orFail("error")
.redirect("http://baidu.com").orFailRedirect("http://qq.com");
}
@RequestMapping("/page")
public PageResult<String> page() {
List<String> list = new ArrayList<>();
list.add("a");
list.add("b");
return PageResult.success(list).pageBar(1, 10).total(2)
.orFail("error").orFailRedirect("http://qq.com");
}字段解釋
/**
* 錯誤信息
*/
private String msg;
/**
* 狀態(tài) 1成功 其它失敗，失敗需要返回msg
*/
private int state;
/**
* 是否跳轉(zhuǎn)
*/
private boolean is_redirect = false;
/**
* 跳轉(zhuǎn)地址
*/
private String redirect_url;
/**
* token
*/
private String token;Result 普通返回類設計
package org.vergil.pojo;
import java.util.Objects;
/**
* @author: yuantao
* @Date: 2018/4/20
* @Description:
*/
public class Result<T> {
private final static Result<?> EMPTY = new Result<>();
private T data;
/**
* 錯誤信息
*/
private String msg;
/**
* 狀態(tài) 1成功 其它失敗，失敗需要返回msg
*/
private int state;
/**
* 是否跳轉(zhuǎn)
*/
private boolean is_redirect = false;
/**
* 跳轉(zhuǎn)地址
*/
private String redirect_url;
/**
* token
*/
private String token;
public T getData() {
return data;
}
public String getMsg() {
return msg;
}
public int getState() {
return state;
}
public boolean isIs_redirect() {
return is_redirect;
}
public String getRedirect_url() {
return redirect_url;
}
public String getToken() {
return token;
}
private Result() {
this.data = null;
}
private Result(String message, int state) {
this.msg = message;
this.state = state;
}
private Result(T data, int state) {
this.data = data;
this.state = state;
}
/**
*
* 功能描述: 創(chuàng)建一個空Result類
* @auther: yuantao
* @date: 2018/4/21
*/
public static <T> Result<T> empty() {
@SuppressWarnings("unchecked")
Result<T> t = (Result<T>) EMPTY;
return t;
}
/**
*
* 功能描述: 生成一個成功狀態(tài)Result類
* @auther: yuantao
* @param: Data
* @return: Result<T>
* @date: 2018/4/21
*/
public static <T> Result<T> success(T data) {
return new Result<>(data, 1);
}
/**
*
* 功能描述: 生成一個成功狀態(tài)Result類
* @auther: yuantao
* @param: 返回的錯誤信息
* @return: Result<T>
* @date: 2018/4/21
*/
public static <T> Result<T> fail(String message) {
return new Result<>(message, 0);
}
/**
*
* 功能描述: 設置跳轉(zhuǎn)地址
* @auther: yuantao
* @param: 跳轉(zhuǎn)地址
* @return: Result<T>
* @date: 2018/4/21
*/
public <T> Result<T> redirect(String url) {
this.is_redirect = true;
this.redirect_url = url;
return (Result<T>) this;
}
/**
*
* 功能描述: 設置失敗狀態(tài)跳轉(zhuǎn)地址
* @auther: yuantao
* @param: 跳轉(zhuǎn)地址
* @return: Result<T>
* @date: 2018/4/21
*/
public <T> Result<T> orFailRedirect(String url) {
if (state == 1) {
return (Result<T>) this;
}
this.is_redirect = true;
this.redirect_url = url;
return (Result<T>) this;
}
/**
*
* 功能描述: 判斷是否傳入值是否為空,非空則返回值，為空則返回失敗信息
* @auther: yuantao
* @param: 返回的錯誤信息
* @return: Result<T>
* @date: 2018/4/21
*/
public <T> Result<T> orFail(String message) {
if (null != data) {
return (Result<T>) this;
} else {
this.msg = message;
this.state = 0;
}
return (Result<T>) this;
}
@Override
public int hashCode() {
return Objects.hashCode(data);
}
@Override
public String toString() {
return data != null
? String.format("result[%s]", data)
: "result.empty";
}
}
帶頁碼類設計
package org.vergil.pojo;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.function.Supplier;
/**
* @author: yuantao
* @Date: 2018/4/20
* @Description:
*/
public class PageResult<T> {
private final static PageResult<?> EMPTY = new PageResult<>();
private Data<T> data;
/**
* 錯誤信息
*/
private String msg;
/**
* 狀態(tài) 1成功 其它失敗，失敗需要返回msg
*/
private int state;
/**
* 是否跳轉(zhuǎn)
*/
private boolean is_redirect = false;
/**
* 跳轉(zhuǎn)地址
*/
private String redirect_url;
/**
* token
*/
private String token;
public Data<T> getData() {
return data;
}
public String getMsg() {
return msg;
}
public int getState() {
return state;
}
public boolean isIs_redirect() {
return is_redirect;
}
public String getRedirect_url() {
return redirect_url;
}
public String getToken() {
return token;
}
private PageResult() {
this.data = null;
}
private PageResult(String message, int state) {
this.msg = message;
this.state = state;
}
private PageResult(List<T> list, int state) {
Data<T> data = new Data<>(list);
this.data = data;
this.state = state;
}
/**
* 功能描述: 創(chuàng)建一個空PageResult類
*
* @auther: yuantao
* @date: 2018/4/21
*/
public static <T> PageResult<T> empty() {
@SuppressWarnings("unchecked")
PageResult<T> t = (PageResult<T>) EMPTY;
return t;
}
/**
* 功能描述: 生成一個成功狀態(tài)PageResult類
*
* @auther: yuantao
* @param: List<T>
* @return: PageResult<T>
* @date: 2018/4/21
*/
public static <T> PageResult<T> success(List<T> data) {
return new PageResult<>(data, 1);
}
/**
* 功能描述: 生成一個失敗狀態(tài)PageResult類
*
* @auther: yuantao
* @param: 錯誤信息
* @return: PageResult<T>
* @date: 2018/4/21
*/
public static <T> PageResult<T> fail(String message) {
return new PageResult<>(message, 0);
}
/**
* 功能描述: 設置頁碼信息
*
* @auther: yuantao
* @param: pageNum, pageSize
* @return: PageResult<T>
* @date: 2018/4/21
*/
public <T> PageResult<T> pageBar(int pageNum, int pageSize) {
if (state == 1) {
data.pageBar(pageNum, pageSize);
}
return (PageResult<T>) this;
}
/**
* 功能描述: 設置總數(shù)
*
* @auther: yuantao
* @param: total
* @return: PageResult<T>
* @date: 2018/4/21
*/
public <T> PageResult<T> total(int total) {
if (data.pagebar != null) {
data.pagebar.total(total);
}
return (PageResult<T>) this;
}
/**
* 功能描述: 設置跳轉(zhuǎn)地址
*
* @auther: yuantao
* @param: 跳轉(zhuǎn)地址
* @return: PageResult<T>
* @date: 2018/4/21
*/
public <T> PageResult<T> redirect(String url) {
this.is_redirect = true;
this.redirect_url = url;
return (PageResult<T>) this;
}
/**
* 功能描述: 設置失敗跳轉(zhuǎn)地址
*
* @auther: yuantao
* @param: 跳轉(zhuǎn)地址
* @return: PageResult<T>
* @date: 2018/4/21
*/
public <T> PageResult<T> orFailRedirect(String url) {
if (state == 1) {
return (PageResult<T>) this;
}
this.is_redirect = true;
this.redirect_url = url;
return (PageResult<T>) this;
}
/**
* 功能描述: 判斷是否傳入值是否為空,非空則返回值，為空則返回失敗信息
*
* @auther: yuantao
* @param: 返回的錯誤信息
* @return: PageResult<T>
* @date: 2018/4/21
*/
public <T> PageResult<T> orFail(String message) {
if (null != data.list) {
return (PageResult<T>) this;
} else {
this.msg = message;
this.state = 0;
}
return (PageResult<T>) this;
}
@Override
public int hashCode() {
return Objects.hashCode(data);
}
@Override
public String toString() {
return data != null
? String.format("result[%s]", data)
: "result.empty";
}
public static class Data<T> {
/**
* 接口數(shù)據(jù)
*/
private List<T> list;
/**
* 分頁信息
*/
private PageBar pagebar;
private Data(List<T> list) {
this.list = list;
}
public List<T> getList() {
return list;
}
public PageBar getPagebar() {
return pagebar;
}
public void pageBar(int pageNum, int pageSize) {
PageBar pageBar = new PageBar(pageNum, pageSize);
this.pagebar = pageBar;
}
public static class PageBar {
private int page;
private int total;
private int limit;
private PageBar(int page, int limit) {
this.page = page;
this.limit = limit;
}
private void total(int total) {
this.total = total;
}
public int getPage() {
return page;
}
public int getTotal() {
return total;
}
public int getLimit() {
return limit;
}
}
}
}
總結(jié)
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了異常try?catch的常見四類方式,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-05-05
Springboot整合Shiro實現(xiàn)登錄與權(quán)限校驗詳細解讀
本文給大家介紹Springboot整合Shiro的基本使用，Apache?Shiro是Java的一個安全框架，Shiro本身無法知道所持有令牌的用戶是否合法，我們將整合Shiro實現(xiàn)登錄與權(quán)限的驗證2022-04-04
給你一個下標從0開始的字符串 word ,字符串只包含小寫英文字母,你需要選擇一個下標并刪除下標處的字符,使得word中剩余每個字母出現(xiàn)頻率相同,本文給大家介紹了Java解決刪除字符使頻率相同問題,需要的朋友可以參考下2024-02-02
這篇文章主要介紹了Java中的Spring?如何處理循環(huán)依賴，依賴指的是Bean與Bean之間的依賴關(guān)系，循環(huán)依賴指的是兩個或者多個Bean相互依賴，關(guān)于更多Spring?處理循環(huán)依賴的詳情,需要的朋友可以參考下面文章具體內(nèi)容2022-05-05
Spring cloud是一個基于Spring Boot實現(xiàn)的服務治理工具包，在微服務架構(gòu)中用于管理和協(xié)調(diào)服務的。這篇文章主要介紹了springcloud注冊hostname或者ip,需要的朋友可以參考下2019-11-11
這篇文章主要介紹了springboot集成es,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-11-11
springboot mybatis調(diào)用多個數(shù)據(jù)源引發(fā)的錯誤問題
這篇文章主要介紹了springboot mybatis調(diào)用多個數(shù)據(jù)源引發(fā)的錯誤問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-01-01
詳解Java多態(tài)對象的類型轉(zhuǎn)換與動態(tài)綁定
這篇文章主要介紹了詳解Java多態(tài)對象的類型轉(zhuǎn)換與動態(tài)綁定,是Java入門學習中的基礎(chǔ)知識,需要的朋友可以參考下2015-09-09
這篇文章主要帶你掌握Java中包的定義及使用以及Java中的4種訪問權(quán)限，文中的示例代碼講解詳細，感興趣的小伙伴可以跟隨小編一起學習一下2022-09-09
java 利用HttpClient PostMethod提交json數(shù)據(jù)操作
這篇文章主要介紹了java 利用HttpClient PostMethod提交json數(shù)據(jù)操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-01-01