Restful之通用返回格式类设计
更新时间：2023年12月15日 16:07:39 作者：VergilOpen
这篇文章主要介绍了Restful之通用返回格式类设计,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
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://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;
/**
* 状态 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;
}
}
}
}
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了spring boot结合Redis实现工具类的方法示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-11-11
这篇文章主要介绍了Java中的Fork/Join框架使用详解,Fork/Join 框架：就是在必要的情况下,将一个大任务,进行<BR>拆分(fork)成若干个小任务(拆到不可再拆时),再将一个个<BR>的小任务运算的结果进行 join 汇总,需要的朋友可以参考下2024-01-01
这篇文章主要为大家详细介绍了java实现饭店点菜系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-01-01
这篇文章主要介绍了Spring中的AOP动态代理源码详解,AOP即面向切面编程也称面向方面编程,它是面向对象编程OOP的一种补充,目前已成为一种比较成熟的编程方式,本文就其源码进行解析,需要的朋友可以参考下2023-09-09
本文讲解Apache Commons-IO库的安装与使用,包括下载、IDE导入及FileUtils方法示例,如文件复制,帮助简化Java I/O操作,避免资源泄漏等问题,感兴趣的朋友跟随小编一起看看吧2025-09-09
在日常开发的过程中我们经常会遇到需要mock一些数据的场景，比如说 mock 一些接口的返回或者说 mock 一些测试消息用于队列生产者发送消息。本文将教你如何通过 Stream API 批量 Mock 数据，需要的可以参考一下2022-09-09
SpringCloud Gateway HttpWebHandlerAdapter链路调用请求流程介
Spring Cloud Gateway旨在为微服务架构提供一种简单有效的、统一的 API 路由管理方式。Spring Cloud Gateway 作为 Spring Cloud 生态系中的网关，它不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全、监控/埋点和限流等2022-10-10
本文给大家详细介绍从零搭建SpringCloud的超详细过程,本文通过图文实例代码相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧2025-09-09
在Web开发过程中，我们需要接触许多静态资源，如CSS、JS、图片等；在之前的开发中，这些资源都放在Web目录下，用到的时候按照对应路径访问即可。不过在SpringBoot项目中，没有了Web目录，那这些静态资源该放到哪里去，又要如何访问呢？这就是我们要讲的静态资源导入2022-05-05
最近用Servlet做了个小项目,分享给大家,下面这篇文章主要给大家介绍了关于Java Servlet实现表白墙的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下2023-02-02
最新评论