Result和ResultCode类，用于封装后端返回给前端的数据

盛世宏图  论坛元老 | 7 天前 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 1768|帖子 1768|积分 5304

统一响应处理


   在基于SpringBoot的前后端分脱离发模式下，后端程序员通常会更友好的返 回数据给前端，即统一返回数据的格式。通过统一的响应格式，可以提高前后端开辟的效率和协作的便利性。  思考：为什么要返回统一的标准格式？
一般情况下，SpringBoot的返回格式常见范例的有3种，


  • 第一种：返回 String
  1. @GetMapping("/getStr")
  2. public String getStr() {
  3.     return "Hello Java";
  4. }
复制代码


  • 第二种：返回自定义对象
  1. @GetMapping("/getObj")
  2. public Slideshow getObject() {
  3.         System.out.println("in getObject ...");
  4.         Slideshow slideshow = slideshowService.getOne(1);
  5.         return slideshow;
  6. }
复制代码
这两种方式调用接口获取到的返回值结果如下：



  • 第三种：接口出现异常
  1. @GetMapping("/error")
  2. public Object error(){
  3.         int i = 9 / 0;
  4.         return new Object();
  5. }
复制代码
运行结果如下：

基于以上种种情况，当我们和前端开辟人员联调接口他们会很懵逼，由于我们没有给他一个统一的格式，前端人员不知道如何处理返回值。以是我们项目中是必要定义一个统一的标准返回格式的。
一个标准的返回格式至少包含下面3部门：

  • code 状态值：由后端统一定义各种返回结果的状态码
  • message 描述：本次接口调用的结果描述
  • data 数据：本次返回的数据
Result封装了状态码,操作信息,响应数据

其中,状态码和操作信息已有枚举类 ResultCode
  1. package com.briup.product_source.result;
  3. import java.io.Serializable;
  5. /**
  6. * 统一Controller中RESTFul风格接口返回的结果
  7. */
  8. public class Result implements Serializable {
  10.         private static final long serialVersionUID = 1L;
  12.         private Integer code;
  13.         private String message;
  14.         private Object data;
  16.         public Result() {}
  18.         public Result(Integer code, String message) {
  19.                 this.code = code;
  20.                 this.message = message;
  21.         }
  23.         private void setResultCode(ResultCode code) {
  24.                 this.code = code.code();
  25.                 this.message = code.message();
  26.         }
  28.         /**
  29.          * 操作成功，没有返回的数据
  30.          */
  31.         public static Result success() {
  32.                 Result result = new Result();
  33.                 result.setResultCode(ResultCode.SUCCESS);
  34.                 return result;
  35.         }
  37.         /**
  38.          * 操作成功，有返回的数据
  39.          */
  40.         public static Result success(Object data) {
  41.                 Result result = new Result();
  42.                 result.setResultCode(ResultCode.SUCCESS);
  43.                 result.setData(data);
  44.                 return result;
  45.         }
  47.         /**
  48.          * 操作失败，没有返回的数据
  49.          */
  50.         public static Result failure(ResultCode resultCode) {
  51.                 Result result = new Result();
  52.                 result.setResultCode(resultCode);
  53.                 return result;
  54.         }
  56.         /**
  57.          * 操作失败，有返回的数据
  58.          */
  59.         public static Result failure(ResultCode resultCode, Object data) {
  60.                 Result result = new Result();
  61.                 result.setResultCode(resultCode);
  62.                 result.setData(data);
  63.                 return result;
  64.         }
  66.         /**
  67.          * 操作失败，自定义code和msg
  68.          */
  69.         public static Result failure(Integer code, String msg) {
  70.                 Result result = new Result(code,msg);
  71.                 return result;
  72.         }
  74.         public Integer getCode() {
  75.                 return code;
  76.         }
  78.         public void setCode(Integer code) {
  79.                 this.code = code;
  80.         }
  82.         public String getMessage() {
  83.                 return message;
  84.         }
  86.         public void setMessage(String message) {
  87.                 this.message = message;
  88.         }
  90.         public Object getData() {
  91.                 return data;
  92.         }
  94.         public void setData(Object data) {
  95.                 this.data = data;
  96.         }
  98. }
