RxJava結合Retrofit對網絡請求結果的統(tǒng)一處理

不同的網絡請求有不同的返回結果，當同時也有很多相同的地方，比如數(shù)據的整體結構可以是這樣：

{
    "status": 1000, 
    "msg": "調用權限失敗", 
    "data": {
            ***
            ***
    }
}

如果接口數(shù)據的設計如上，那么每個請求都會有如下三點相同的部分

  1. 狀態(tài)碼
  2. 網絡異常
  3. 相同的網絡請求策略

既然有相同的部分，那么就有必要對相同的部分統(tǒng)一處理

主要功能圖解

整體采用MVP設計模式如下


MVP架構

其中ModelPresenter為所有網絡請求的Presenter，如下

ModelPresenter

DataSevice為Retrofit請求接口如下

DataService

網絡層的整體流程如下

網絡層流程

其中第三層返回的是HttpBean<T>，第二層返回的是業(yè)務層需要的T類型

具體實現(xiàn)

模型設計

在和后臺對接的時候，定義一個統(tǒng)一的數(shù)據結構，這樣才好統(tǒng)一處理狀態(tài)碼，利用泛型，我們可以設計接口返回的數(shù)據模型為

public class HttpBean<T> {
    private String msg;
    private T data;
    private int status;
}

不同的網絡請求只需要傳入相應的數(shù)據模型即可，那么利用retrofit請求數(shù)據的接口如下

public interface DataService {
    @GET(RequestCons.MY_BOX)
    Observable<HttpBean<BoxData>> getBox(@Query("client_id") String client_id, @Query("client_secret") String secret, @Query("visit_user_id") long user_id);

    @GET(RequestCons.COMMENTS_LIST)
    Observable<HttpBean<CommentData>> getComments(@Query("client_id") String client_id, @Query("client_secret") String secret, @Query("object_id") long object_id);

    @GET(RequestCons.TOPIC)
    Observable<HttpBean<TopicData>> getTopic(@Query("client_id") String client_id, @Query("client_secret") String secret, @Query("id") long id);
}

業(yè)務層向模型層請求數(shù)據的接口如下

public interface ModelPresenter {
    /**     * 下載box數(shù)據接口     */
    Observable<BoxData> loadBoxData(String client_id, String secret, long user_id);

    /**     * 下載評論數(shù)據接口     */
    Observable<CommentData> loadCommentData(String client_id, String secret, long object_id);

    /**     * 下載Topic商品     */
    Observable<TopicData> loadTopic(String client_id, String secret, long id);
}

通過對比兩個接口，可以發(fā)現(xiàn)業(yè)務層無需關心狀態(tài)碼了，只會拿到Observable<T>而不是Obervable<HttpBean<T>>

ModelPresenterImpl的實現(xiàn)

ModelPresenterImpl繼承自BaseModelImpl,本身的實現(xiàn)其實很簡單，主要工作就是調用DataService對應的方法，然后過濾狀態(tài)碼，代碼如下

public class ModelPresenterImpl extends BaseModelImpl implements ModelPresenter {
    @Override
    public Observable<BoxData> loadBoxData(String client_id, String secret, long user_id) {
        return filterStatus(mDataService.getBox(client_id,secret,user_id));
    }
    @Override
    public Observable<CommentData> loadCommentData(String client_id, String secret, long object_id) {
        return filterStatus(mDataService.getComments(client_id,secret,object_id));
    }
    @Override
    public Observable<TopicData> loadTopic(String client_id, String secret, long id) {
        return filterStatus(mDataService.getTopic(client_id,secret,id));
    }
}
BaseModelImpl的實現(xiàn)

BaseModelImpl做了以下兩點工作

  1. 創(chuàng)建OkHttpClient、Retrofit、DataService
public BaseModelImpl() {
    this.baseUrl = RequestCons.BASE_URL;
    OkHttpClient client = new OkHttpClient.Builder()
            .connectTimeout(10, TimeUnit.SECONDS)
            .build();
    mRetrofit = new Retrofit.Builder()
            .baseUrl(baseUrl)
            .client(client)
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
            .build();
    mDataService = mRetrofit.create(DataService.class);
}
  1. 利用Rxjava的map操作符過濾狀態(tài)碼
/** * 給返回結果去掉狀態(tài)碼等屬性,
 * 如果是查詢出錯,則返回狀態(tài)碼對應的描述給用戶
 * @param observable
 * @return
 */
public Observable filterStatus(Observable observable){
    return observable.map(new ResultFilter());
}
private class ResultFilter<T> implements Func1<HttpBean<T>, T> {
    @Override
    public T call(HttpBean<T> tHttpBean) {
        if (tHttpBean.getStatus() != 1){
            throw new ApiException(tHttpBean.getStatus());
        }
        return tHttpBean.getData();
    }
}

此處代碼是一個關鍵點，利用操作符map給請求的數(shù)據"去殼"，只返回給業(yè)務層所需要的模型，如果當前請求的狀態(tài)碼不是成功的標志，那么拋出異常，交給應用層的OnError處理，確保應用層的onNext方法只處理成功的結果，純粹專一。

配置狀態(tài)碼過濾器

狀態(tài)碼過濾器一共需要2個類

  1. 常量說明類
public class ResponseCons {
    public static final int STATUS_SUCCESS  = 1;
    public static final String SUCCESS_MSG = "成功";

    public static final int STATU_1000 = 1000;
    public static final String FAILURE_1000 = "調用權限失敗";
}
  1. 狀態(tài)碼匹配工具類
