SpringBoot+Vue项目系列教程-05-如何优雅地定义统一返回值

最新推荐文章于 2024-10-07 23:48:45 发布
最新推荐文章于 2024-10-07 23:48:45 发布
阅读量1.2k 收藏 3
点赞数 2
文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liuzhidong123/article/details/111361813
版权

前言

在一个后台中会有很多的接口，所有接口返回统一的结果无疑是非常重要。返回结果中无非包括两个方面的信息，状态（是否成功）和数据，状态是必须的，数据不是必须的。如登录接口，返回结果中只有是否登录成功；获取列表信息的接口，则包括是否成功和成功的对应数据列表。

后端返回给前端的统一结果一般用json定义，

 {
     //状态码
     code:200,
     //与状态码对应的描述信息
     msg:"成功",
     //携带的数据，可为空
     data:{}
 }

如何定义这个结果呢？我们从设计的角度来讲，然后一步一步优化。

将结果封装成对象

将返回值封装成对象，然后在Controller中创建这个对象并返回。

 @Data
 public class Result{
     private Integer code;
     private String msg;
     private Object data;
 }

然后在Controller中

 package com.hgt.controller;
 
 import com.hgt.pojo.Result;
 import com.hgt.pojo.ResultCode;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 @RequestMapping(path = "api")
 public class HelloController {
     @RequestMapping(path = "result")
     public Result testResult(){
         return new Result(1,"成功",null);
     }
 }
 

返回值为：{"code":1,"msg":"成功","data":null}

这种方式也能用，但是缺点也很明显：

  1. code与msg可随意定义，没有统一标准，出问题后无法查询
  2. 接口应只专注于业务，每个接口都创建一个Result对象显然不合适

解决第一个问题

我们看一下HTTP请求常见的状态码：

 200 - 请求成功
 301 - 资源（网页等）被永久转移到其它URL
 404 - 请求的资源（网页等）不存在
 500 - 内部服务器错误

分类分类描述1**信息，服务器收到请求，需要请求者继续执行操作2**成功，操作被成功接收并处理3**重定向，需要进一步的操作以完成请求4**客户端错误，请求包含语法错误或无法完成请求5**服务器错误，服务器在处理请求的过程中发生了错误

接口返回的状态其实和上面很相似，也是固定的、有限的若干个。

既然是固定的，可以使用枚举类型定义返回值状态

 package com.hgt.pojo;
 
 //返回结果的code&message
 public enum ResultCode {
     // 成功
     SUCCESS(1, "成功"),
     FAIL(500,"异常"),
     // 参数无效
     PARAM_IS_INVALID(1001, "无效参数"),
     PARAM_IS_BLANK(1002, "参数为空"),
     PARAM_IS_TYPE_ERROR(1003, "参数类型错误"),
     NO_PERMISSION(1004,"无权访问"),
     PARAM_MISSING(1005,"缺少参数");
 
 
     private Integer code;
     private String msg;
 
     ResultCode(Integer code, String msg) {
         this.code = code;
         this.msg = msg;
     }
 
     public Integer getCode() {
         return this.code;
     }
 
     public String getMsg() {
         return this.msg;
     }
 }

然后将ResultCode与返回数据重新封装成统一返回对象

 package com.hgt.pojo;
 
 import java.io.Serializable;
 
 /**
  * 统一返回结果的封装
  */
 public class Result implements Serializable {
     /*状态码*/
     private Integer code;
     /*状态对应的信息*/
     private String msg;
     /*返回值中的数据，可为空*/
     private Object data;
 
     /**
      * 含数据的返回结果
      *
      * @param resultCode 状态
      * @param data       数据
      */
     public Result(ResultCode resultCode, Object data) {
         this.code = resultCode.getCode();
         this.msg = resultCode.getMsg();
         this.data = data;
     }
 
     /**
      * 无数据的返回结果
      *
      * @param resultCode 状态
      */
     public Result(ResultCode resultCode) {
         this.code = resultCode.getCode();
         this.msg = resultCode.getMsg();
     }
 
     public Integer getCode() {
         return code;
     }
 
     public void setCode(Integer code) {
         this.code = code;
     }
 
     public String getMsg() {
         return msg;
     }
 
     public void setMsg(String msg) {
         this.msg = msg;
     }
 
     public Object getData() {
         return data;
     }
 
     public void setData(Object data) {
         this.data = data;
     }
 
     @Override
     public String toString() {
         return "Result{" +
                 "code=" + code +
                 ", msg='" + msg + '\'' +
                 ", data=" + data +
                 '}';
     }
 }
 

