SpringBoot 封装统一响应体（一）

在上一篇 SpringBoot 参数校验 中我们对参数校验添加了异常处理，但是还是有不规范的地方，没有用统一响应体进行返回，在这篇文章中介绍如何封装统一响应体。

关于统一响应体的封装，没有一个标准答案，我在各种技术社区看了一遍，汇总了一个复用性比较好的方案。

1. 添加结果类枚举

在项目目录下面建一个 responseEntity 的 package，然后在里面建一个 ResultEnum 枚举类，添加如下代码：

这边介绍一下枚举类的用法。枚举类的作用实际上就是定义常量，如果不使用枚举类，通常采用静态常量来表示：

public static final Integer OK_CODE = 200;
public static final String OK_MESSAGE = "成功";
public static final Integer BAD_REQUEST_CODE = 400;
public static final String BAD_REQUEST_MESSAGE = "参数错误";

这样的话存在一些问题，一是字段表意不明，特别是看别人的代码时，会很懵逼；第二当业务规模增大之后，可能要维护成百上千的静态常量，如果都写在一个文件里面，容易造成命名混淆，阅读也比较麻烦。

然后使用枚举类定义常量就比较方便，相当于一个接口，使用时只需要封装内部的数据类型，并且限定数据域。而且对于不同的枚举变量，可以调用不同的处理方法（实现枚举类的抽象方法可以做到这一点）。关于枚举类的一些知识点汇总如下：

• 使用enum定义的枚举类默认继承了java.lang.Enum，实现了java.lang.Comparable接口，且不能继承其他类，也不可以被继承。但枚举类可以实现一个或多个接口；
• 枚举类的所有实例必须放在第一行显示，不需使用new，不需显示调用构造方法，每个变量都是public static final修饰的，最终以分号结束。在之后的反编译中，我们就可以理解枚举类其实也是颗语法糖；
• 枚举类的构造方法是私有的，默认的就是 private，所以不用再添加 private；

枚举类内部常用的方法：

• valueOf() ：返回当前枚举类的name属性，如果没有，则throw new java.lang.IllegalArgumentException()；
• values() ：是编译器自动生成的方法，Enum中并没有该方法，返回包括所有枚举变量的数组；
• toString() 和 name() ：两个方法一样，返回当前枚举类变量的name属性，如果觉得不够用，可以覆盖默认的 toString ，结合 SWITCH CASE 来灵活的实现 toString() 方法；
• ordinal() ：枚举类会给所有的枚举变量一个默认的次序，该次序从0开始，是根据我们定义的次序来排序的。而ordinal()方法就是获取这个次序（或者说下标）；
• compareTo() ：比较的是两个枚举变量的次序，返回两个次序相减后的结果；

定义了枚举类之后，在类的上面添加 lombok 的 @Getter 注解，给对象的每个属性添加 getter 方法，方便后面获取常量。例如要获取 OK 的状态码，就可以这样写：

ResultEnum.OK.getCode()

这边再解释下 @Data 、@Getter 和 @Setter 的区别：

• @Data：注解在类上；提供类所有属性的 getter 和 setter 方法，此外还提供了equals、canEqual、hashCode、toString 方法
• @Getter：注解在属性上：为属性提供 getter 方法；注解再类上表示当前类中所有属性都生成getter方法
• @Setter：注解在属性上:为属性提供 setter 方法；注解再类上表示当前类中所有属性都生成setter方法

2. 添加统一结果类

还是在 responseEntity 目录下面，建一个 ServerResponse 类，添加如下代码：

@Data
public class ServerResponse {
     
	private Boolean success;
    private Integer code;
    private String message;
    private Object data;

	// 构造方法设为私有
    private ServerResponse() {
     }

	public static ServerResponse ok(Object params) {
     
        ServerResponse serverResponse = new ServerResponse();
        serverResponse.setSuccess(ResultEnum.OK.getSuccess());
        serverResponse.setCode(ResultEnum.OK.getCode());
        serverResponse.setMessage(ResultEnum.OK.getMessage()); // 成功展示默认提示信息
        serverResponse.setData(params); // 返回传入的参数
        return serverResponse;
    }

