SpringBoot教程(八) | SpringBoot统一结果封装

SpringBoot教程(八) | SpringBoot统一结果封装

经过了前面几篇文章，SpringBoot中MVC相关的配置其实都已经差不多了，接下来就可以完全进入接口开发阶段了。前面我们写过几个接口，虽然都加了@RestController注解，相当于统一了我们的返回数据的基本形式为JSON，但是由于我们的项目可能是很多人一起开发，所以我们最好能够把我们的返回结果统一一下，让大家都返回一样的数据格式，这样即规范了代码，也方便了前端人员的调用，不然每个人都按照每个人的风格去写，代码会变得非常混乱。

那我我们怎么还封装这个结果呢，那就要关注我们返回给前端的数据都要包含哪些信息。

一般来讲，首先要有一个code, 用来代表我们这次接口的一个状态，比如 0代表成功，1代表失败，2代表必传参数不对， 4代表系统异常等等。这只是个简单的举例。可能很多人会有疑问，Http协议本身不是已经有了相应的返回码的定义了么，比如200代表成功， 500代表服务器错误，404代表找不到页面，为啥咱们还要在定义呢，这就是划分粒度的问题了，就那200来说，它代表是这次请求成功了，但是它描述不了这次请求中的业务结果，比如用户名已存在，其实业务上就不是一种成功，但http的结果肯定是200，所以我们需要一种描述我们业务状态的编码。

除了编码之外，还有要一些提示信息，比如，操作成功，系统异常，用户名已存在等，所以我们再加一个messge字段。

还有什么呢，还有我们的核心数据，比如我根据id获取数据，那个这个数据的具体内容，我们肯定是必须要返回给前端呢，所以还要 有个data， 那这个data 用什么类型呢，这个类型肯定是五花八门，所以我们要用一个统一的父类，Object才可以接收所有类型，当然为了便于操作我们可以采用泛型的方式。

通过上面的分析，我们的这个类基本上就已经可以设计出来了。

