商城项目服务端实践SSM（二）-------创建服务器接口统一响应数据格式

因为此项目是前后端分离的，所以需要写一个服务器接口统一响应数据格式，以json的格式返回到前端，方便写方法的时候直接调用输出json格式。

 

主要字段：

            status（int） ------接口调用状态码

            msg(String)  ------接口需要响应的信息

            data(T)          ------接口相应的泛型数据对象

 

• ResponseCode

//服务器响应枚举设计
public enum ResponseCode {
    SUCCESS(0,"SUCCESS"),
    ERROR(1,"ERROR"),
    NEED_LOGIN(10,"NEED_LOGIN"),
    ILLEGAL_ARGUMENT(2," ILLEGAL_ARGUMENT");

    private final int code;
    private final String desc;

    ResponseCode(int code,String desc){
        this.code=code;
        this.desc=desc;
    }
    public int getCode(){
        return code;
    }
    public String getDesc(){
        return desc;
    }
}

 

• ServerResponse

import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.map.annotate.JsonSerialize;

import java.io.Serializable;

//返回的json数据格式
//声明相应的泛型序列化

/*
@JsonSerialize注解,主要用于数据转换,该注解作用在该属性的getter()方法上。
使用jackson进行序列化时，往往会遇到后台某个实体对象的属性为null，当序列化成json时对应的属性也为null；这样在某些前端组件上应用该json对象会报错。
在实体类前，增加@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) 注解
JSON原来经过JACKSON转换以后为{"name"："name","sex":null}
加入注解后，结果为{"name"："name"}
sex节点被去掉了
 */
@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)
public class ServerResponse<T> implements Serializable {
    private int status;
    private String msg;
    private T data;

    private ServerResponse(int status){
        this.status=status;
    }
    private ServerResponse(int status,T data){
        this.status=status;
        this.data=data;
    }
    private ServerResponse(int status,String msg,T data){
        this.status=status;
        this.msg=msg;
        this.data=data;
    }
    private ServerResponse(int status,String msg){
        this.status=status;
        this.msg=msg;
    }
    @JsonIgnore
    //使之不在序列化当中
    public boolean isSuccess(){
        return this.status==ResponseCode.SUCCESS.getCode();
    }

    public int getStatus(){
        return status;
    }

    public T getData() {
        return data;
    }

    public String getMsg() {
        return msg;
    }
    
    //成功返回status
    public static  <T> ServerResponse<T> createBySuccess(){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
    }
    //成功返回status和msg
    public static <T> ServerResponse<T> createBySuccessMessage(String msg){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),msg);
    }
    //成功返回status和data
    public static <T> ServerResponse<T> createBySuccess(T data){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),data);
    }
    //成功返回status，msg和data
    public static <T> ServerResponse<T> createBySuccess(String msg,T data){
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),msg,data);
    }

    public static <T> ServerResponse<T> createByError(){
        return new ServerResponse<T>(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getDesc());
    }
    public static <T> ServerResponse<T> createByErrorMessage(String errorMessage){
        return new ServerResponse<T>(ResponseCode.ERROR.getCode(),errorMessage);
    }
    public static <T> ServerResponse<T> createByErrorCodeMessage(int errorCode,String errorMessage){
        return new ServerResponse<T>(errorCode,errorMessage);
    }
}