Spring Boot 设置统一的接口返回格式

如下创建两个实体类：枚举类ResponseCode和接口实现类ServerResponse。

public enum ResponseCode {

    SUCCESS(200,"SUCCESS"),

    ERROR(1, "ERROR"),

    FORBIDDEN(403,"FORBIDDEN");

    private final int code;

    private final String desc;

    ResponseCode(int code,String desc){
        this.code = code;
        this.desc = desc;
    }

    public int getCode(){
        return code;
    }

    public String getDesc(){
        return desc;
    }

}

在接口实现类ServerResponse中引用枚举类ResponseCode中调用常量的方法，封装好返回格式。

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.io.Serializable;

//保证序列化json的时候，如果是null对象，key也会消失
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
public class ServerResponse<T> implements Serializable {

    private int status;

    private String msg;

    private T data;

    public ServerResponse(){}

    public ServerResponse(int status) {
        this.status = status;
    }

    private ServerResponse(int status, String msg) {
        this.status = status;
        this.msg = msg;
    }

    private ServerResponse(int status, String msg, T data) {
        this.status = status;
        this.msg = msg;
        this.data = data;
    }

    private ServerResponse(int status, T data) {
        this.status = status;
        this.data = data;
    }

    //使之不在json序列化结果当中
    @JsonIgnore
    public boolean isSuccess(){
        return this.status == ResponseCode.SUCCESS.getCode();
    }

    public int getStatus(){
        return status;
    }

    public T getData(){
        return data;
    }

    public String getMsg(){
        return msg;
    }

    public static <T> ServerResponse<T> createBySuccess(){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
    }

    public static <T> ServerResponse<T> createBySuccessMessage(String msg){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),msg);
    }

    public static <T> ServerResponse<T> createBySuccess(T data){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),data);
    }

    public static <T> ServerResponse<T> createByError(){
        return new ServerResponse<T>(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getDesc());
    }

    public static <T> ServerResponse<T> createByErrorMessage(String errorMessage){
        return new ServerResponse<T>(ResponseCode.ERROR.getCode(),errorMessage);
    }

    public static <T> ServerResponse<T> createByErrorCodeMessage(int errorCode, String errorMessage){
        return new ServerResponse<T>(errorCode,errorMessage);
    }

    public static <T> ServerResponse<T> createErrorCodeMessage(String errorMessage){
        return new ServerResponse<T>(ResponseCode.FORBIDDEN.getCode(),errorMessage);
    }

}

然后就可以根据不同的需求在controller方法中引用不同的返回格式给api接口了，例如

@PostMapping("/insertTabletData")
    public synchronized ServerResponse insertTabletData(@RequestBody TabletData tabletData, HttpServletRequest request) {
        tabletData.setCreateTime(new Date());
        tabletData.setLastUpdatedTime(new Date());
        tabletDataService.insertTabletData(tabletData);
        String msg = "添加成功";
        try {
            return ServerResponse.createBySuccessMessage(msg);
        } catch (Exception e) {
            e.printStackTrace();
            return ServerResponse.createByError();
        }
    }