请求返回封装类

后端统一返回封装类

在我们使用springboot或者其他网络框架时，需要将一些数据信息（data），状态码信息（code），简明扼要的提示信息（message） 返回给前端。基于此，本文希望实现这一过程。

类的说明

类R：即我们的返回的封装类。代码如下：

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * @author yogurt 2023/10/26
 * 统一返回处理的工具类，包含 状态码 返回信息 接受的数据
 */

// 统一结果返回类
@Data
@AllArgsConstructor
public class R {
    //标识返回的状态码
    private Integer code;
    //标识返回的信息
    private String message;
    //标识返回的数据
    private Object data;
    //私有化，防止new
    private R() { }

    //成功
    public static R ok( String message,Object data) {
        return new R(200, message, data);  //code 也可以使用字典管理 下面会谈到
    }
    //成功返回 重载 message没有特别要求
    public static R ok(Object data) {
        return R.ok("success",data); //message 也可以使用字典管理 下面会谈到
    }

    // 失败 最好不要使用这个
    public static R error( Integer code, String message) {
        return new R(code, message, "");
    }
    // 失败
    public static R error(RHttpStatusEnum httpStatusEnum) {
        return new R(httpStatusEnum.getCode(),httpStatusEnum.getMessage(),"");
    }
    // 失败
    public static R error(RHttpStatusEnum httpStatusEnum,Object data) {
        return new R(httpStatusEnum.getCode(),httpStatusEnum.getMessage(),data);
    }

}

1 @Data 是 lombok 库中的一个注解，它可以帮助开发者自动生成一些常用的方法，如 get 和 set 方法、toString 方法、hashCode 方法、equals 方法等，即无需再显式书写get 和 set 方法。
2 @AllArgsConstructor 是 lombok 中的一个注解，它会在类上添加一个包含所有字段的构造器。因此可以在上述代码中调用全参构造方法。

RHttpStatusEnum：枚举类，即定义了返回类中的状态码信息（code），简明扼要的提示信息（message），利用它可以简化代码的书写。

/**
 * @author yogurt 2023/10/26
 */

public enum RHttpStatusEnum {

    //举个栗子 查询失败与登录失败
    QUERY_USER_FAIL(201, "查询失败"),
    LOGIN_USER_FAIL(202, "登录失败");

    final int code;
    final String message;
    RHttpStatusEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }
    //生成get方法  已经赋值了所以不需要set方法

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

该枚举类用于定义返回数据的 状态码，返回信息，比如我们常见的404表示页面不存在等，都可以自己在该枚举类中定义。
比如：QUERY_USER_FAIL(201, “查询失败”)
表示QUERY_USER_FAIL这个枚举，状态码为201，返回的提示信息是查询失败。

R2Controller：控制器类，用于测试响应返回封装类。代码如下：

import com.nm.dbweb.dbweb.entity.R;
import com.nm.dbweb.dbweb.entity.RHttpStatusEnum;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;

/**
 * @author yogurt 2023/10/26
 */

@RestController
@RequestMapping("rt")
public class R2Controller {

    @GetMapping("/test1")
    public R tets1(){
        String message = "成功";
        HashMap<String,String> map = new HashMap<>();
        map.put("id","1");
        map.put("name","yogurt ");
        return R.ok(map,message);
    }

    @GetMapping("/test2")
    public R test2(){
        return R.error(RHttpStatusEnum.QUERY_USER_FAIL);
    }

}

test2代码当中的 R.error(RHttpStatusEnum.QUERY_USER_FAIL) 会去调用，R类构造方法的倒数第二个构造方法。如下面的代码，会将参数枚举类的状态码，返回信息去构造，而数据则是空的字符串。

 // 失败
    public static R error(RHttpStatusEnum httpStatusEnum) {
        return new R(httpStatusEnum.getCode(),httpStatusEnum.getMessage(),"");
    }

通过控制器进行返回：
比如：访问链接：http://localhost:9638/rt/test2。

• http://localhost:9638：表示访问的主机ip为localhost，即127.0.0.1。
• 9638：表示端口号，可以根据自己的springboot配置文件进行配置。
• rt/test2：分别对应@RequestMapping(“rt”)，@GetMapping(“/test2”)，这样一个请求的地址，就可以唯一找到一个处理的函数了。

@RequestMapping和@GetMapping，可以先理解为寻找访问链接路径的手段，之后有机会会分享相关的文档~~

文件目录存放示意图

上图为springboot项目的文件存放结构。

调用接口调试工具

后记

希望该文可以帮助到您~
感谢您能看到这里~
欢迎批评指正奥~