English Version

please click here to see English version. To explain how to retrieve data from non restful response to get the right data(I don't have much time to finish English version, please wait for more detail coverage).

中文版

效果展示

本文主要介紹了使用 Retrofit2 配合 Rxjava 來處理非 restful 的網路請求結果。一般而言請求的非 REST 結果如下：

{
    "status": 1,    //請求返回狀態碼
    "msg": "請求成功",    //請求返回狀態
    "result": {    //返回結果
        "npage": 1,   //當前頁
        "pageSize": 10,   //每頁資訊條數
        "total": 1,    //查詢到的資訊條數
        "data": [{
            "phone": "010-62770334;010-62782051",    //電話
            "website": "www.tsinghua.edu.cn",    //官網
            "email": "
 
[email protected]",    //郵箱
            "address": "北京市海淀區清華大學",    //地址
            "zipcode": "",    //郵編
            "name": "清華大學",    //學校名稱
            "img": "http://img.jidichong.com/school/3.png",    //學校 logo 圖片
            "parent": "教育部",    //隸屬部門
            "type": " 211 985",    //學校型別
            "profile": "",   //簡介
            "info": "院士：68 人 博士點：198 個 碩士點：181 個",    //說明
            "city": "北京"   //所在省市
        }]
    }
}
 

而 Retrofit2 請求的結果一般都分為 Header 和 Body。當然使用使用 Rxjava 後，則可以實現獲取這個 result 的結果。當是單個實體的時候，在 onNext 中就直接得到這個結果，如果是一個數組的時候，則是返回 List 這種形式。

使用方法：

1. 配置對應的外層實體，例如下面。開發中一般都非標準的 REST 都是一個數據(百度開放平臺的介面就基本都是這種形式)，一個狀態碼和一個訊息。其中 data 的型別是泛型，可以在生成請求的 api 指定實際返回的型別，如果為空的情況可以使用 String。 而 code 和 message 是對應於服務端定義的程式碼 code 和返回的錯誤資訊。Demo 裡有初始值是因為找的介面沒有使用這兩個欄位，但我想模擬這類情形而設定的。如果你的後臺後臺欄位不同，你可以按需要修改這個 HttpResult 的相應欄位。

    {
            // code 為返回的狀態碼, message 為返回的訊息, 演示的沒有這兩個欄位，考慮到真實的環境中基本包含就在這裡寫定值
            private int code = 0;
                private String message = "OK";
   
            //用來模仿 Data
            @SerializedName(value = "subjects")
            private T data;
    }
   

2. 同 Retrofit2 一樣要定義介面，如下。這裡僅僅是有 get 的介面在 demo 裡，其它的 Put, Delete, Query 等都是一樣的。

   HttpResult裡的型別就是指定泛型 data 的具體型別。可以使用 String， JSONObject，定義的實體等等。

   另外有朋友問題訪問引數是 JSON 物件怎麼辦 (Body Paramter JSON Object)？這其實就是將你的引數設定成一個已經定義的實體，我也給出一個專案中的介面。下面的 post 就是這種方式。關於請求的 REST 方式我會在文章後面放出詳細的參考，若你不熟悉請參考這些文章。

   
            @GET("top250")
        Observable<HttpResult<List<ContentBean>>> getTopMovie(@Query("start") int start, @Query("count") int count);
   
            @POST("user/login")
        Observable<HttpResult<UserLoginBean>> postLogin(@Body UserLoginRequest request);
   

3. 請求網路。

   直接呼叫

                        ServiceFactory.movieApi()
                            .getTopMovie(1, 10)
   

   使用一個預設的.compose(new DefaultTransformer<List<ContentBean>>())可以非常方便地進行轉化成了需要的Observable。

   另外準備了常用的 subscriber，包含了網路連線的錯誤處理，例如非 200 狀態，另外是服務端（業務）錯誤的處理，預設是將錯誤編碼和錯誤資訊在控制檯和手機上輸出。 正確的情況下則必須實現。

   建議使用 Rxlifecycle 防止使用 Rxjava 記憶體洩露。

錯誤方面

定義了伺服器錯誤和連線錯誤等。主要使用了 RxJava 中的onErrorResumeNext，遇到錯誤後將錯誤通過ExceptionEngine.handleException(throwable)進行處理。

@Override
    public Observable<T> call(Observable<HttpResult<T>> responseObservable) {
        return responseObservable.map(new Func1<HttpResult<T>, T>() {
            @Override
            public T call(HttpResult<T> httpResult) {
                // 通過對返回碼進行業務判斷決定是返回錯誤還是正常取資料
//                if (httpResult.getCode() != 200) throw new RuntimeException(httpResult.getMessage());
                if (httpResult.getCode() != ErrorType.SUCCESS) throw new ServerException(httpResult.getMessage(), httpResult.getCode());
                return httpResult.getData();
            }
        }).onErrorResumeNext(new Func1<Throwable, Observable<? extends T>>() {
            @Override
            public Observable<? extends T> call(Throwable throwable) {
                //ExceptionEngine 為處理異常的驅動器
                throwable.printStackTrace();
                return Observable.error(ExceptionEngine.handleException(throwable));
            }
        });
    }

其中的 ApiException

public class ApiException extends Exception {
    // 異常處理，為速度，不必要設定 getter 和 setter
    public int code;
    public String message;

    public ApiException(Throwable throwable, int code) {
        super(throwable);
        this.code = code;
    }
}

重點在於下面這個處理。你可以再定義自己的業務相關的錯誤，目前常用的都已經有了，而業相關的錯誤大部分通過接收的資料直接顯示了。若不是直接顯示的情況，你完全可以在提供的 subscriber 裡去實現。

public class ExceptionEngine {
    //對應 HTTP 的狀態碼
    private static final int UNAUTHORIZED = 401;
    private static final int FORBIDDEN = 403;
    private static final int NOT_FOUND = 404;
    private static final int REQUEST_TIMEOUT = 408;
    private static final int INTERNAL_SERVER_ERROR = 500;
    private static final int BAD_GATEWAY = 502;
    private static final int SERVICE_UNAVAILABLE = 503;
    private static final int GATEWAY_TIMEOUT = 504;

    public static ApiException handleException(Throwable e){
        ApiException ex;
        if (e instanceof HttpException){             //HTTP 錯誤
            HttpException httpException = (HttpException) e;
            ex = new ApiException(e, ErrorType.HTTP_ERROR);
            switch(httpException.code()){
                case UNAUTHORIZED:
                    ex.message = "當前請求需要使用者驗證";
                    break;
                case FORBIDDEN:
                    ex.message = "伺服器已經理解請求，但是拒絕執行它";
                    break;
                case NOT_FOUND:
                    ex.message = "伺服器異常，請稍後再試";
                    break;
                case REQUEST_TIMEOUT:
                    ex.message = "請求超時";
                    break;
                case GATEWAY_TIMEOUT:
                    ex.message = "作為閘道器或者代理工作的伺服器嘗試執行請求時，未能及時從上游伺服器（URI 標識出的伺服器，例如 HTTP、FTP、LDAP）或者輔助伺服器（例如 DNS）收到響應";
                    break;
                case INTERNAL_SERVER_ERROR:
                    ex.message = "伺服器遇到了一個未曾預料的狀況，導致了它無法完成對請求的處理";
                    break;
                case BAD_GATEWAY:
                    ex.message = "作為閘道器或者代理工作的伺服器嘗試執行請求時，從上游伺服器接收到無效的響應";
                    break;
                case SERVICE_UNAVAILABLE:
                    ex.message = "由於臨時的伺服器維護或者過載，伺服器當前無法處理請求";
                    break;
                default:
                    ex.message = "網路錯誤";  //其它均視為網路錯誤
                    break;
            }
            return ex;
        } else if (e instanceof ServerException){    //伺服器返回的錯誤
            ServerException resultException = (ServerException) e;
            ex = new ApiException(resultException, resultException.code);
            ex.message = resultException.message;
            return ex;
        } else if (e instanceof JsonParseException
                || e instanceof JSONException
                || e instanceof ParseException){
            ex = new ApiException(e, ErrorType.PARSE_ERROR);
            ex.message = "解析錯誤";            //均視為解析錯誤
            return ex;
        }else if(e instanceof ConnectException || e instanceof SocketTimeoutException || e instanceof ConnectTimeoutException){
            ex = new ApiException(e, ErrorType.NETWORD_ERROR);
            ex.message = "連線失敗";  //均視為網路錯誤
            return ex;
        }
        else {
            ex = new ApiException(e, ErrorType.UNKNOWN);
            ex.message = "未知錯誤";          //未知錯誤
            return ex;
        }
    }

}

Update

2016-10-13
修正了服務端 code 沒有處理，返回為錯誤時認為是 json 實體解析問題。
`if (httpResult.getCode() != ErrorType.SUCCESS || httpResult.getCode() != ErrorType.SUCCESS)`

Thanks