课后作业1：类中构造方法使用ResultCode而不使用code、msg想必大家都能理解吧？如果不理解的可以留言。

控制类对应接口修改为

 @RequestMapping(path = "result")
 public Result testResult() {
         // 无数据的返回值
 //        return new Result(ResultCode.SUCCESS);
         // 有数据的返回值
         return new Result(ResultCode.SUCCESS,"字符串代替数据");
 }

无数据的返回值：

 {"code":1,"msg":"成功","data":null}

有数据的返回值：

 {"code":1,"msg":"成功","data":"字符串代替数据"}

这样优化之后就解决了第一个问题。

在实际开发中，返回值的状态只能由项目经理根据需要往ResultCode中添加，写接口的人员只能使用；前端人员想查看所有文档，只需要查看状态的文档就可以了，这样很优雅地就解决了混乱的问题。

细心的小伙伴可能会发现，控制器返回时，都通过new关键字创建对象，这样显示很low，也很麻烦，下面我们进一步优化返回对象。

静态方法返回结果对象

分成两步：

  1. 构造方法改在private
  2. 创建静态方法，在静态方法中调用构造方法创建对象

具体代码为：

 package com.hgt.pojo;
 
 import java.io.Serializable;
 
 /**
  * 统一返回结果的封装
  */
 public class Result implements Serializable {
     /*状态码*/
     private Integer code;
     /*状态对应的信息*/
     private String msg;
     /*返回值中的数据，可为空*/
     private Object data;
 
     /**
      * 含数据的返回结果
      *
      * @param resultCode 状态
      * @param data       数据
      */
     private Result(ResultCode resultCode, Object data) {
         this.code = resultCode.getCode();
         this.msg = resultCode.getMsg();
         this.data = data;
     }
 
     /**
      * 无数据的返回结果
      *
      * @param resultCode 状态
      */
     private Result(ResultCode resultCode) {
         this.code = resultCode.getCode();
         this.msg = resultCode.getMsg();
     }
 
     /**
      * 状态成功，且无返回数据的返回值
      * @return
      */
     public static Result success() {
         return new Result(ResultCode.SUCCESS);
     }
 
     /**
      * 状态成功，且有返回数据的返回值
      * @param data 数据
      * @return
      */
     public static Result success(Object data) {
         return new Result(ResultCode.SUCCESS,data);
     }
 
     /**
      * 状态失败，且无数据的返回值
      * @param resultCode 返回的状态
      * @return 返回值
      */
     public static Result fail(ResultCode resultCode){
         return new Result(resultCode);
     }
 
     /**
      * 状态失败，且有数据的返回值
      * @param resultCode 不同的状态
      * @param data 数据
      * @return 返回值
      */
     public static Result fail(ResultCode resultCode,Object data) {
         return new Result(resultCode,data);
     }
 
     public Integer getCode() {
         return code;
     }
 
     public void setCode(Integer code) {
         this.code = code;
     }
 
     public String getMsg() {
         return msg;
     }
 
     public void setMsg(String msg) {
         this.msg = msg;
     }
 
     public Object getData() {
         return data;
     }
 
     public void setData(Object data) {
         this.data = data;
     }
 
     @Override
     public String toString() {
         return "Result{" +
                 "code=" + code +
                 ", msg='" + msg + '\'' +
                 ", data=" + data +
                 '}';
     }
 }

控制器中的代码为：

 @RequestMapping(path = "result")
 public Result testResult() {
     // 无数据的返回值
     return Result.success("成功的数据列表");
     // 有数据的返回值
     // return Result.success("字符串代替数据");
 }

