为了前端能够方便的使用后端提供的响应，要保证一个项目中所有接口返回的数据格式的统一并置于响应体中。其中将响应置于响应体的注解是 @ResponseBody
本文记录了响应格式统一的方法，实际开发时，参考本文复制并设置即可。

统一格式的做法很简单，共分为两步“封装ResponseResult类 – 利用此类返回数据”

响应格式统一

要实现响应格式统一只需要两个步骤，直接复制下面的代码即可。

封装ResponseResult类

封装 ResponseResult 类，里面设定：

• code：状态码，前端代码根据这个状态码了解请求是否成功，并对不同请求码做出不同处理。
• msg：给提示信息
• data：实际响应数据放入此中

@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResponseResult<T> {
    /**
     * 状态码
     */
    private Integer code;
    /**
     * 提示信息，如果有错误时，前端可以获取该字段进行提示
     */
    private String msg;
    /**
     * 查询到的结果数据，
     */
    private T data;

    public ResponseResult(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public ResponseResult(Integer code, T data) {
        this.code = code;
        this.data = 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 T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public ResponseResult(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
}

Handle 方法使用 ResponseResult 类返回

• 调用 Service 查询道到的数据不直接返回，而是先行接收。
• 返回时使用 ResponseResult 的匿名内部类，传入参数。上面接收的查询结果，作为data传入。

@RestController
@RequestMapping("/user")
public class UserController {
    public ResponseResult findAll(){
        //调用 Service 查询数据，进行返回接收
        List<User> users = userService.findAll();
        //然后用上面封装的 ResponseResult 的匿名内部类返回
        return new ResponseResult(200,users);
    }
}

Tips：

1. 使用 ctrl + p 查看传参提示
2. code 表示 当前操作的结果，代码 200 表示成功，后面在前端代码中会进行判断。前端获取到 code 后可以判断 是否为 200 以判断能操作成功与否，并进行不同处理。

将响应放入响应体

使用 @ResponseBody 注解即可，此注解可以放在 类 或 方法 上。
此注解可以和 @Controller 形成一个合成注解 @RestController