服務器接口統一響應數據格式-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     }

        


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM