1. 程式人生 > >OkRx擴充套件,讓OkGo完美結合RxJava,比Retrofit更簡單易用

OkRx擴充套件,讓OkGo完美結合RxJava,比Retrofit更簡單易用

OkGo - Rx擴充套件,可以方便的和RxJava聯用,如果你熟悉Retrofit,那麼這個框架和Retrofit使用方式很像。

以下是該專案相關文章的傳送門:

聯絡方式

如何選擇網路框架

說了這麼多功能,我們來看看為什麼要使用OkGo這個框架。
首先目前主流的幾個網路框架

  • android-async-http
  • xUtils
  • volley
  • retrofit
  • okhttp

在此引用知乎上Stay Zhang的回答:

我們來先說一個常識性的錯誤:volley, retrofit, android-async-http 幫你封裝了具體的請求,執行緒切換以及資料轉換。而OkHttp 是基於http協議封裝的一套請求客戶端,雖然它也可以開執行緒,但根本上它更偏向真正的請求,跟HttpClient, HttpUrlConnection的職責是一樣的。

所以不要混淆。

-----以下純個人主觀見解
首先,我想即使你單純使用OkHttp,還是會再包一層的,這樣就等價於Volley之流的框架,只是封裝的好與壞而已。

android-async-http內部實現是基於HttpClient, 想必你肯定知道6.0之後HttpClient是不是系統自帶的了,不過它在最近的更新中將HttpClient的所有程式碼copy了一份進來,所以還能使用。

Volley是官方出的,volley在設計的時候是將具體的請求客戶端做了下封裝:HurlStack,也就是說可以支援HttpUrlConnection, HttpClient, OkHttp,相當於模版模式吧,這樣解耦還是非常方便的,可以隨意切換,如果你之前使用過Volley,並習慣使用,那直接寫個OkHttp擴充套件就行了。

Retrofit因為也是square出的,所以大家可能對它更崇拜些。Retrofit的跟Volley是一個套路,但解耦的更徹底:比方說通過註解來配置請求引數,通過工廠來生成CallAdapter,Converter,你可以使用不同的請求介面卡(CallAdapter), 比方說RxJava,Java8, Guava。你可以使用不同的反序列化工具(Converter),比方說json, protobuff, xml, moshi等等。然而目前OkGo已經完全可以替代Retrofit,同樣支援RxJava,但具有更強的靈活性和易用性。

OkGo的優勢

  • 優勢一:效能高,專注於簡單易用的網路請求,使用主流的okhttp進行封裝,對於okhttp大家都知道,在Android4.4的原始碼中可以看到HttpURLConnection已經替換成OkHttp實現了,並且支援HTTP2/SPDY黑科技,支援socket自動選擇最好路線,並支援自動重連,擁有自動維護的socket連線池,減少握手次數,擁有佇列執行緒池,輕鬆寫併發。
  • 優勢二:特有的網路快取模式,是大多數網路框架所不具備的,說一個應用場景,老闆說我們的app不僅需要在有網的情況下展示最新的網路資料,還要在沒網的情況下使用快取資料,這時候是不是專案中出現了大量的程式碼判斷當前網路狀況,根據不同的狀態儲存不同的資料,然後決定是否使用快取。細想一下,這是個通用的寫法,於是OkGo提供了五種快取模式,讓你不用關心快取的實現,而專注於資料的處理。(具體快取的使用方法請看最後第四章節)。
  • 優勢三:方便易用的擴充套件介面,可以新增全域性的公共引數,全域性攔截器,全域性超時時間,更可以對單個請求定製攔截器,超時時間,請求引數修改等等,在使用上更是方便,原生支援的鏈式呼叫讓你的請求更加清晰。
  • 優勢四:強大的Cookie保持策略,我們知道在客戶端對cookie的獲取是個不太簡單的事情,特別是還要處理cookie的過期時間,持久化策略等等,OkGo幫你徹底解決Cookie的難題,預設擁有記憶體儲存和持久化儲存兩種實現,cookie全程自動管理,並且提供了額外的addCookie方式,允許介入到自動管理的過程中,新增你想建立的任何cookie。

所以就說這麼多啦,選最適合專案的,選大多數人選擇的,選簡單易用的,選擇使用流行技術的,就這麼個標準,而OkGo正是在這種情況下誕生啦!!

OkRx目前支援

  • 完美結合RxJava
  • 比Retrofit更簡單方便
  • 網路請求和RxJava呼叫,一條鏈點到底
  • 支援Json資料的自動解析轉換
  • OkGo包含的所有請求功能,OkRx全部支援

目前使用的RxJava版本如下

    compile 'io.reactivex:rxjava:1.2.0'
    compile 'io.reactivex:rxandroid:1.2.1'

一.用法

0.最開始的配置

OkRxOkGo 的擴充套件,所以要想使用OkRx,那麼請先按照OkGo的配置文件,做相應的初始化。

1.在gradle中新增一行依賴

    compile 'com.lzy.net:okrx:0.1.0'  //Rx擴充套件

    或者

    compile 'com.lzy.net:okrx:+'      //使用+,引用最新版

2.呼叫請求程式碼

我們還是像正常使用OkGo的方式一樣,傳入我們需要請求的Url,和我們需要的引數,那麼最關鍵的一行就是最後呼叫getCall()這個方法。

