Restful之通用返回格式类设计

目录

• Restful通用返回格式类设计
• 普通格式
• 带页码的格式
• 样例代码
• 字段解释
• Result 普通返回类设计
• 带页码类设计
• 总结

Restful通用返回格式类设计

restful 接口返回遵循统一格式，设计参考类 Optional

遵循函数式编程规范

普通格式

{ "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://.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://.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://.com"); }

字段解释

 / * 错误信息 */ private String msg; / * 状态 1成功 其它失败，失败需要返回msg */ private int state; / * 是否跳转 */ private boolean is_redirect = false; / * 跳转地址 */ 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; / * 状态 1成功 其它失败，失败需要返回msg */ private int state; / * 是否跳转 */ private boolean is_redirect = false; / * 跳转地址 */ 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; } / * * 功能描述: 创建一个空Result类 * @auther: yuantao * @date: 2018/4/21 */ public static <T> Result<T> empty() { @SuppressWarnings("unchecked") Result<T> t = (Result<T>) EMPTY; return t; } / * * 功能描述: 生成一个成功状态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); } / * * 功能描述: 生成一个成功状态Result类 * @auther: yuantao * @param: 返回的错误信息 * @return: Result<T> * @date: 2018/4/21 */ public static <T> Result<T> fail(String message) { return new Result<>(message, 0); } / * * 功能描述: 设置跳转地址 * @auther: yuantao * @param: 跳转地址 * @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; } / * * 功能描述: 设置失败状态跳转地址 * @auther: yuantao * @param: 跳转地址 * @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; / * 状态 1成功 其它失败，失败需要返回msg */ private int state; / * 是否跳转 */ private boolean is_redirect = false; / * 跳转地址 */ 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; } / * 功能描述: 创建一个空PageResult类 * * @auther: yuantao * @date: 2018/4/21 */ public static <T> PageResult<T> empty() { @SuppressWarnings("unchecked") PageResult<T> t = (PageResult<T>) EMPTY; return t; } / * 功能描述: 生成一个成功状态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); } / * 功能描述: 生成一个失败状态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; } / * 功能描述: 设置总数 * * @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; } / * 功能描述: 设置跳转地址 * * @auther: yuantao * @param: 跳转地址 * @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; } / * 功能描述: 设置失败跳转地址 * * @auther: yuantao * @param: 跳转地址 * @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> { / * 接口数据 */ 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; } } } } 

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持本网站。

您可能感兴趣的文章:

• Java HttpClient-Restful工具各种请求高度封装提炼及总结
• 一篇文章带你搞懂Java restful 接口开发
• Java Restful API的拦截详解
• java调用Restful接口的三种方法
• Java进阶之走进RESTful接口
• java使用Feign实现声明式Restful风格调用
• Java 调用Restful API接口的几种方式(HTTPS)
• 浅谈java调用Restful API接口的方式
• 最好的8个Java RESTful框架