服务器接口统一响应数据格式-ServerResponse

主要字段：

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

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

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

注：错误码公共类一起使用！

构造方法：

1.私有的

2.根据实际需求构造对应的函数：

I：status（int）只有状态码，对应业务办理类接口返回类型；

II：status（int）,data(T) 状态码和泛型数据，对应业务查询类型接口返回；

III：status（int）,msg(String) 状态码和响应信息，对应业务办理类接口返回类型；

IV：status（int），msg(String) ,data(T)，状态码、响应信息、泛型数据，对应业务查询类型接口返回；

公有对外便捷方法：

1、 isSuccess()方法，状态为000000（成功）即TRUE，否则FALSE

1 　　//响应是否正确的判断,通过注解在序列化时，isSuccess方法就不会在序列化里
2     @JsonIgnore
3     //添加该注解的方法不在json序列化结果当中
4     public boolean isSuccess(){//状态为000000（成功）即TRUE，否则FALSE
5         return this.status == ResponseCode.SUCCESS.getCode();
6     }

　　　　2、createBySuccess()方法，

1 　　//声明这个类，创建这个类，通过相应成功后，通过成功标志来构件这个类，最终返回一个status
2     public static <T> ServerResponse<T> createBySuccess(){
3         return  new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
4     }

　　　　3、createBySuccesssMessage()方法，

1 　　//通过文本显示成功，创建这个类，作用是供前端提示使用
2     public static <T> ServerResponse<T> createBySuccesssMessage(String msg){
3         return  new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),msg);
4     }

　　 4、 createBySuccesss(T data)方法，

1 　　//相应成功然后给前台相应数据
2     public static <T> ServerResponse<T> createBySuccesss(T data){
3         return  new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),data);
4     }

　　　　 5、createBySuccesss(String msg,T data)方法，

1 　　//相应成功然后给前台相应数据和文本消息
2     public static <T> ServerResponse<T> createBySuccesss(String msg,T data){
3         return  new ServerResponse<T>(ResponseCode.SUCCESS.getCode(),msg,data);
4     }

　　　　 6、createByError()方法，

1 　　//响应失败时，直接把错误返回
2     public static <T> ServerResponse<T> createByError(){
3         return  new ServerResponse<T>(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getDec());
4     }

　　　　 7、 createBySErrorMessage(String errorMessage)方法，

1 　　//直接返回错误信息
2     public static <T> ServerResponse<T> createBySErrorMessage(String errorMessage){
3         return  new ServerResponse<T>(ResponseCode.ERROR.getCode(),errorMessage);
4     }

　　　　 8、 createByErrorCodeMessage(int code,String errorMessage)方法，

1 　　//服务端响应，需要登录/参数错误
2     public static <T> ServerResponse<T> createByErrorCodeMessage(int code,String errorMessage){
3         return  new ServerResponse<T>(code,errorMessage);
4     }

服务器接口统一响应数据格式-ServerResponse

猜你喜欢