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

统一响应处理

思考：为什么要返回统一的标准格式？

一般情况下，SpringBoot的返回格式常见类型的有3种，

• 第一种：返回 String

@GetMapping("/getStr")
public String getStr() {return "Hello Java";
}

• 第二种：返回自定义对象

@GetMapping("/getObj")
public Slideshow getObject() {System.out.println("in getObject ...");Slideshow slideshow = slideshowService.getOne(1);return slideshow;
}

这两种方式调用接口获取到的返回值效果如下：

• 第三种：接口出现异常

@GetMapping("/error")
public Object error(){int i = 9 / 0;return new Object();
}

运行效果如下：

基于以上种种情况，当我们和前端开发人员联调接口他们会很懵逼，由于我们没有给他一个统一的格式，前端人员不知道如何处理返回值。所以我们项目中是需要定义一个统一的标准返回格式的。

一个标准的返回格式至少包含下面3部分：

1. code 状态值：由后端统一定义各种返回结果的状态码

2. message 描述：本次接口调用的结果描述

3. data 数据：本次返回的数据

Result封装了状态码,操作信息,响应数据

其中,状态码和操作信息已有枚举类 ResultCode

package com.briup.product_source.result;import java.io.Serializable;/*** 统一Controller中RESTFul风格接口返回的结果*/
public class Result implements Serializable {private static final long serialVersionUID = 1L;private Integer code;private String message;private Object data;public Result() {}public Result(Integer code, String message) {this.code = code;this.message = message;}private void setResultCode(ResultCode code) {this.code = code.code();this.message = code.message();}/*** 操作成功，没有返回的数据*/public static Result success() {Result result = new Result();result.setResultCode(ResultCode.SUCCESS);return result;}/*** 操作成功，有返回的数据*/public static Result success(Object data) {Result result = new Result();result.setResultCode(ResultCode.SUCCESS);result.setData(data);return result;}/*** 操作失败，没有返回的数据*/public static Result failure(ResultCode resultCode) {Result result = new Result();result.setResultCode(resultCode);return result;}/*** 操作失败，有返回的数据*/public static Result failure(ResultCode resultCode, Object data) {Result result = new Result();result.setResultCode(resultCode);result.setData(data);return result;}/*** 操作失败，自定义code和msg*/public static Result failure(Integer code, String msg) {Result result = new Result(code,msg);return result;}public Integer getCode() {return code;}public void setCode(Integer code) {this.code = code;}public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}public Object getData() {return data;}public void setData(Object data) {this.data = data;}}

ResultCode该类封装了固定的状态码和操作信息的枚举对象

package com.briup.utils;
/*** 统一并自定义返回状态码，如有需求可以另外增加*/
public enum ResultCode {/* 成功状态码 */SUCCESS(1, "操作成功"),/* 参数错误：10001-19999 */PARAM_IS_INVALID(10001, "参数无效"),PARAM_IS_BLANK(10002, "参数为空"),PARAM_TYPE_BIND_ERROR(10003, "参数类型错误"),PARAM_NOT_COMPLETE(10004, "参数缺失"),/* 用户错误：20001-29999*/USER_NOT_LOGIN(20001, "用户未登录"),USER_LOGIN_ERROR(20002, "账号不存在或密码错误"),USER_ACCOUNT_FORBIDDEN(20003, "账号已被禁用"),USER_NOT_EXIST(20004, "用户不存在"),USER_HAS_EXISTED(20005, "用户已存在"),/* 业务错误：30001-39999 */SPECIFIED_QUESTIONED_USER_NOT_EXIST(30001, "业务逻辑出现问题"),/* 系统错误：40001-49999 */SYSTEM_INNER_ERROR(40001, "系统内部错误，请稍后重试"),/* 数据错误：50001-599999 */DATA_NONE(50001, "数据未找到"),DATA_WRONG(50002, "数据错误"),DATA_EXISTED(50003, "数据已存在"),/* 接口错误：60001-69999 */INTERFACE_INNER_INVOKE_ERROR(60001, "内部系统接口调用异常"),INTERFACE_OUTTER_INVOKE_ERROR(60002, "外部系统接口调用异常"),INTERFACE_FORBID_VISIT(60003, "该接口禁止访问"),INTERFACE_ADDRESS_INVALID(60004, "接口地址无效"),INTERFACE_REQUEST_TIMEOUT(60005, "接口请求超时"),/* 权限错误：70001-79999 */PERMISSION_NO_ACCESS(70001, "无访问权限");private Integer code;private String message;ResultCode(Integer code, String message) {this.code = code;this.message = message;}public Integer code() {return this.code;}public String message() {return this.message;}
}