返回的数据与上同，但静态调用的方式显然比每次都new一个对象优雅的多。

但目前还不是最优雅的。我们在每个接口中创建的Result对象其它与业务并无关系，只要为了统一的返回值才这样做的。

能否让接口只专注于业务的处理，无论接口返回值是什么对象，都在其它地方能处理成统一的返回格式的呢？这就是要解决的第二个问题。

思路是这样的：

  1. 增加一个自定义注解类，表示接口返回值都要统一包装
  2. 在控制器类或方法中使用此注解
  3. 定义拦截器，使用拦截器对所有请求对所有请求拦截，将所有使用@ResponseResult注解的类和方法做统一处理
  4. 注册拦截器，拦截所有请求
  5. 重新封装返回体

这一部分内容比较重要，也比较难，涉及到自定义注解、拦截器等知识点，所在放在下一节单独讲，代码同步更新。我在网上查询了一下，还没有哪个博客写的这么详细，详细到直接可以用到自己的项目当中。而且这部分功能是SpringBoot项目标配的功能，适用于所有的SpringBoot项目，期待吧！！！

项目代码：https://github.com/316620938/shop-springboot.git

SpringBoot+Vue+Redis实现前后端分离的字典缓存机制
BADAO_LIUMANG_QIZHI的博客
09-01 5838
场景 前端使用Vue+ElementUI,要显示下拉框，下拉框的字典数据从数据库中的字典表中获取。 但是如果每次下拉框都要项后台发动请求数据库的请求，性能可想而知。 所以可以在查询下拉框的字典数据时先从Redis缓存中查找，如果有则直接返回，如果没有再从数据库中查询并将其存进Redis缓存中。 注： 博客：https://blog.csdn.net/badao_liumang_qizhi 关注公众号 霸道的程序猿 获取编程相关电子书、教程推送与免费下载。 实现 首先数据库设计一个字典表。具体字
黑马程序员ssm总结[大全版本,有对应pdf+源码](spring-＞springmvc--＞springboot--＞maven高级-＞cloud微服务)
m0_67402125的博客
07-30 843
既可以解决多个应用间配置共享的问题，
vue等两个接口都返回结果再执行下一步的实例
01-19
next 只能調用一次，這邊可以用 Promise.all 解決，等待兩個異步操作都返回結果後再 next: beforeRouteEnter (to, from, next) { // Promise.all 會等到數組內的 Promise 都 resolve 後才會繼續跑(then) Promise.all([ main._base({ methodName: 'QueryProductInfo', productId: to.params.id }), main._base({ methodName: 'QueryProductReview',
Spring Boot 2.x（六）：优雅的统一返回值
weixin_30868855的博客
12-28 1161
目录 为什么要统一返回值 ReturnVO ReturnCode 使用ReturnVO 使用AOP进行全局异常的处理 云撸猫 公众号 为什么要统一返回值 在我们做后端应用的时候，前后端分离的情况下，我们经常会定义一个数据...
基于SpringBoot + Vue的博客系统
最新发布
星码绘梦的博客
10-07 657
❤️博主介绍❤️：在数字的海洋里，我是“星码绘梦”，一个用代码编织梦想的旅者。在无尽的虚拟世界中，我以键盘为舟，以逻辑为帆，航行在信息的浪潮之上。每行代码都是我探索未知的足迹，每个程序都是我心中梦想的映射。我是创造者，也是诗人，用0和1的音符，谱写着未来的乐章。在星码绘梦的世界里，我让想象成为现实，让梦想照进代码的光辉。全栈开发人员🎉，专注于为大学生提供毕业设计支持。分享实用的编程资源、源代码，并提供定制化技术咨询💡。欢迎关注👋👇🏻精选专栏，推荐订阅👇🏻计算机毕业设计最强指南✅。
vue 方法获取返回值_vue.js 在一个方法中访问另一个方法的返回值
weixin_39935571的博客
12-19 4478
vue.js 在一个方法中访问另一个方法的返回值doScan(){var face_token = "";var image_base64 = "";var api_key = "kPGvG79PCMXPthX8utdJ6GULYklk-xdW";var api_secret = "i6VEDBRy9YX8U4gcD0oTa-NXMpZr5aYZ";var requestData = {};req...
SpringBoot全局Controller返回值格式统一处理
Charge8的博客
01-04 2276
SpringBoot全局Controller返回值格式统一处理
springboot2之优雅处理返回值
kingwinstar的博客
08-30 670
前言 最近项目组有个老项目要进行前后端分离改造，应前端同学的要求，其后端提供的返回值格式需形如 { "status": 0, "message": "success", "data": { } } 方便他们统一进行处理。要实现前端同学这个需求，其实也挺简单的，仅需做如下改造，新增一个返回对象，形如 @Data @AllArgsConstructor @NoArgsConstructor @Builder public class Result<T> { pub
前端-Vue.js从入门到精通基础笔记（理论+实操+知识点速查）
Only-CYY的博客
07-05 3953
【2022.3】尚硅谷Vue.js从入门到精通基础笔记（理论+实操+知识点速查）
Spring Boot入门到精通（超详细）
qq_41627024的博客
06-06 6129
本文主要讲了Springboot从基础到高阶涉及到的相关技术，让读者能够快速入门，深入了解Springboot框架，并能够熟练的使用springboot，快速提升个人技能。
SpringBoot之定义接口返回类型有几种方式？
weixin_62421895的博客
08-22 1176
当指定了 accept 时，并且传参中指定了 mediaType，则以传参为准。
SpringBoot拦截器返回前端Vue数据
小羽的博客
11-07 1054
拦截器返回数据 // 获得response HttpServletResponse httpResponse = (HttpServletResponse) response; // 服务器允许发送cookie httpResponse.setHeader("Access-Control-Allow-Credentials", "true"); // 允许接收请求的域名 httpResponse.setHeader("Access-Control-Allow-Origin", "http://localho
Springboot+vue 下拉框回显数据 无数据显示 报错
Maynor的博客
10-25 1052
问题一:无报错下拉一片空白 解决:未创建回显对象 问题二:查询后无数据返回 解决:字符类型用== 解决: 改成equals()
Vue笔记基础
小邹的博客
07-15 2981
​ 概念：一款渐进式 JavaScript 框架、所谓渐进式就是逐步实现新特性的意思、如实现模块化开发、路由、状态管理新特性。其特点是综合了Angular（模块化）和 React （虚拟DOM）的优点​ 注：Vue处理DOM、Axios处理前端通信框架、类似于AJAX与服务器进行交互、也可使用原生的jQuery的ajax进行通信。异步通信为主、Model、View、ViewModel​ 基于NodesJs，实际开发采用 vue-cli 脚手架，vue-router 路由（页面跳转），vuex做状态管理（类
SpringBoot：统一JSON信息返回
administratop的博客
09-16 7436
调用后端服务后的返回结果有多种类型，如：String，Integer，Boolean，List，Map等，在一个项目中，为了保持统一性，我们方法返回结果可以全部使用JSON数据格式，如下： { "code":200, "msg":"成功", "data":"JSON数据" } 其中code是本次请求处理结果对应的状态码，msg是状态码对应的解释信息，data是要返回的数据内容，可以是任意一个对象。 封装响应信息对象 public class ResponseEn.
SpringBoot
weixin_71169668的博客
01-07 351
【代码】【无标题】
【Java Web】005 -- 请求响应 & 分层解耦（Postman、三层架构、IOC、DI、注解）
汤姆lazy的CSDN博客
04-01 4659
请求响应 & 分层解耦，内容主要包括：Postman、三层架构、IOC（控制反转）、DI（依赖注入）、注解。
java05：封装前端页面数据的结果类
Arvan91的博客
09-10 1402
①新建返回结果中的代码类 ResultCode.java /** * 枚举了一些常用API操作码 */ public enum ResultCode implements IErrorCode { SUCCESS(200, "操作成功"), FAILED(500, "操作失败"), VALIDATE_FAILED(404, "参数检验失败"), UNAUTHO...
Vue在一个方法中获取另一个方法的返回值
hellotutu的博客
07-08 453
需要获取上述方法的返回值。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值