Spring Boot 自定义响应工具类

Spring Boot 中创建一个自定义响应参数工具类，然后使用它进行返参给前端。

接口执行成功返参格式

{ 

	"success": true, 

	"data": null 

}

• success : 是否请求成功，布尔型，true 表示接口请求成功，false 表示执行失败；

• data : 服务端响应数据，对象类型；

接口执行异常返参格式

{
	"success": false,
	"errorCode": "1000"
	"message": "用户名不能为空"
}

• message: 服务端响应消息，字符串类型，当 success 为 false 时，此字段才会不为空，用于后端返回失败的原因，方便前端弹出提示消息；

• errorCode: 异常码，字符串类型，微服务中用的比较多，通常格式为服务的唯一标识 + 异常码进行返回，如 QMS100000, 这样做的好处是，当发生问题时，用于快速锁定是链路上的哪个服务出现了问题。

封装响参工具类

 

@Data
public class Response<T> implements Serializable {

    // 是否成功，默认为 true
    private boolean success = true;
    // 响应消息
    private String message;
    // 异常码
    private String errorCode;
    // 响应数据
    private T data;

    // =================================== 成功响应 ===================================
    public static <T> Response<T> success() {
        Response<T> response = new Response<>();
        return response;
    }

    public static <T> Response<T> success(T data) {
        Response<T> response = new Response<>();
        response.setData(data);
        return response;
    }

    // =================================== 失败响应 ===================================
    public static <T> Response<T> fail() {
        Response<T> response = new Response<>();
        response.setSuccess(false);
        return response;
    }

}