上述标准写法，可以直接使用在自己的

下面是在学习中写的一个简单的Result类：

此Result类可以应用于任何需要统一响应格式的后端服务中；定义一个统一的标准返回格式

package com.briup.demo.response;import lombok.AccessLevel;  // 用于控制构造方法的访问级别
import lombok.Builder;  // 用于生成构建器模式的代码
import lombok.Getter;  // 用于生成属性的Getter方法/*** 所有给前端返回的响应数据的统一模型* 统一并自定义返回状态码，如有需求可以另外增加* @author YuYan* @date 2024-10-28 15:07:17** 主要作用：用于封装后端向前端返回的响应数据，通过统一的响应格式* 通过状态码和消息来表示操作的结果，并可携带响应数据*/
// @Builder：使用lombok生成一个私有的构造器，方便创建Result对象
@Builder(access = AccessLevel.PRIVATE)
// @Getter：使用lombok为类的所有字段生成Getter方法
@Getter
public class Result {private final static Integer SUCCESS = 1; // 成功的状态码private final static Integer FAILURE = 0; // 失败的状态码// 定义默认成功的和失败的消息private final static String DEFAULT_SUCCESS_MESSAGE = "操作成功！";private final static String DEFAULT_FAILURE_MESSAGE = "操作失败！";// code：表示响应的状态码，0-失败，1-成功private Integer code;// 表示响应消息private String message;// 响应数据private Object data;// 静态方法：请求成功public static Result success() {return success(DEFAULT_SUCCESS_MESSAGE);}// 请求成功，指定自定义消息public static Result success(String message) {return success(message, null);}// 请求成功，默认消息为“操作成功”public static Result success(Object data) {return success(DEFAULT_SUCCESS_MESSAGE, data);}// 请求成功，返回一个成功的Result对象，指定自定义消息和响应数据public static Result success(String message, Object data) {return Result.builder().code(SUCCESS).message(message).data(data).build();}// 请求失败public static Result failure() {return failure(DEFAULT_FAILURE_MESSAGE);}// 返回一个失败的Result对象，指定自定义消息public static Result failure(String message) {return Result.builder().code(FAILURE).message(message).build();}/*** 该 Result 类定义了一个统一的响应格式，用于封装后端返回给前端的数据。通过状态码、操作信息和 * 响应数据的组合，确保所有接口返回的数据格式一致，便于前端解析和处理。* Result类可以应用于任何需要统一响应格式的后端服务中，特别是在RESTful API开发中** 常见的应用场景包括：* 1、用户登录：返回登录或失败的信息* 2、数据查询：返回查询结果的状态信息* 3、数据修改：返回修改操作的结果和状态信息* 4、文件上传：返回上传结果和状态信息*//*** RESTful API是一种基于HTTP协议的Web服务接口设计风格。REST（Representation State Transfer）* 代表 ”表现层状态转换“，其核心思想是通过标准的HTTP方法（如GET、POST、PUT、DELETE等）对* 资源进行操作。RESTful API设计的目标是使Web服务更加简单、可扩展和易于理解。**/}

作用与应用场景

1. 统一响应格式：

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

2. 状态码和消息：

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

3. 响应数据：

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