RxJava2 實戰(zhàn)知識梳理(11) - 檢測網絡狀態(tài)并自動重試請求

RxJava2 實戰(zhàn)系列文章

一被饿、應用背景

今天，我們以一個請求天氣數(shù)據(jù)的例子搪搏，來演示如何用RxJava實現(xiàn)網絡重連時的自動請求狭握，首先，我們對這個需求進行一個簡單的描述疯溺，整個項目的框架如下所示：

整體框架圖

在應用啟動時论颅，我們會啟動定位模塊，該定位模塊在后臺每隔一段時間發(fā)起一次定位請求囱嫩，拿到定位的結果后恃疯，我們通過該城市向服務器發(fā)起請求，以獲取對應城市的天氣信息進行展示墨闲。
但是在拿到城市之后向服務器請求天氣的過程中有可能是處于沒有網絡的狀態(tài)今妄，導致無法獲取城市的天氣信息并刷新界面，因此鸳碧，我們需要檢測網絡的狀態(tài)盾鳞，在網絡重連的時候，讀取上一次緩存的城市杆兵，向服務器發(fā)起請求以獲取城市對應天氣信息雁仲。

本文的示例代碼在 RxSample 的第十一章中。

二琐脏、示例

2.1 定位模塊

我們通過一個后臺線程來模擬定位的過程攒砖，它每隔一段時間獲取一次定位的結果，并將該結果通過mCityPublish發(fā)送數(shù)據(jù)給它的訂閱者日裙。

    //用于發(fā)布定位到的城市結果吹艇。
    private PublishSubject<Long> mCityPublish;

    //模擬定位模塊的回調。
    private void startUpdateLocation() {
        mLocationThread = new Thread() {
            @Override
            public void run() {
                while (true) {
                    try {
                        for (long cityId : CITY_ARRAY) {
                            if (isInterrupted()) {
                                break;
                            }
                            Log.d(TAG, "重新定位");
                            Thread.sleep(5000);
                            Log.d(TAG, "定位到城市信息=" + cityId);
                            mCityPublish.onNext(cityId);
                        }
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        };
        mLocationThread.start();
    }

在mCityPublish發(fā)送消息到訂閱者收到消息之間昂拂，我們還需要做一些特殊的處理：

    private Observable<Long> getCityPublish() {
        return mCityPublish.distinctUntilChanged().doOnNext(new Consumer<Long>() {

            @Override
            public void accept(Long aLong) throws Exception {
                saveCacheCity(aLong);
            }

        });
    }

這里我們做了兩步處理：

使用distinctUntilChanged對定位結果進行過濾受神，如果此次定位的結果和上次定位的結果相同，那么不通知訂閱者格侯。distinctUntilChanged的原理圖如下所示：
使用doOnNext鼻听，在返回結果給訂閱者之前，先把最新一次的定位結果存儲起來联四，用于在之后網絡重連之后進行請求撑碴。

2.2 網絡狀態(tài)模塊

與定位模塊類似，我們也需要一個mNetStatusPublish朝墩，其類型為PublishSubject醉拓，它在網絡狀態(tài)發(fā)生變化時通知訂閱者。這里需要注冊一個廣播，在收到廣播之后亿卤，我們通過mNetStatusPublish通知訂閱者愤兵，代碼如下：

    private void registerBroadcast() {
        mReceiver = new BroadcastReceiver() {

            @Override
            public void onReceive(Context context, Intent intent) {
                if (mNetStatusPublish != null) {
                    mNetStatusPublish.onNext(isNetworkConnected());
                }
            }

        };
        IntentFilter filter = new IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION);
        registerReceiver(mReceiver, filter);
    }

在收到網絡狀態(tài)變化的消息之后：

   private Observable<Long> getNetStatusPublish() {
        return mNetStatusPublish.filter(new Predicate<Boolean>() {

            @Override
            public boolean test(Boolean aBoolean) throws Exception {
                return aBoolean && getCacheCity() > 0;
            }

        }).map(new Function<Boolean, Long>() {

            @Override
            public Long apply(Boolean aBoolean) throws Exception {
                return getCacheCity();
            }
            
        }).subscribeOn(Schedulers.io());
    }

這里我們做了兩步處理：

使用filter對消息進行過濾，只有在 聯(lián)網情況并且之前已經定位到了城市 之后才通知訂閱者排吴，filter的原理圖如下所示秆乳，該操作符用于過濾掉一些不需要的數(shù)據(jù)：
使用map，讀取當前緩存的城市名傍念，返回給訂閱者矫夷，map的原理圖如下所示，該操作符可以用于執(zhí)行變換操作憋槐。

2.3 網絡請求模塊

在2.1和2.2中双藕，我們分別用getCityPublish()和getNetStatusPublish()來獲取被訂閱者，它們分別對應于定位模塊和網絡狀態(tài)模塊發(fā)生變化時所發(fā)送的城市數(shù)據(jù)阳仔，下面來看我們通過城市數(shù)據(jù)獲取城市天氣信息的代碼：

    private void startUpdateWeather() {
        Observable.merge(getCityPublish(), getNetStatusPublish()).flatMap(new Function<Long, ObservableSource<WeatherEntity>>() {

            @Override
            public ObservableSource<WeatherEntity> apply(Long aLong) throws Exception {
                Log.d(TAG, "嘗試請求天氣信息=" + aLong);
                return getWeather(aLong).subscribeOn(Schedulers.io());
            }

        }).retryWhen(new Function<Observable<Throwable>, ObservableSource<?>>() {

            @Override
            public ObservableSource<?> apply(Observable<Throwable> throwableObservable) throws Exception {
                return throwableObservable.flatMap(new Function<Throwable, ObservableSource<?>>() {

                    @Override
                    public ObservableSource<?> apply(Throwable throwable) throws Exception {
                        Log.d(TAG, "請求天氣信息過程中發(fā)生錯誤忧陪，進行重訂閱");
                        return Observable.just(0);
                    }

                });
            }

        }).observeOn(AndroidSchedulers.mainThread()).subscribe(new Observer<WeatherEntity>() {

            @Override
            public void onSubscribe(Disposable disposable) {
                mCompositeDisposable.add(disposable);
            }

            @Override
            public void onNext(WeatherEntity weatherEntity) {
                WeatherEntity.WeatherInfo info = weatherEntity.getWeatherinfo();
                if (info != null) {
                    Log.d(TAG, "嘗試請求天氣信息成功");
                    StringBuilder builder = new StringBuilder();
                    builder.append("城市名：").append(info.getCity()).append("\n").append("溫度：").append(info.getTemp()).append("\n").append("風向：").append(info.getWD()).append("\n").append("風速：").append(info.getWS()).append("\n");
                    mTvNetworkResult.setText(builder.toString());
                }
            }

            @Override
            public void onError(Throwable throwable) {
                Log.d(TAG, "嘗試請求天氣信息失敗");
            }

            @Override
            public void onComplete() {
                Log.d(TAG, "嘗試請求天氣信息結束");
            }
        });
    }

    private Observable<WeatherEntity> getWeather(long cityId) {
        WeatherApi api = new Retrofit.Builder()
                .baseUrl("http://www.weather.com.cn/")
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build().create(WeatherApi.class);
        return api.getWeather(cityId);
    }

這里我們做了以下幾個操作：

使用merge合并兩個數(shù)據(jù)源，我們通過getWeather(long cityId)來獲取城市信息近范，這里面用到了 RxJava2 實戰(zhàn)知識梳理(4) - 結合 Retrofit 請求新聞資訊的知識嘶摊，只不過這里的接口是使用的天氣信息網的數(shù)據(jù)，merge的原理在 RxJava2 實戰(zhàn)知識梳理(8) - 使用 publish + merge 優(yōu)化先加載緩存评矩，再讀取網絡數(shù)據(jù)的請求過程也已經做了介紹叶堆。
使用retryWhen進行重訂閱，因為在獲取到城市斥杜，之后轉換成城市天氣信息的時候有可能發(fā)生錯誤虱颗，如果發(fā)生了錯誤，那么整個調用鏈就結束了蔗喂，需要重新訂閱忘渔。這里的重訂閱使用的retryWhen操作符，關于重訂閱更詳細的解釋可以看前面的這篇文章 RxJava2 實戰(zhàn)知識梳理(6) - 基于錯誤類型的重試請求缰儿，下面是其中的部分說明：
使用observeOn切換到主線程進行界面的更新畦粮，原理如：
RxJava2 實戰(zhàn)知識梳理(1) - 后臺執(zhí)行耗時操作，實時通知 UI 更新

2.4 示例演示

本章的示例代碼在 RxSample 的第十一章中乖阵，我們演示兩種情況：

正常聯(lián)網情況宣赔，定位回調的間隔為1s：

控制臺輸出如下，可以看到只有當前后兩次定位信息不同時才會發(fā)起網絡請求天氣信息：
在非聯(lián)網的時候進入瞪浸，并只進行一次定位拉背，然后在切換到有網的狀態(tài)。

此時控制臺的輸出如下默终，可以看到在網絡重連之后，我們使用緩存的城市自動重新發(fā)起了請求：