org.swiftboot.web.result.HttpResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swiftboot-web Show documentation
Basic module for enterprise web applications
There is a newer version: 2.4.7
package org.swiftboot.web.result;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.swiftboot.web.exception.ErrMessageException;
import org.swiftboot.web.exception.ErrorCodeSupport;

import java.io.IOException;
import java.io.Serializable;

/**
 * 通用的 HTTP(S) 请求的返回对象
 *
 * @param  内容对象的类型
 * @author swiftech
 */
@ApiModel
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class HttpResponse implements Serializable {

    /**
     * 业务错误代码，长度4个字节的数字
     */
    @ApiModelProperty(value = "Error code", required = true, example = "1000")
    protected String code = ErrorCodeSupport.CODE_OK;

    /**
     * 错误代码对应的错误信息
     */
    @ApiModelProperty(value = "Error message", required = false, example = "OK")
    protected String msg = null;

    /**
     * 错误资源中的参数值
     */
    @JsonIgnore
    protected String[] msgParams;

    /**
     * 返回的对象
     */
    @ApiModelProperty(value = "Result data object")
    protected T result;

    public HttpResponse() {
    }

    public HttpResponse(T result) {
        this.result = result;
    }

    public HttpResponse(String code) {
        this.code = code;
    }

    public HttpResponse(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public HttpResponse(String code, T result) {
        this.code = code;
        this.result = result;
    }

    public HttpResponse(String code, String msg, T result) {
        this.code = code;
        this.msg = msg;
        this.result = result;
    }

    public HttpResponse(ErrMessageException errMsgException) {
        this.code = errMsgException.getErrorCode();
        this.msg = errMsgException.getMessage();
    }

    public String getCode() {
        return code;
    }

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

    public String[] getMsgParams() {
        return msgParams;
    }

    public void setMsgParams(String[] msgParams) {
        this.msgParams = msgParams;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getResult() {
        return result;
    }

    public void setResult(T result) {
        this.result = result;
    }

    public String toJson() throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        return mapper.writeValueAsString(this);
    }

    @Override
    public String toString() {
        ObjectMapper mapper = new ObjectMapper();
        try {
            return mapper.writeValueAsString(this);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
            return String.format("{\"error\":\"%s\"}", e.getLocalizedMessage());
        }
    }
}