	public static ServerResponse badRequest(@Nullable String message) {
     
        ServerResponse serverResponse = new ServerResponse();
        serverResponse.setSuccess(ResultEnum.BAD_REQUEST.getSuccess());
        serverResponse.setCode(ResultEnum.BAD_REQUEST.getCode());
        serverResponse.setMessage(message != null ? message : ResultEnum.BAD_REQUEST.getMessage()); // 校验失败传入指定的提示信息
        serverResponse.setData(null); // 校验失败不返回参数
        return serverResponse;
    }
}

在上面的代码中，成员变量和构造方法都是私有的，只有静态方法向外暴露。然后处理成功的方法，message 展示默认提示信息，即定义在枚举类里面的常量，data 是需要传给前端的 JSON 参数；处理参数错误的方法，message 展示传进去的错误信息，如果传的是 null ，则展示默认提示信息，即定义在枚举类里面的常量，data 是传给前端的参数，但是在参数错误的情况下就不需要传了，因此是 null 。

这里传入的异常信息 message 有可能是 null ，因此用了三目运算符进行判断，如果为 null ，就展示定义在枚举类中的信息。

顺带提一下，上面的代码中存在较多的模板代码，可以使用 lombok 的 @AllArgsConstructor 简化：

• @AllArgsConstructor ：向类中添加全参构造方法；
• @NoArgsConstructor ：向类中添加无参构造方法；

例如下面的 ServerResponse 类：

@Data
@AllArgsConstructor
public class ServerResponse {
     
	private Boolean success;
    private Integer code;
}    

在添加 @AllArgsConstructor 注解后，就等效于下面的代码：

@Data
public class ServerResponse {
     
	private Boolean success;
    private Integer code;

	public ServerResponse(Boolean success, Integer code) {
     
		this.success = success;
		this.code = code;
	}
}    

由于 Java 的类中可以包含一个或多个构造方法，以实现方法重载，因此 @AllArgsConstructor 和 @NoArgsConstructor 两个注解可以同时使用：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ServerResponse {
     
	private Boolean success;
    private Integer code;
}

方法重载：一个类中具有多个名称相同的方法，但是参数个数/类型/顺序不一致，调用的时候传进去什么样的参数，虚拟机就会找到对应的方法去执行。方法重载与返回值、访问修饰符无关。

因此上面统一结果类可以修改如下：

@Data
@AllArgsConstructor
public class ServerResponse {
     
	private Boolean success;
    private Integer code;
    private String message;
    private Object data;

	public static ServerResponse ok(Object params) {
     
        return new ServerResponse(
                ResultEnum.OK.getSuccess(),
                ResultEnum.OK.getCode(),
                ResultEnum.OK.getMessage(),
                params
        );
    }

	public static ServerResponse badRequest(@Nullable String message) {
     
        return new ServerResponse(
                ResultEnum.BAD_REQUEST.getSuccess(),
                ResultEnum.BAD_REQUEST.getCode(),
                message != null ? message : ResultEnum.BAD_REQUEST.getMessage(),
                null
        );
    }
}

这边有一个问题，Java 不支持参数默认值，假如在方法中声明了形参，但是调用的时候不传，编译会报错。可以通过方法重载或者工厂模式间接实现参数默认值，这里本人为了省事，直接传 null 了。

3. 控制层返回

在定义了统一结果类之后，就可以在接口中使用了。还是用之前那个方法，通过 POST 请求获取用户信息，再原封不动返回过去：

@PostMapping("validateUser")
public ServerResponse userValidate(@RequestBody @Validated UserDTO userDTO) {
     
    return ServerResponse.ok(null);
}

这边先给参数传 null ，不给前端进行返回，看一下响应的结果：

然后传递参数：

@PostMapping("validateUser")
public ServerResponse userValidate(@RequestBody @Validated UserDTO userDTO) {
     
    return ServerResponse.ok(userDTO);
}

看一下响应的结果：

4. 异常处理类使用统一响应体

然后我们给异常处理的方法也添加统一响应体：

@RestControllerAdvice
public class GlobalExceptionHandler {
     
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public ServerResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
     
        // 注意传进去的表达式有可能是 null
        // 因此在 ServerResponse 对 message 是否为 null 进行了判断
        // 如果是 null 就展示默认的提示内容
        return ServerResponse.badRequest(Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
    }

