统一封装接口返回(ApiResponse)

package com.warren.common.entity;

import com.warren.common.config.message.BusinessMessageResouseConfig;
import com.warren.common.utils.StringUtil;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;
import java.util.Map;
import java.util.Objects;

/**
 * @PackageName org.sulotion.entity
 * @ClassName Result
 * Version v1.0
 * @description 返回POJO类
 */
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
@ApiModel(value = "ApiResponse", description = "ApiResponse")
public class ApiResponse<T> implements Serializable {

    @ApiModelProperty(value = "code ")
    private String code;
    @ApiModelProperty(value = "message ")
    private String message;
    @ApiModelProperty(value = "info ")
    private T info;

    public static final String CODE_OK = "0000";
    public static final String CODE_ERROR = "1111";
    public static final String CODE_VALID = "0001";
    public static final String CODE_EXPIRE = "0002";
        public static final String NO_DATA = "0402";


    public ApiResponse() {

    }

    public ApiResponse(String msg) {
        this.code = CODE_VALID;
        this.message = msg;
    }

    public ApiResponse(String code, String msg) {
        this.code = code;
        Map<String, String> msgPropertiesMap = BusinessMessageResouseConfig.msgPropertiesMap;
        if(StringUtil.isNotEmpty(msgPropertiesMap.get(msg))) {
            this.message = msgPropertiesMap.get(msg);
        } else {
            this.message = msg;
        }

    }

    public static ApiResponse resultValid(String msg) {
        ApiResponse responseResult = new ApiResponse();
        responseResult.setCode(CODE_VALID);
        responseResult.setMessage(StringUtil.isNotEmpty(BusinessMessageResouseConfig.msgPropertiesMap.get(msg))?  BusinessMessageResouseConfig.msgPropertiesMap.get(msg) : msg);
        return responseResult;
    }


    /**
     * @MethodName: Result
     * @Description: 普通返回
     * @Param: String code, String msg,Object info
     * @Return:
     * @Author: 
     * @Date: 17:37
    **/
    public ApiResponse(String code, String msg, T info) {
        this.code = code;
        Map<String, String> msgPropertiesMap = BusinessMessageResouseConfig.msgPropertiesMap;
        String msg_temp = msgPropertiesMap.get(msg);
        if(StringUtil.isNotEmpty(msg_temp)) {
            this.message = msg_temp;
        } else {
            this.message = msg;
        }
        this.info = info;
    }

    /**
     * @MethodName: Result
     * @Description: 占位符替换
     * @Param: String code, String msg, Object info, List<String> params
     * @Return:
     * @Author: 
     * @Date: 17:36
    **/
    public ApiResponse(String code, String msg, T info, String[] params) {
        this.code = code;
        Map<String, String> msgPropertiesMap = BusinessMessageResouseConfig.msgPropertiesMap;
        String temp = msgPropertiesMap.get(msg);
        String[] msgList = StringUtil.splitString(temp, "%");
        if (params.length + 1 == msgList.length) {
            int k = 0;
            String msgInfo = msgList[0];
            for (int i = 1; i < msgList.length; i++) {
                k = i - 1;
                msgInfo += params[k]+ msgList[i];
            }
            this.message = msgInfo;
        }
        this.info = info;
    }

    public ApiResponse(String code, String msg, String[] params) {
        this.code = code;
        Map<String, String> msgPropertiesMap = BusinessMessageResouseConfig.msgPropertiesMap;
        String temp = msgPropertiesMap.get(msg);
        String[] msgList = StringUtil.splitString(temp, "%");
        if (params.length + 1 == msgList.length) {
            int k = 0;
            String msgInfo = msgList[0];
            for (int i = 1; i < msgList.length; i++) {
                k = i - 1;
                msgInfo += params[k]+ msgList[i];
            }
            this.message = msgInfo;
        }
    }


    /**
     * @MethodName: success
     * @Description: 成功返回且无数据
     * @Param:
     * @Return:
     * @Author: 
     * @Date: 17:37
    **/
    public static ApiResponse success() {
        return new ApiResponse(CODE_OK, "msg0000");
    }

    /**
     * @MethodName: success
     * @Description: 成功返回有数据
     * @Param:
     * @Return:
     * @Author: 
     * @Date: 17:37
     **/
    public static ApiResponse successObj(Object object) {
        return new ApiResponse(CODE_OK, "msg0000",object);
    }


    /**
     * @MethodName: error
     * @Description: 错误返回且无数据
     * @Param:
     * @Return:
     * @Author: 
     * @Date: 17:37
    **/
    public static ApiResponse error() {
        return new ApiResponse(CODE_ERROR, "msg1111");
    }

    public static ApiResponse error(String errMsg) {
        return new ApiResponse(CODE_ERROR, "errMsg",errMsg);
    }


    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getInfo() {
        return info;
    }

    public void setInfo(T info) {
        this.info = info;
    }

    @Override
    public String toString() {
        return "Result{" +
                "code='" + code + '\'' +
                ", message='" + message + '\'' +
                ", info=" + info +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof ApiResponse)) {
            return false;
        }
        ApiResponse responseResult = (ApiResponse) o;
        return Objects.equals(getCode(), responseResult.getCode()) &&
                Objects.equals(getMessage(), responseResult.getMessage()) &&
                Objects.equals(getInfo(), responseResult.getInfo());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getCode(), getMessage(), getInfo());
    }
}

全量分析 阅读量：

评 论：