java复制代码public class Result<T> implements Serializable {private static final long serialVersionUID = -3960261604605958516L;private int code;private String msg;private T data;// get set方法，限于篇幅问题，这里不写了，大家操作的时候自己生成一下。或者使用lombokpublic static <T> Result<T> success() {return new Result<>();}/*** 成功,默认状态码,返回消息,自定义返回数据** @param data 自定义返回数据* @param <T>  返回类泛型,不能为String* @return 通用返回Result*/public static <T> Result<T> success(T data) {return new Result<>(data);}/*** 成功,默认状态码,自定义返回消息,无返回数据** @param msg 自定义返回消息* @param <T> 返回类泛型* @return 通用返回Result*/public static <T> Result<T> success(String msg) {return new Result<>(msg);}/*** 成功,默认状态码,自定义返回消息,返回数据** @param msg  自定义返回消息* @param data 自定义返回数据* @param <T>  返回类泛型* @return 通用返回Result*/public static <T> Result<T> success(String msg, T data) {return new Result<>(msg, data);}/*** 失败,默认状态码,返回消息,无返回数据** @param <T> 返回类泛型* @return 通用返回Result*/public static <T> Result<T> error() {return new Result<>(ResultCode.ERROR);}/*** 失败,默认状态码,自定义返回消息,无返回数据** @param <T> 返回类泛型* @return 通用返回Result*/public static <T> Result<T> error(String msg) {return new Result<>(ResultCode.ERROR.getCode(), msg);}/*** 失败,自定义状态码,返回消息,无返回数据** @param code 自定义状态码* @param msg  自定义返回消息* @param <T>  返回类泛型* @return 通用返回Result*/public static <T> Result<T> error(int code, String msg) {return new Result<>(code, msg);}/*** 失败,使用CodeMsg状态码,返回消息,无返回数据** @param resultCode CodeMsg,参数如下:*                   <p> code 状态码*                   <p> msg  返回消息* @param <T>        返回类泛型* @return 通用返回Result*/public static <T> Result<T> error(ResultCode resultCode) {return new Result<>(resultCode);}/*** 成功构造器,无返回数据*/private Result() {this(ResultCode.SUCCESS);}/*** 成功构造器,自定义返回数据** @param data 返回数据*/private Result(T data) {this(ResultCode.SUCCESS, data);}/*** 成功构造器,自定义返回消息,无返回数据** @param msg 返回消息*/private Result(String msg) {this(ResultCode.SUCCESS.getCode(), msg);}/*** 成功构造器,自定义返回信息,返回数据** @param msg  返回信息* @param data 返回数据*/private Result(String msg, T data) {this(ResultCode.SUCCESS.getCode(), msg, data);}/*** 构造器,自定义状态码,返回消息** @param code 状态码* @param msg  返回消息*/private Result(int code, String msg) {this.code = code;this.msg = msg;}/*** 构造器,自定义状态码,返回消息,返回数据** @param code 状态码* @param msg  返回消息* @param data 返回数据*/private Result(int code, String msg, T data) {this(code, msg);this.data = data;}/*** 构造器,使用CodeMsg状态码与返回信息** @param resultCode CodeMsg,参数如下:*                   <p> code 状态码*                   <p> msg  返回消息*/private Result(ResultCode resultCode) {this(resultCode.getCode(), resultCode.getMsg());}/*** 构造器,使用CodeMsg状态码与返回信息,自定义返回数据** @param resultCode CodeMsg,参数如下:*                   <p> code 状态码*                   <p> msg  返回消息* @param data       返回数据*/private Result(ResultCode resultCode, T data) {this(resultCode);this.data = data;}}

在定义几个常见的错误：这里为了不写那么多的get，set,我们引入了lombok

java复制代码@Data
@Builder
public 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);/*** Json解析异常*/public final static ResultCode JSON_FORMAT_ERROR = dispose(ResultCodeEnum.JSON_FORMAT_ERROR);/*** Sql解析异常*/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;}
}
java复制代码public enum ResultCodeEnum {SUCCESS(0, "操作成功"),ERROR(1, "操作失败"),BIZ_ERROR(1000, "通用业务异常"),FILE_OUT_MAX(9000, "文件超出最大限制"),FILE_FORMAT_ERROR(9001, "文件格式不正确"),PARAM_ERROR(9050, "参数错误"),JSON_FORMAT_ERROR(9051, "Json解析异常"),SQL_ERROR(9052, "Sql解析异常"),NETWORK_TIMEOUT(9510, "网络超时"),UNKNOWN_INTERFACE(9520, "未知的接口"),REQ_MODE_NOT_SUPPORTED(9530, "请求方式不支持"),SYS_ERROR(9999, "系统异常");/*** 状态码*/private final int code;/*** 状态信息*/private final String msg;public int getCode() {return code;}public String getMsg() {return msg;}ResultCodeEnum(int code, String msg) {this.code = code;this.msg = msg;}
}

这个写完了以后，就可以统一我们的返回结果，以后所有的Controller就都要返回Result类型。比如：

java复制代码@GetMapping("/withinRangeResource")public Result<List<EmergencyExpertResVO>> withinRangeResource(@Valid ResourceRangeReqVO param) {List<EmergencyExpertResVO> expertResVOS = emergencyExpertBiz.getWithinRangeResource(param);return Result.success(expertResVOS);}

另： 配套项目代码已托管中gitCode: gitcode.net/lsqingfeng/…

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/625663.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

APP加固原理与作用

APP加固原理与作用

文章目录 引言正文1. 什么是APP加固&#xff0c;加固原理是什么&#xff1f;2. 加固的作用是什么&#xff1f;加固后是否完全不会被破解&#xff1f;3. 如何提前规避加固新版本可能带来的风险&#xff1f;4. 付费加固与免费加固的区别是什么&#xff1f; 白嫖的混淆加密工具总结…
阅读更多...
代码随想录刷题笔记（DAY11）

代码随想录刷题笔记（DAY11）

今日总结&#xff1a;继续准备期末&#xff0c;今天的算法题目比较简单&#xff0c;晚上看看能不能再整理一篇前端的笔记。 Day 11 01. 有效的括号&#xff08;No. 20&#xff09; 题目链接 代码随想录题解 1.1 题目 给定一个只包括 (&#xff0c;)&#xff0c;{&#xff…
阅读更多...
Python Data Structures: Dictionary, Tuples