    // 其他异常处理方法
}

然后我们模拟一下参数异常的情况：

这样看起来是正常了，但是存在一个问题，后端判断参数异常的时候，因为我们捕获了异常，所以返回给前端的状态码还是 200 ，如何让状态码改为 400 呢？在 SpringBoot 中指定 HTTP 状态码主要有三种方式：

• HttpServletResponse
• @ResponseStatus
• ResponseEntity

这边使用第三种方式，具体的用法看一下代码应该就明白了。我们把刚才统一结果类的方法修改下：

public static ResponseEntity<ServerResponse> badRequest(@Nullable String message) {
     
	return new ResponseEntity<>(new ServerResponse(
    	ResultEnum.BAD_REQUEST.getSuccess(),
        ResultEnum.BAD_REQUEST.getCode(),
        message != null ? message : ResultEnum.BAD_REQUEST.getMessage(),
        null
    ), HttpStatus.BAD_REQUEST); // 使用 ResponseEntity 对象设置响应状态码
}

可以看到我们用一个 ResponseEntity 对象包裹了我们封装的响应体，然后返回了这个对象。其中第二个参数就是状态码，HttpStatus.BAD_REQUEST 就代表 400 。然后我们还要修改下异常处理类的返回类型：

@RestControllerAdvice
public class GlobalExceptionHandler {
     
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public ResponseEntity<ServerResponse> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
     
        return ServerResponse.badRequest(Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
    }

    // 其他异常处理方法
}

再来调试一下，这下状态码正常了：

在统一结果类中所有的方法都根据上面的示例进行修改即可，我这边添加了几个方法，给各位参考下，具体可以根据业务场景进行添加：

@Data
@AllArgsConstructor
public class ServerResponse {
     
    private Boolean success;
    private Integer code;
    private String message;
    private Object data;

    /**
     * 200 请求成功
     * @param params 传给前端的参数
     * @return ResponseEntity
     */
    public static ResponseEntity<ServerResponse> ok(Object params) {
     
        return new ResponseEntity<>(new ServerResponse(
                ResultEnum.OK.getSuccess(),
                ResultEnum.OK.getCode(),
                ResultEnum.OK.getMessage(), // 成功展示默认提示信息
                params // 传给前端的参数
        ), HttpStatus.OK); // 使用 ResponseEntity 对象设置响应状态码
    }

    /**
     * 201 创建成功
     * @return ResponseEntity
     */
    public static ResponseEntity<ServerResponse> created() {
     
        return new ResponseEntity<>(new ServerResponse(
                ResultEnum.CREATED.getSuccess(),
                ResultEnum.CREATED.getCode(),
                ResultEnum.CREATED.getMessage(),
                null
        ), HttpStatus.CREATED);
    }

    /**
     * 204 请求成功，没有响应体
     * @return ResponseEntity
     */
    public static ResponseEntity<ServerResponse> noContent() {
     
        return new ResponseEntity<>(null, HttpStatus.NO_CONTENT);
    }

    /**
     * 400 参数错误
     * @param message 自定义错误信息
     * @return ResponseEntity
     */
    public static ResponseEntity<ServerResponse> badRequest(@Nullable String message) {
     
        return new ResponseEntity<>(new ServerResponse(
                ResultEnum.BAD_REQUEST.getSuccess(),
                ResultEnum.BAD_REQUEST.getCode(),
                message != null ? message : ResultEnum.BAD_REQUEST.getMessage(), // 校验失败传入指定的提示信息
                null // 校验失败不返回参数
        ), HttpStatus.BAD_REQUEST);
    }
}

此外，@ResponseStatus 也是一种设置状态码常用的方法，只需要在 Controller 方法中加一个注解就可以：

@PostMapping("validateUser")
@ResponseStatus(code=HttpStatus.BAD_REQUEST, reason="参数异常")
public ServerResponse userValidate(@RequestBody @Validated UserDTO userDTO) {
     
    return ServerResponse.ok(userDTO);
}

参考

SpringBoot统一响应体解决方案
springboot 项目封装：统一结果，统一异常，统一日志
Java enum常见的用法
JAVA ENUM的用法详解
Java枚举类，你真的了解吗？
Spring Boot（一）指定Http响应状态码
springboot自定义http反馈状态码