这篇文章主要介绍了SpringBoot如何实现统一封装返回前端结果集的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇springBoot如何实现统一封装返回前端结果集文章都会有所收获,下面我们一起来看看吧。我们如
这篇文章主要介绍了SpringBoot如何实现统一封装返回前端结果集的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇springBoot如何实现统一封装返回前端结果集文章都会有所收获,下面我们一起来看看吧。
我们如何封装这个结果?我们应该注意返回到前端的数据中包含的信息。
一般来说,首先,这次必须有一个code来表示接口的状态。例如,0表示成功,1表示失败,2表示必须传递错误的参数,4表示系统异常,依此类推。这只是一个简单的例子。许多人可能会有疑问。Http协议本身已经有了相应的返回代码定义。 例如: 200表示成功, 500表示服务器错误, 404表示找不到页面。
例如,200表示请求成功,但它不能描述请求中的业务结果。 例如,用户名已经存在,事实上,业务并不成功,但HTTP的结果肯定是200, 因此我们需要一个代码来描述我们的业务状态。
除了代码之外,还有一些提示信息,如操作成功、系统异常、用户名已经存在等,所以我们添加了一个message字段。
此外,还有我们的核心数据。例如,我根据ID获取数据。此数据的具体内容必须返回到前端,因此必须有数据。此数据使用什么类型?这种类型必须是多样的,所以我们需要使用统一的父类,以便对象可以接收所有类型。当然,我们可以使用一些通用方法来方便操作。
然后还有我们的核心数据。例如,我根据ID获取数据。此数据的具体内容必须返回到前端,因此必须有数据。此数据使用什么类型?这种类型必须是多样的,所以我们需要使用统一的父类,以便对象可以接收所有类型。当然,我们可以使用通用方法来方便操作。
主要代码展示:
public class Result<T> implements Serializable { private static final long serialVersionUID = -3960261604608758516L; private int code; private String msg; private T data; public static <T> Result<T> success() { return new Result<>(); } public static <T> Result<T> success(T data) { return new Result<>(data); } public static <T> Result<T> success(String msg, T data) { return new Result<>(msg, data); } public static <T> Result<T> success(String msg) { return new Result<>(msg); } public static <T> Result<T> error() { return new Result<>(ResultCode.ERROR); } public static <T> Result<T> error(String msg) { return new Result<>(ResultCode.ERROR.getCode(), msg); } public static <T> Result<T> error(int code, String msg) { return new Result<>(code, msg); } public static <T> Result<T> error(ResultCode resultCode) { return new Result<>(resultCode); } private Result() { this(ResultCode.SUCCESS); } private Result(T data) { this(ResultCode.SUCCESS, data); } private Result(String msg) { this(ResultCode.SUCCESS.getCode(), msg); } private Result(int code, String msg) { this.code = code; this.msg = msg; } private Result(String msg, T data) { this(ResultCode.SUCCESS.getCode(), msg, data); } private Result(int code, String msg, T data) { this(code, msg); this.data = data; } private Result(ResultCode resultCode, T data) { this(resultCode); this.data = data; } private Result(ResultCode resultCode) { this(resultCode.getCode(), resultCode.getMsg()); } }
还需要定义几个常见的错误
@Builderpublic class ResultCode implements Serializable { private static final long serialVersionUID = -6269841958947880397L; private int code; private String msg; public final static ResultCode SUCCESS = dispose(ResultCodeEnum.SUCCESS); public final static ResultCode ERROR = dispose(ResultCodeEnum.ERROR); public final static ResultCode BIZ_ERROR = dispose(ResultCodeEnum.BIZ_ERROR); public final static ResultCode FILE_OUT_MAX = dispose(ResultCodeEnum.FILE_OUT_MAX); public final static ResultCode FILE_FORMAT_ERROR = dispose(ResultCodeEnum.FILE_FORMAT_ERROR); public final static ResultCode PARAM_ERROR = dispose(ResultCodeEnum.PARAM_ERROR); public final static ResultCode JSON_FORMAT_ERROR = dispose(ResultCodeEnum.jsON_FORMAT_ERROR); public final static ResultCode sql_ERROR = dispose(ResultCodeEnum.SQL_ERROR); public final static ResultCode NETWORK_TIMEOUT = dispose(ResultCodeEnum.netWORK_TIMEOUT); public final static ResultCode UNKNOWN_INTERFACE = dispose(ResultCodeEnum.UNKNOWN_INTERFACE); public final static ResultCode REQ_MODE_NOT_SUPPORTED = dispose(ResultCodeEnum.REQ_MODE_NOT_SUPPORTED); public final static ResultCode SYS_ERROR = dispose(ResultCodeEnum.SYS_ERROR); private static ResultCode dispose(ResultCodeEnum codeEnum) { return ResultCode.builder().code(codeEnum.getCode()).msg(codeEnum.getMsg()).build(); } public ResultCode(int code, String msg) { this.code = code; this.msg = msg; }}
关于“SpringBoot如何实现统一封装返回前端结果集”这篇文章的内容就介绍到这里,感谢各位的阅读!相信大家对“SpringBoot如何实现统一封装返回前端结果集”知识都有一定的了解,大家如果还想学习更多知识,欢迎关注编程网精选频道。
--结束END--
本文标题: SpringBoot如何实现统一封装返回前端结果集
本文链接: https://www.lsjlt.com/news/340684.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑,方便收藏和打印~
2024-05-09
2024-05-09
2024-05-09
2024-05-09
2024-05-09
2024-05-09
2024-05-09
2024-05-09
2024-05-09
2024-05-09
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
0