Python Data Structures: Dictionary, Tuples

目录 Chapter9 Dictionary1. list and dictionary2. 修改值&#xff1a;3. 计算名字出现次数4. get()5. Dictionary and Files6. Retrieving lists of keys and values7.items()&#xff1a;产生tuples8.计算文件中的名字次数最大值 Chapter10 Tuples1. Tuples Are Like Lists2…
阅读更多...
Android-常用数据结构和控件

Android-常用数据结构和控件

HashMap 的原理 HashMap 的内部可以看做数组链表的复合结构。数组被分为一个个的桶(bucket)。哈希值决定了键值对在数组中的寻址。具有相同哈希值的键值对会组成链表。需要注意的是当链表长度超过阈值(默认是8)的时候会触发树化&#xff0c;链表会变成树形结构。 把握HashMap的…
阅读更多...
5 - 声明式事务

5 - 声明式事务

传统事务流程&#xff1a; Connection connection JdbcUtils.getConnection(); try {//1. 先设置事务不要自动提交connection.setAutoCommit(false);//2. 进行各种 crud//多个表的修改&#xff0c;添加 &#xff0c;删除select from 商品表 > 获取价格//修改用户余额updat…
阅读更多...
“确定要在不复制其属性的情况下复制此文件？”解决方案（将U盘格式由FAT格式转换为NTFS格式）

“确定要在不复制其属性的情况下复制此文件？”解决方案（将U盘格式由FAT格式转换为NTFS格式）

文章目录 1.问题描述2.问题分析3.问题解决3.1 方法一3.2 方法二3.3 方法三 1.问题描述 从电脑上复制文件到U盘里会出现“确定要在不复制其属性的情况下复制此文件&#xff1f;”提示。 2.问题分析 如果这个文件在NTFS分区上&#xff0c;且存在特殊的安全属性。那么把它从NT…
阅读更多...
请查收“链上天眼”2023年成绩单

请查收“链上天眼”2023年成绩单

1月10日是中国人民警察节&#xff0c;是一份责任&#xff0c;更一份安心&#xff0c;随着科技的发展&#xff0c;链上安全领域的技术与工具不断更新迭代&#xff0c;更加安全的Web3世界正在构建。 根据欧科云链安全团队统计&#xff0c;2023 年全球范围内利用虚拟货币进行诈骗…
阅读更多...
采购申请检查并警告提示

采购申请检查并警告提示

设置&#xff1a;采购申请检查并警告提示 增强&#xff1a;MEREQ001 EXIT_SAPLMEREQ_005 &--------------------------------------------------------------------- *& 包含 ZXM02U05 &--------------------------------------------------------------------- …
阅读更多...
Radzen Blazor Studio 脚手架框架解读

Radzen Blazor Studio 脚手架框架解读

背景 组织管理管理准备使用Blazor这个工具实现&#xff0c;因为其有对应的 scaffold 脚手架&#xff0c;先构建数据库&#xff0c;然后通过向导&#xff0c;生成CRUD以及对应的接口&#xff0c;那么有必要看一下&#xff0c;其内部的代码结构是什么样的。 结构 接口层 有两类…
阅读更多...
L1-024 后天(Java)

L1-024 后天(Java)

如果今天是星期三&#xff0c;后天就是星期五&#xff1b;如果今天是星期六&#xff0c;后天就是星期一。我们用数字1到7对应星期一到星期日。给定某一天&#xff0c;请你输出那天的“后天”是星期几。 输入格式&#xff1a; 输入第一行给出一个正整数D&#xff08;1 ≤ D ≤…
阅读更多...
布隆过滤器原理（易理解版）

布隆过滤器原理（易理解版）

当我们说布隆过滤器时&#xff0c;可以将其想象成一个特殊的盒子&#xff0c;这个盒子可以判断某个东西是否在里面。但是&#xff0c;这个盒子并不存储实际的东西&#xff0c;而是用一些特殊的方法来判断。 盒子&#xff08;位数组&#xff09;&#xff1a; 有一个盒子&#xf…
阅读更多...
Oracle sql sum函数返回null，默认值0

Oracle sql sum函数返回null，默认值0

