Spring实现自定义Response类

2021-11-28

引入依赖

// JSON对象处理依赖
// https://mvnrepository.com/artifact/com.alibaba/fastjson
implementation group: 'com.alibaba', name: 'fastjson', version: '1.2.78'

// entity 中 @Data 等lombok注解依赖
// https://mvnrepository.com/artifact/org.projectlombok/lombok
compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.18.10'

Response模板类实现

import com.alibaba.fastjson.JSONObject;
import lombok.Data;

@Data
public class ServerResponseT<T> {

    String status;      // 成功 or 失败
    Integer code;       // 响应状态码
    String message;     // 响应信息
    Object data;        // 响应数据

    public static <T> ServerResponseT<T> getInstance(Class<T> t) {
        return new ServerResponseT<T>();
    }

    public static ServerResponseT<?> getInstance() {
        return new ServerResponseT();
    }

    public ServerResponseT<?> code(Integer code) {
        this.code = code;
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<?> message(String message) {
        this.message = message;
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<?> data(Object data) {
        this.data = data;
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<T> t_data(T data) {
        this.data = data;
        return (ServerResponseT<T>) this;
    }


    public ServerResponseT<T> responseEnum(ResponseEnum responseEnum) {
        this.code = responseEnum.code;
        this.message = responseEnum.message;
        return (ServerResponseT<T>) this;
    }

    public ServerResponseT<?> ok() {
        this.status = "success";
        return (ServerResponseT<?>) this;
    }

    public ServerResponseT<?> failed() {
        this.status = "failed";
        return (ServerResponseT<?>) this;
    }

    @Override
    public String toString() {
        JSONObject resultJson = new JSONObject();
        resultJson.put("code", this.code);
        resultJson.put("status", this.status);
        resultJson.put("message", this.message);
        resultJson.put("data", this.data);
        return resultJson.toString();
    }

    // 测试
    public static void main(String[] args) {
    }
}

Response枚举类实现

public enum ResponseEnum {

    SUCCESS(1000, "成功"),
    FAILED(1001, "失败"),

    // 登录类错误
    INTERNAL_ERROR(2001, "内部错误"),
    LOGIN_SUCCESS(2002, "登录成功"),
    LOGIN_FAILED(2003, "登录错误"),
    PASSWORD_WRONG(2004, "密码错误"),
    ACCOUNT_NOT_FOUND(2005, "账号不存在，请先注册"),
    ACCOUNT_NOT_LOGIN(2006, "账号未登录"),
    ACCOUNT_TYPE_WRONG(2007, "账号类型错误"),
    ACCOUNT_PRIVILEGE_WRONG(2008, "账号权限错误"),
    WECHAT_LOGIN_FAILED(3100,"微信登录失败,请重试"),
    WECHAT_USER_EXIST(3101,"微信号已注册"),
    WECHAT_USER_NOT_EXIST(3102,"微信号未注册"),
    USER_ALREADY_BIND_WECHAT(3103,"用户已绑定微信！"),
    WECHAT_BIND_FAILED(3104,"微信绑定失败，请重试"),

    // 注册类错误
    REGISTER_SUCCESS(3000, "注册成功"),
    REGISTER_FAILED(3001, "注册失败"),
    INVALID_PARAM(3002, "参数非法"),
    USERNAME_EXIST(3003, "用户名已被注册"),

    // 验证类错误
    TOKEN_EXPIRED(4001, "userToken失效"),
    TOKEN_ERROR(4002, "userToken不能为空"),
    TOKEN_INVALID(4010, "Token失效"),

    // 文件类错误
    FILE_TYPE_INVALID(7001, "文件类型错误"),

    // 数据类错误
    GET_SUCCESS(20000, "数据获取成功"),
    GET_FAILED(20001, "数据获取失败"),
    SAVE_SUCCESS(20002, "数据上传成功"),
    SAVE_FAILED(20003, "数据上传失败"),
    DATA_NOT_EXIST(20004, "数据不存在"),
    DATA_NOT_MATCH(20005, "数据不匹配"),

    ;

    Integer code;        // 响应码
    String message;      // 响应信息

    ResponseEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Boolean checkCode(Integer code) {
        return this.code.equals(code);
    }
}

Response实现

import com.alibaba.fastjson.JSONObject;
import lombok.Data;
import lombok.EqualsAndHashCode;

@EqualsAndHashCode(callSuper = true)
@Data
public class ServerResponse extends ServerResponseT{

    String status;      // 成功 or 失败
    Integer code;       // 响应状态码
    String message;		// 响应信息
    Object data;		// 响应数据

    public static  ServerResponse getInstance() {
        return new ServerResponse();
    }

    public  ServerResponse code(Integer code){
        this.code = code;
        return (ServerResponse) this;
    }

    public  ServerResponse message(String message){
        this.message = message;
        return (ServerResponse) this;
    }

    public  ServerResponse data(Object data){
        this.data = data;
        return (ServerResponse) this;
    }


    public  ServerResponse responseEnum(ResponseEnum responseEnum){
        this.code = responseEnum.code;
        this.message = responseEnum.message;
        return (ServerResponse) this;
    }

    public ServerResponse ok(){
        this.status = "success";
        responseEnum(ResponseEnum.SUCCESS);
        return (ServerResponse) this;
    }

    public ServerResponse failed(){
        this.status = "failed";
        responseEnum(ResponseEnum.FAILED);
        return (ServerResponse) this;
    }

    @Override
    public String toString() {
        JSONObject resultJson = new JSONObject();
        resultJson.put("code", this.code);
        resultJson.put("status", this.status);
        resultJson.put("message", this.message);
        resultJson.put("data", this.data);
        return resultJson.toString();
    }

    // 测试
    public static void main(String[] args) {
       JSONObject resultJSON = new JSONObject();
        resultJSON.put("userName", "曳戈泰尔");
        System.out.println(ServerResponse.getInstance().ok().responseEnum(ResponseEnum.SUCCESS).data(resultJSON));
    }
}

Data域实现

当返回多条数据时，增加total、pageSize、pageNum等属性。

import com.alibaba.fastjson.JSONObject;
import lombok.Data;

@Data
public class DataResponse {

    // 数据总数
    Integer total;
    // 当前返回页大小
    Integer pageSize;
    // 当前返回页编号
    Integer pageNum;
    // 返回数据
    Object data;

    public static DataResponse getInstance() {
        return new DataResponse();
    }

    public DataResponse total(Integer total) {
        this.total = total;
        return (DataResponse) this;
    }

    public DataResponse pageSize(Integer pageSize) {
        this.pageSize = pageSize;
        return (DataResponse) this;
    }

    public DataResponse pageNum(Integer pageNum) {
        this.pageNum = pageNum;
        return (DataResponse) this;
    }

    public DataResponse data(Object data) {
        this.data = data;
        return (DataResponse) this;
    }

    @Override
    public String toString() {
        JSONObject resultJson = new JSONObject();
        resultJson.put("total", this.total);
        resultJson.put("pageSize", this.pageSize);
        resultJson.put("pageNum", this.pageNum);
        resultJson.put("data", this.data);
        return resultJson.toString();
    }

}