chenweida 7 роки тому
батько
коміт
265e746384

+ 43 - 0
common/common-rest-model/src/main/java/com/yihu/jw/restmodel/common/EnvelopList.java

@ -0,0 +1,43 @@
package com.yihu.jw.restmodel.common;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.yihu.jw.restmodel.common.base.BaseEnvelop;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.List;
/**
 * 信封对象,封装REST接口的返回值内容。包括:
 * - 页码
 * - 页大小
 * - 错误消息
 * - 错误代码
 * - 对象模型
 * <p>
 * 信封对象的返回场景:
 * - API使用者确实无法访问返回头,即一些语言库无法处理HTTP的响应消息,这时候需要以这种形式提供返回值。
 * - API需要支持交叉域请求(通过JSONP)。
 *
 * @author llh
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@ApiModel(value = "ListResult", description = "获取实体列表返回定义")
public class EnvelopList<T> extends BaseEnvelop implements Serializable {
    @ApiModelProperty("列表内容")
    private List<T> detailModelList;
    public EnvelopList(String errorMsg, String successMsg) {
        super(errorMsg, successMsg);
    }
    public List<T> getDetailModelList() {
        return detailModelList;
    }
    public void setDetailModelList(List<T> detailModelList) {
        this.detailModelList = detailModelList;
    }
}

+ 38 - 0
common/common-rest-model/src/main/java/com/yihu/jw/restmodel/common/EnvelopObj.java

@ -0,0 +1,38 @@
package com.yihu.jw.restmodel.common;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.yihu.jw.restmodel.common.base.BaseEnvelop;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
 * 信封对象,封装REST接口的返回值内容。包括:
 * - 页码
 * - 页大小
 * - 错误消息
 * - 错误代码
 * - 对象模型
 * <p>
 * 信封对象的返回场景:
 * - API使用者确实无法访问返回头,即一些语言库无法处理HTTP的响应消息,这时候需要以这种形式提供返回值。
 * - API需要支持交叉域请求(通过JSONP)。
 *
 * @author llh
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@ApiModel(description = "获取单个实体信息返回")
public class EnvelopObj<T> extends BaseEnvelop implements Serializable {
    @ApiModelProperty("内容")
    private T obj;
    public T getObj() {
        return obj;
    }
    public void setObj(T obj) {
        this.obj = obj;
    }
}

+ 136 - 0
common/common-rest-model/src/main/java/com/yihu/jw/restmodel/common/EnvelopPage.java

@ -0,0 +1,136 @@
package com.yihu.jw.restmodel.common;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.yihu.jw.restmodel.common.base.BaseEnvelop;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.List;
/**
 * 信封对象,封装REST接口的返回值内容。包括:
 * - 页码
 * - 页大小
 * - 错误消息
 * - 错误代码
 * - 对象模型
 * <p>
 * 信封对象的返回场景:
 * - API使用者确实无法访问返回头,即一些语言库无法处理HTTP的响应消息,这时候需要以这种形式提供返回值。
 * - API需要支持交叉域请求(通过JSONP)。
 *
 * @author llh
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@ApiModel(value = "PageResult<T>", description = "分页查询返回")
public class EnvelopPage<T> extends BaseEnvelop implements Serializable {
    private static final long serialVersionUID = 2076324875575488461L;
    @ApiModelProperty("每页大小 默认10")
    private int pageSize = 10;
    @ApiModelProperty("当前页")
    private int currPage;
    @ApiModelProperty("总共多少页")
    private int totalPage;
    @ApiModelProperty("总共多少数据")
    private int totalCount;
    @ApiModelProperty("所有满足条件的实体")
    private List<T> detailModelList;
    public int getTotalCount() {
        return totalCount;
    }
    public void setTotalCount(int totalCount) {
        this.totalCount = totalCount;
    }
    public List<T> getDetailModelList() {
        return detailModelList;
    }
    public void setDetailModelList(List<T> detailModelList) {
        this.detailModelList = detailModelList;
    }
    public String getErrorMsg() {
        return errorMsg;
    }
    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }
    public int getPageSize() {
        return pageSize;
    }
    public void setPageSize(int pageSize) {
        this.pageSize = pageSize;
    }
    public int getCurrPage() {
        return currPage;
    }
    public void setCurrPage(int currPage) {
        this.currPage = currPage;
    }
    public int getTotalPage() {
        if (totalCount % pageSize == 0) {
            totalPage = totalCount / pageSize;
        } else {
            totalPage = totalCount / pageSize + 1;
        }
        return totalPage;
    }
    public void setTotalPage(int totalPage) {
        this.totalPage = totalPage;
    }
    public String getSuccessMsg() {
        return successMsg;
    }
    public void setSuccessMsg(String successMsg) {
        this.successMsg = successMsg;
    }
    public static EnvelopPage getSuccess(String message) {
        EnvelopPage envelop = new EnvelopPage();
        envelop.setSuccessMsg(message);
        return envelop;
    }
    public static EnvelopPage getSuccessListWithPage(String message, List detailModelList, int page, int size, Long count) {
        EnvelopPage envelop = new EnvelopPage();
        envelop.setSuccessMsg(message);
        envelop.setPageSize(size);
        envelop.setDetailModelList(detailModelList);
        envelop.setCurrPage(page);
        envelop.setTotalCount(count.intValue());
        return envelop;
    }
    public static EnvelopPage getError(String message, int errorCode) {
        EnvelopPage envelop = new EnvelopPage();
        envelop.setErrorMsg(message);
        return envelop;
    }
    public static EnvelopPage getSuccessList(String message, List objList) {
        EnvelopPage envelop = new EnvelopPage();
        envelop.setSuccessMsg(message);
        envelop.setDetailModelList(objList);
        return envelop;
    }
}

+ 46 - 0
common/common-rest-model/src/main/java/com/yihu/jw/restmodel/common/base/BaseEnvelop.java

@ -0,0 +1,46 @@
package com.yihu.jw.restmodel.common.base;
/**
 * Created by chenweida on 2018/1/16.
 */
public class BaseEnvelop {
    protected String errorCode;
    protected String errorMsg;
    protected String successMsg;
    public BaseEnvelop() {
    }
    public BaseEnvelop(String errorCode, String errorMsg) {
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }
    public String getErrorMsg() {
        return errorMsg;
    }
    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }
    public String getSuccessMsg() {
        return successMsg;
    }
    public void setSuccessMsg(String successMsg) {
        this.successMsg = successMsg;
    }
    public String getErrorCode() {
        return errorCode;
    }
    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }
}