OkGo - Rx擴展,可以方便的和RxJava聯用,如果你熟悉Retrofit,那么這個框架和Retrofit使用方式很像。
</br>
以下是該項目相關文章的傳送門:
- OkGo主項目詳細使用方法:OkGo,一個專注于讓網絡請求更簡單的框架,與RxJava完美結合,比Retrofit更簡單易用。
- OkGo2.0版本以前的前身OkHttpUtils介紹:OkHttpUtils一個專注于讓網絡請求更簡單的框架
聯系方式
- 項目Github開源地址:https://github.com/jeasonlzy
- 聯系方式:QQ群(489873144)
- 如果你想直接運行apk看效果,點擊這里下載:okgo_v2.0.0.apk
如何選擇網絡框架
說了這么多功能,我們來看看為什么要使用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.最開始的配置
OkRx
是 OkGo
的擴展,所以要想使用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