public class StatusUtils {
    public static class StatusResult{
        public int status;
        public String desc;
        public boolean isSuccess;
    }
    private static StatusResult mStatusResult = new StatusResult();
    public static StatusResult judgeStatus(int status) {
        String desc = "";
        boolean isSuccess = false;
        switch (status) {
            case ResponseCons.STATUS_SUCCESS:
                desc = ResponseCons.SUCCESS_MSG;
                isSuccess = true;
                break;
            case ResponseCons.STATU_1000:
                desc = ResponseCons.FAILURE_1000;
                break;
        }
        mStatusResult.status = status;
        mStatusResult.desc = desc;
        mStatusResult.isSuccess = isSuccess;
        return mStatusResult;
    }
}

在BaseModelImpl中對網絡請求結果的狀態(tài)碼進行判斷，如果不是標志成功的狀態(tài)碼，那么就拋出一個異常，在異常中利用狀態(tài)碼匹配工具類找到對應錯誤描述并且返回

public class ApiException extends RuntimeException {
    public ApiException(int status) {
        super(getErrorDesc(status));
    }
    private static String getErrorDesc(int status){
        return StatusUtils.judgeStatus(status).desc;
    }
}

隨著業(yè)務的擴展，如出現(xiàn)新的狀態(tài)碼，那么只需要往常量類和匹配工具類增加狀態(tài)碼和錯誤描述即可，不需要更改網絡層其它代碼，還可以拓展成將錯誤碼和對應描述信息存儲在本地，當成配置文件，那么當產品發(fā)布之后，如果后臺增加錯誤碼，只需要download新的狀態(tài)碼配置文件即可，不需要發(fā)布新版本應用。

其它網絡錯誤處理

以上已經實現(xiàn)了網絡層的功能，包括發(fā)起請求，解析返回結果并且統(tǒng)一過濾狀態(tài)碼，將請求成功的結果返回到Observable.onNext()，將失敗結果返回到observable.onError()。

然而網絡請求并不是一直穩(wěn)定的，所以所有網絡請求都有可能出現(xiàn)超時、無網絡鏈接或者其它40X，50X錯誤。

因此還需要再做一層錯誤過濾，在Retrofit中，所有的異常都會拋出，并且最終由Observable的onError接收，所以我們可以自定義一個FilterSubscriber繼承自Subscriber，實現(xiàn)onError接口，對傳入的throwable參數(shù)進行判處理，代碼如下

public abstract class FilterSubscriber<T> extends Subscriber<T> {
    public String error;
    @Override
    public abstract void onCompleted();
    @Override
    public void onError(Throwable e) {
        if (e instanceof TimeoutException || e instanceof SocketTimeoutException
            || e instanceof ConnectException){
            error = "超時了";
        }else if (e instanceof JsonSyntaxException){
            error = "Json格式出錯了";
            //假如導致這個異常觸發(fā)的原因是服務器的問題，那么應該讓服務器知道，所以可以在這里
            //選擇上傳原始異常描述信息給服務器
        }else {
            error = e.getMessage();
        }
    }
}

由于我們提取出異常處理類，在異常處理類的onError( )中統(tǒng)一對所有異常進行處理，所以當一些異常確定是或者疑似是服務器的bug，抑或是未知bug，我們應該及時上報服務器，讓服務器收集錯誤信息，及時修復，所以在onError( )中選擇上傳數(shù)據請求的異常信息是一個不錯的選擇。當然服務器的異常也可以后臺自己收集，這里只是提供一種策略而已。

應用層調用

做完了發(fā)送請求，解析數(shù)據，錯誤處理，最后就是應用層調用了，代碼如下：

@Overridepublic void loadTopicSuccess() {
    Observable<TopicData> observable = mModelPresenter.loadTopic("bt_app_ios", "9c1e6634ce1c5098e056628cd66a17a5", 1346);
    observable.subscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(new FilterSubscriber<TopicData>() {
                @Override
                public void onCompleted() {
                    MLog.d("Topic信息下載完畢");
                }
                @Override
                public void onNext(TopicData data) {
                    mMainView.showSuccess(data);
                }
                @Override
                public void onError(Throwable e) {
                    super.onError(e);
                    mMainView.showError(error);
                }
            });
}

需要注意的是，在onError(Throwable e){ }中第一行代碼需要super.onError(e),然后接下去的異常信息的描述是error字符串。

做完以上工作之后，往后如果需要添加新的接口，那么只需要以下幾步

  1. 在requestCons添加新的接口的文件路徑
  2. 增加相應的bean文件
  3. 在DataService中添加新的接口方法
  4. 在ModelPresenter添加新的接口方法并且在Impl中實現(xiàn)

而不需要再處理以下內容

  1. 客戶端的創(chuàng)建
  2. 狀態(tài)碼過濾
  3. 網絡異常過濾

上傳的源碼使用MVP設計模式的思想，如果想了解如何使用MVP的同學可以下載看看。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內容

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,715評論 19贊 139
  • 我從去年開始使用 RxJava ，到現(xiàn)在一年多了。今年加入了 Flipboard 后，看到 Flipboard 的...
    Jason_andy閱讀 5,780評論 7贊 62
  • 前言我從去年開始使用 RxJava ，到現(xiàn)在一年多了。今年加入了 Flipboard 后，看到 Flipboard...
    占導zqq閱讀 9,349評論 6贊 151
  • 文章轉自：http://gank.io/post/560e15be2dca930e00da1083作者：扔物線在正...
    xpengb閱讀 7,152評論 9贊 73
  • 1. Java基礎部分 基礎部分的順序：基本語法，類相關的語法，內部類的語法，繼承相關的語法，異常的語法，線程的語...
    子非魚_t_閱讀 34,897評論 18贊 399

友情鏈接更多精彩內容