复制代码
ResultCode该类封装了固定的状态码和操作信息的枚举对象

  1. package com.briup.utils;
  2. /**
  3. * 统一并自定义返回状态码，如有需求可以另外增加
  4. */
  5. public enum ResultCode {
  6.         /* 成功状态码 */
  7.         SUCCESS(1, "操作成功"),
  8.         /* 参数错误：10001-19999 */
  9.         PARAM_IS_INVALID(10001, "参数无效"),
  10.         PARAM_IS_BLANK(10002, "参数为空"),
  11.         PARAM_TYPE_BIND_ERROR(10003, "参数类型错误"),
  12.         PARAM_NOT_COMPLETE(10004, "参数缺失"),
  13.         /* 用户错误：20001-29999*/
  14.         USER_NOT_LOGIN(20001, "用户未登录"),
  15.         USER_LOGIN_ERROR(20002, "账号不存在或密码错误"),
  16.         USER_ACCOUNT_FORBIDDEN(20003, "账号已被禁用"),
  17.         USER_NOT_EXIST(20004, "用户不存在"),
  18.         USER_HAS_EXISTED(20005, "用户已存在"),
  19.         /* 业务错误：30001-39999 */
  20.         SPECIFIED_QUESTIONED_USER_NOT_EXIST(30001, "业务逻辑出现问题"),
  21.         /* 系统错误：40001-49999 */
  22.         SYSTEM_INNER_ERROR(40001, "系统内部错误，请稍后重试"),
  23.         /* 数据错误：50001-599999 */
  24.         DATA_NONE(50001, "数据未找到"),
  25.         DATA_WRONG(50002, "数据错误"),
  26.         DATA_EXISTED(50003, "数据已存在"),
  27.         /* 接口错误：60001-69999 */
  28.         INTERFACE_INNER_INVOKE_ERROR(60001, "内部系统接口调用异常"),
  29.         INTERFACE_OUTTER_INVOKE_ERROR(60002, "外部系统接口调用异常"),
  30.         INTERFACE_FORBID_VISIT(60003, "该接口禁止访问"),
  31.         INTERFACE_ADDRESS_INVALID(60004, "接口地址无效"),
  32.         INTERFACE_REQUEST_TIMEOUT(60005, "接口请求超时"),
  33.         /* 权限错误：70001-79999 */
  34.         PERMISSION_NO_ACCESS(70001, "无访问权限");
  35.         private Integer code;
  36.         private String message;
  37.         ResultCode(Integer code, String message) {
  38.                 this.code = code;
  39.                 this.message = message;
  40.         }
  41.         public Integer code() {
  42.                 return this.code;
  43.         }
  44.         public String message() {
  45.                 return this.message;
  46.         }
  47. }
复制代码
上述标准写法，可以直接使用在自己的
下面是在学习中写的一个简朴的Result类：

