服务响应对象设计

来源:互联网 发布:mac管理桌面图标 编辑:程序博客网 时间:2024/06/05 19:05

如果后端只需要为前端提供json数据时,我们可以考虑将后端的服务结果都封装成公用的对象,不仅可以简化代码而且形成统一的风格。下面就是一种可能的设计方式。其中,msg可以是返回给前端的错误信息或者提示信息,T泛型的data数据就是后端服务的结果,使用泛型之后就能够支持各种类型和自定义业务类型。

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)//保证序列化json的时候,如果是对象的value是null,key也会消失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.data = data;        this.status = status;        this.msg = msg;    }    private ServerResponse(int status, String msg) {        this.status = status;        this.msg = msg;    }    @JsonIgnore    public boolean isSuccess() {        return this.status == ResponseCode.SUCCESS.getCode();    }    //以下三个带有get方法的属性会添加到json中    public int getStatus() {        return status;    }    public T getData() {        return data;    }    public String getMsg() {        return msg;    }    //请求成功的接口。避免了T类型data不能包括String数据的问题。    public static <T> ServerResponse<T> createBySuccess() {        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());    }    public static <T> ServerResponse<T> createBySuccessMessage(String msg) {        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), msg);    }    public static <T> ServerResponse<T> createBySuccess(T data) {        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), 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);    }}
原创粉丝点击