這裡傳入的兩個引數進行一下說明:

  • 第一個引數是Convert物件,表示需要將伺服器返回的資料流解析成什麼物件,這裡我們先用最簡單的String做轉換,StringConvert物件也是庫中內建的轉換器。
  • 第二個引數是Adapter物件,表示需要將解析的結果用什麼物件包裝,該引數可以省略不寫,那麼預設是Call<T>這個物件包裝,當然,我們要使用Rx的呼叫,使用這個肯定是不行的,所以我們傳入OkRx擴充套件的RxAdapter物件,他是使用的Observable<T>物件包裝的,同樣他需要一個泛型,該泛型必須和Convert的泛型一致,否則就發生了型別轉換異常。

    以上兩個引數具體的注意事項我們後續詳細再說。

    Observable<String> call = OkGo.post(Urls.URL_METHOD)//
                                     .headers("aaa", "111")//
                                     .params("bbb", "222")//
                                     .getCall(StringConvert.create(), RxAdapter.<String>create());

3.呼叫Rx轉換程式碼

現在我們已經獲取了Observable物件了,熟悉RxJava的你難道還不會使用了嗎,以下是簡單的在請求前彈出loading,結束後展示資訊的程式碼。

call.doOnSubscribe(new Action0() {
        @Override
        public void call() {
            showLoading();  //開始請求前顯示對話方塊
        }
    })//
    .observeOn(AndroidSchedulers.mainThread())//切換到主執行緒
    .subscribe(new Action1<String>() {
        @Override
        public void call(String s) {
            dismissLoading();               //請求成功,關閉對話方塊
            handleResponse(s, null, null);
        }
    }, new Action1<Throwable>() {
        @Override
        public void call(Throwable throwable) {
            throwable.printStackTrace();
            dismissLoading();       //請求失敗
            showToast("請求失敗");
            handleError(null, null);
        }
    });

4.程式碼整合

上面的呼叫是不是很簡單,有人可能覺得鏈試程式碼太長,沒關係,我們完全可以像Retrofit一樣,自己寫一個ServerApi類,這裡面管理了所有的介面請求和引數,只是OkGo並不是採用的註解和反射實現的,而是通過傳參來實現,相信對你你來講,這樣的方式更加直觀。我們再將呼叫配合上lambda表示式,那麼最後的結果是這樣的:

這樣的請求方式有沒有驚豔到你!!

    OkGo.post(Urls.URL_METHOD)//
        .headers("aaa", "111")//
        .params("bbb", "222")//
        .getCall(StringConvert.create(), RxAdapter.<String>create())//以上為產生請求事件,請求預設發生在IO執行緒
        .doOnSubscribe(() -> {
            showLoading();  //開始請求前顯示對話方塊
        })
        .observeOn(AndroidSchedulers.mainThread())//切換到主執行緒
        .subscribe(s -> {
            dismissLoading();               //請求成功,關閉對話方塊
            handleResponse(s, null, null);
        }, throwable -> {
            throwable.printStackTrace();
            dismissLoading();       //請求失敗
            showToast("請求失敗");
            handleError(null, null);
        });

5。其他請求

  • 如果你想請求String,那麼將第2步中的getCall方法,就是你想要的。
      getCall(StringConvert.create(), RxAdapter.<String>create())
  • 如果你想請求Bitmap,那麼將第2步中的getCall方法,改成如下形式
      getCall(BitmapConvert.create(), RxAdapter.<Bitmap>create())
  • 如果你想下載File,那麼還是修改這行
      getCall(new FileConvert(), RxAdapter.<File>create())
  • 如果你想直接解析Json物件,聰明的你一定知道還是這行。注意看Convert最後有個大括號,千萬不能忘記
      getCall(new JsonConvert<ServerModel>() {}, RxAdapter.<ServerModel>create())
  • 如果你想直接解析List<Bean>物件,也很簡單。注意看Convert最後有個大括號,千萬不能忘記
      getCall(new JsonConvert<List<ServerModel>>() {}, RxAdapter.<List<ServerModel>>create())

我想,對於一款普通的app,這些請求一定能滿足你90%以上的需求,而且使用方便,只需要改一行程式碼,就能直接獲取到你想要的資料。

6.取消請求

推薦對每一個網路請求的Subscription物件都交由統一的CompositeSubscription去管理,在介面銷燬或者需要取消的地方呼叫。
例如:在Activity中,當Activity銷燬取消請求,可以在onDestory裡面統一取消。

@Override
protected void onDestroy() {
    super.onDestroy();

    unSubscribe();
}

三、自定義Convert使用

目前內部提供的包含Converter, StringConvert ,BitmapConvert ,FileConvert ,可以根據自己的需求去自定義Convert

  • Converter: 介面,所有轉換器必須實現
  • StringConvert:將網路結果解析轉成String
  • BitmapConvert:將網路結果解析轉成Bitmap
  • FileConvert:將網路結果解析轉成File

對於自定義的JsonConvert,由於不同的業務實現都不一樣,所以並不放在庫中,提供參考實現供自己修改

如果你覺得好或者給你帶來了方便,請打賞一下給作者買杯咖啡喝吧。