此Result类可以应用于任何必要统一响应格式的后端服务中；定义一个统一的标准返回格式
  1. package com.briup.demo.response;
  3. import lombok.AccessLevel;  // 用于控制构造方法的访问级别
  4. import lombok.Builder;  // 用于生成构建器模式的代码
  5. import lombok.Getter;  // 用于生成属性的Getter方法
  7. /**
  8. * 所有给前端返回的响应数据的统一模型
  9. * 统一并自定义返回状态码，如有需求可以另外增加
  10. * @author YuYan
  11. * @date 2024-10-28 15:07:17
  12. *
  13. * 主要作用：用于封装后端向前端返回的响应数据，通过统一的响应格式
  14. * 通过状态码和消息来表示操作的结果，并可携带响应数据
  15. */
  16. // @Builder：使用lombok生成一个私有的构造器，方便创建Result对象
  17. @Builder(access = AccessLevel.PRIVATE)
  18. // @Getter：使用lombok为类的所有字段生成Getter方法
  19. @Getter
  20. public class Result {
  22.     private final static Integer SUCCESS = 1; // 成功的状态码
  23.     private final static Integer FAILURE = 0; // 失败的状态码
  25.     // 定义默认成功的和失败的消息
  26.     private final static String DEFAULT_SUCCESS_MESSAGE = "操作成功！";
  27.     private final static String DEFAULT_FAILURE_MESSAGE = "操作失败！";
  28.     // code：表示响应的状态码，0-失败，1-成功
  29.     private Integer code;
  30.     // 表示响应消息
  31.     private String message;
  32.     // 响应数据
  33.     private Object data;
  35.     // 静态方法：请求成功
  36.     public static Result success() {
  37.         return success(DEFAULT_SUCCESS_MESSAGE);
  38.     }
  39.     // 请求成功，指定自定义消息
  40.     public static Result success(String message) {
  41.         return success(message, null);
  42.     }
  43.     // 请求成功，默认消息为“操作成功”
  44.     public static Result success(Object data) {
  45.         return success(DEFAULT_SUCCESS_MESSAGE, data);
  46.     }
  47.     // 请求成功，返回一个成功的Result对象，指定自定义消息和响应数据
  48.     public static Result success(String message, Object data) {
  49.         return Result.builder()
  50.                 .code(SUCCESS)
  51.                 .message(message)
  52.                 .data(data)
  53.                 .build();
  54.     }
  56.     // 请求失败
  57.     public static Result failure() {
  58.         return failure(DEFAULT_FAILURE_MESSAGE);
  59.     }
  60.     // 返回一个失败的Result对象，指定自定义消息
  61.     public static Result failure(String message) {
  62.         return Result.builder()
  63.                 .code(FAILURE)
  64.                 .message(message)
  65.                 .build();
  66.     }
  68.     /**
  69.      * 该 Result 类定义了一个统一的响应格式，用于封装后端返回给前端的数据。通过状态码、操作信息和
  70.      * 响应数据的组合，确保所有接口返回的数据格式一致，便于前端解析和处理。
  71.      * Result类可以应用于任何需要统一响应格式的后端服务中，特别是在RESTful API开发中
  72.      *
  73.      * 常见的应用场景包括：
  74.      * 1、用户登录：返回登录或失败的信息
  75.      * 2、数据查询：返回查询结果的状态信息
  76.      * 3、数据修改：返回修改操作的结果和状态信息
  77.      * 4、文件上传：返回上传结果和状态信息
  78.      */
  79.    
  80.     /**
  81.      * RESTful API是一种基于HTTP协议的Web服务接口设计风格。REST（Representation State Transfer）
  82.      * 代表 ”表现层状态转换“，其核心思想是通过标准的HTTP方法（如GET、POST、PUT、DELETE等）对
  83.      * 资源进行操作。RESTful API设计的目标是使Web服务更加简单、可扩展和易于理解。
  84.      *
  85.      */
  87. }
复制代码
作用与应用场景


  • 统一响应格式：

    • 作用：确保所有接口返回的数据格式一致，便于前端剖析和处理。
    • 应用场景：适用于所有必要返回数据的接口，特别是在 RESTful API 开辟中。

  • 状态码和消息：

    • 作用：通过状态码和消息明确告知前端操作的结果，便于前端根据不同的状态码举行相应的处理。
    • 应用场景：用户登录、数据查询、数据修改、文件上传等。

  • 响应数据：

    • 作用：携带详细的响应数据，便于前端获取和展示。
    • 应用场景：查询结果、操作结果等。


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

盛世宏图

论坛元老
这个人很懒什么都没写!

楼主热帖

标签云

AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表