在Oracle SQL中&#xff0c;当你使用SUM函数对一组值进行求和时&#xff0c;如果这组值中包含NULL&#xff0c;那么SUM函数将忽略这些NULL值&#xff0c;并返回非NULL值的总和。 如果你希望在SUM函数返回NULL时有一个默认值&#xff0c;你可以使用COALESCE或NVL函数。 使用CO…
阅读更多...
深度学习烦人的基础知识(1)---@在bash中的作用---positional parameter详解

深度学习烦人的基础知识(1)---@在bash中的作用---positional parameter详解

文章目录 序Positional parameter练习题 Special parameter练习题 序 深度学习&#xff0c;反展到现在&#xff0c;真的是要融会贯通很多东西。遇到便补吧&#xff01; 想直接知晓答案的&#xff0c;请到最后一个练习题&#xff0c;想补基础知识的&#xff0c;请按照顺序阅读…
阅读更多...
Python——for循环的嵌套

Python——for循环的嵌套

用Python坚持表白一百天&#xff0c;每天都送10朵花&#xff0c;一百天表白成功&#xff01; i1 for i in range(1,101):print(f"今天是表白的第{i}天&#xff0c;坚持ing")for j in range(1,11):print(f"送给你第{j}朵玫瑰花")print("小美我喜欢你&…
阅读更多...
Hive 的 安装与使用

Hive 的 安装与使用

目录 1 安装 MySql2 安装 Hive3 Hive 元数据配置到 MySql4 启动 Hive5 Hive 常用交互命令6 Hive 常见属性配置 Hive 官网 1 安装 MySql 为什么需要安装 MySql? 原因在于Hive 默认使用的元数据库为 derby&#xff0c;开启 Hive 之后就会占用元数据库&#xff0c;且不与其他客户…
阅读更多...
Mindspore 公开课 - prompt

Mindspore 公开课 - prompt

prompt 介绍 Fine-Tuning to Prompt Learning Pre-train, Fine-tune BERT bidirectional transformer&#xff0c;词语和句子级别的特征抽取&#xff0c;注重文本理解Pre-train: Maked Language Model Next Sentence PredictionFine-tune: 根据任务选取对应的representatio…
阅读更多...
算法通关村第十六关—滑动窗口经典问题(白银)

算法通关村第十六关—滑动窗口经典问题(白银)

滑动窗口经典问题 一、最长子串专题 1.1 无重复字符的最长子串 LeetCode3给定一个字符串s&#xff0c;请你找出其中不含有重复字符的最长子串的长度。例如&#xff1a; 输入&#xff1a;s"abcabcbb" 输出&#xff1a;3 解释&#xff1a;因为无重复字符的最长子串是…
阅读更多...
【Java万花筒】数据之舞：Java数据库连接与操作库全景视角

【Java万花筒】数据之舞：Java数据库连接与操作库全景视角

数据库连接与操作&#xff1a;Java 应用开发者的综合指南 前言 随着Java应用的不断发展&#xff0c;数据库连接与操作成为关键技能之一。本文将深入探讨主流Java库&#xff0c;涵盖了JDBC、Hibernate、MyBatis、Spring Data JPA、Apache Commons DBUtils、JOOQ以及Querydsl。…
阅读更多...
牛客周赛 Round 28 F

牛客周赛 Round 28 F

以后需要使用map&#xff0c;set进行二分&#xff0c;并且需要知道二分位置的信息时&#xff0c;不妨考虑使用树状数组进行维护 因为简单版本保证了每个数都为正整数&#xff0c;所以前缀和保证了一定的递增的&#xff0c;即有序的&#xff0c;那么考虑固定左端点&#xff0c;去…
阅读更多...
多线程并发与并行

多线程并发与并行

&#x1f4d1;前言 本文主要是【并发与并行】——并发与并行的文章&#xff0c;如果有什么需要改进的地方还请大佬指出⛺️ &#x1f3ac;作者简介&#xff1a;大家好&#xff0c;我是听风与他&#x1f947; ☁️博客首页&#xff1a;CSDN主页听风与他 &#x1f304;每日一句&…
阅读更多...
最新文章

Copyright @ 2022~2023