OkGo - Rx擴(kuò)展,可以方便的和RxJava聯(lián)用,如果你熟悉Retrofit,那么這個(gè)框架和Retrofit使用方式很像。
</br>
以下是該項(xiàng)目相關(guān)文章的傳送門:
- OkGo主項(xiàng)目詳細(xì)使用方法:OkGo,一個(gè)專注于讓網(wǎng)絡(luò)請(qǐng)求更簡(jiǎn)單的框架,與RxJava完美結(jié)合,比Retrofit更簡(jiǎn)單易用。
- OkGo2.0版本以前的前身OkHttpUtils介紹:OkHttpUtils一個(gè)專注于讓網(wǎng)絡(luò)請(qǐng)求更簡(jiǎn)單的框架
聯(lián)系方式
- 項(xiàng)目Github開源地址:https://github.com/jeasonlzy
- 聯(lián)系方式:QQ群(489873144)
- 如果你想直接運(yùn)行apk看效果,點(diǎn)擊這里下載:okgo_v2.0.0.apk
如何選擇網(wǎng)絡(luò)框架
說了這么多功能,我們來看看為什么要使用OkGo這個(gè)框架。
首先目前主流的幾個(gè)網(wǎng)絡(luò)框架
- android-async-http
- xUtils
- volley
- retrofit
- okhttp
在此引用知乎上Stay Zhang的回答:
我們來先說一個(gè)常識(shí)性的錯(cuò)誤:volley, retrofit, android-async-http 幫你封裝了具體的請(qǐng)求,線程切換以及數(shù)據(jù)轉(zhuǎn)換。而OkHttp 是基于http協(xié)議封裝的一套請(qǐng)求客戶端,雖然它也可以開線程,但根本上它更偏向真正的請(qǐng)求,跟HttpClient, HttpUrlConnection的職責(zé)是一樣的。
所以不要混淆。
-----以下純個(gè)人主觀見解
首先,我想即使你單純使用OkHttp,還是會(huì)再包一層的,這樣就等價(jià)于Volley之流的框架,只是封裝的好與壞而已。
android-async-http內(nèi)部實(shí)現(xiàn)是基于HttpClient, 想必你肯定知道6.0之后HttpClient是不是系統(tǒng)自帶的了,不過它在最近的更新中將HttpClient的所有代碼copy了一份進(jìn)來,所以還能使用。
Volley是官方出的,volley在設(shè)計(jì)的時(shí)候是將具體的請(qǐng)求客戶端做了下封裝:HurlStack,也就是說可以支持HttpUrlConnection, HttpClient, OkHttp,相當(dāng)于模版模式吧,這樣解耦還是非常方便的,可以隨意切換,如果你之前使用過Volley,并習(xí)慣使用,那直接寫個(gè)OkHttp擴(kuò)展就行了。
Retrofit因?yàn)橐彩莝quare出的,所以大家可能對(duì)它更崇拜些。Retrofit的跟Volley是一個(gè)套路,但解耦的更徹底:比方說通過注解來配置請(qǐng)求參數(shù),通過工廠來生成CallAdapter,Converter,你可以使用不同的請(qǐng)求適配器(CallAdapter), 比方說RxJava,Java8, Guava。你可以使用不同的反序列化工具(Converter),比方說json, protobuff, xml, moshi等等。然而目前OkGo已經(jīng)完全可以替代Retrofit,同樣支持RxJava,但具有更強(qiáng)的靈活性和易用性。
OkGo的優(yōu)勢(shì)
- 優(yōu)勢(shì)一:性能高,專注于簡(jiǎn)單易用的網(wǎng)絡(luò)請(qǐng)求,使用主流的okhttp進(jìn)行封裝,對(duì)于okhttp大家都知道,在Android4.4的源碼中可以看到HttpURLConnection已經(jīng)替換成OkHttp實(shí)現(xiàn)了,并且支持HTTP2/SPDY黑科技,支持socket自動(dòng)選擇最好路線,并支持自動(dòng)重連,擁有自動(dòng)維護(hù)的socket連接池,減少握手次數(shù),擁有隊(duì)列線程池,輕松寫并發(fā)。
- 優(yōu)勢(shì)二:特有的網(wǎng)絡(luò)緩存模式,是大多數(shù)網(wǎng)絡(luò)框架所不具備的,說一個(gè)應(yīng)用場(chǎng)景,老板說我們的app不僅需要在有網(wǎng)的情況下展示最新的網(wǎng)絡(luò)數(shù)據(jù),還要在沒網(wǎng)的情況下使用緩存數(shù)據(jù),這時(shí)候是不是項(xiàng)目中出現(xiàn)了大量的代碼判斷當(dāng)前網(wǎng)絡(luò)狀況,根據(jù)不同的狀態(tài)保存不同的數(shù)據(jù),然后決定是否使用緩存。細(xì)想一下,這是個(gè)通用的寫法,于是OkGo提供了五種緩存模式,讓你不用關(guān)心緩存的實(shí)現(xiàn),而專注于數(shù)據(jù)的處理。(具體緩存的使用方法請(qǐng)看最后第四章節(jié))。
- 優(yōu)勢(shì)三:方便易用的擴(kuò)展接口,可以添加全局的公共參數(shù),全局?jǐn)r截器,全局超時(shí)時(shí)間,更可以對(duì)單個(gè)請(qǐng)求定制攔截器,超時(shí)時(shí)間,請(qǐng)求參數(shù)修改等等,在使用上更是方便,原生支持的鏈?zhǔn)秸{(diào)用讓你的請(qǐng)求更加清晰。
- 優(yōu)勢(shì)四:強(qiáng)大的Cookie保持策略,我們知道在客戶端對(duì)cookie的獲取是個(gè)不太簡(jiǎn)單的事情,特別是還要處理cookie的過期時(shí)間,持久化策略等等,OkGo幫你徹底解決Cookie的難題,默認(rèn)擁有內(nèi)存存儲(chǔ)和持久化存儲(chǔ)兩種實(shí)現(xiàn),cookie全程自動(dòng)管理,并且提供了額外的addCookie方式,允許介入到自動(dòng)管理的過程中,添加你想創(chuàng)建的任何cookie。
所以就說這么多啦,選最適合項(xiàng)目的,選大多數(shù)人選擇的,選簡(jiǎn)單易用的,選擇使用流行技術(shù)的,就這么個(gè)標(biāo)準(zhǔn),而OkGo正是在這種情況下誕生啦!!
OkRx目前支持
- 完美結(jié)合RxJava
- 比Retrofit更簡(jiǎn)單方便
- 網(wǎng)絡(luò)請(qǐng)求和RxJava調(diào)用,一條鏈點(diǎn)到底
- 支持Json數(shù)據(jù)的自動(dòng)解析轉(zhuǎn)換
- OkGo包含的所有請(qǐng)求功能,OkRx全部支持
目前使用的RxJava
版本如下
compile 'io.reactivex:rxjava:1.2.0'
compile 'io.reactivex:rxandroid:1.2.1'
一.用法
0.最開始的配置
OkRx
是 OkGo
的擴(kuò)展,所以要想使用OkRx
,那么請(qǐng)先按照OkGo
的配置文檔,做相應(yīng)的初始化。
1.在gradle中添加一行依賴
compile 'com.lzy.net:okrx:0.1.0' //Rx擴(kuò)展
或者
compile 'com.lzy.net:okrx:+' //使用+,引用最新版
2.調(diào)用請(qǐng)求代碼
我們還是像正常使用OkGo的方式一樣,傳入我們需要請(qǐng)求的Url,和我們需要的參數(shù),那么最關(guān)鍵的一行就是最后調(diào)用getCall()
這個(gè)方法。
這里傳入的兩個(gè)參數(shù)進(jìn)行一下說明:
第一個(gè)參數(shù)是
Convert
對(duì)象,表示需要將服務(wù)器返回的數(shù)據(jù)流解析成什么對(duì)象,這里我們先用最簡(jiǎn)單的String
做轉(zhuǎn)換,StringConvert
對(duì)象也是庫(kù)中內(nèi)置的轉(zhuǎn)換器。-
第二個(gè)參數(shù)是
Adapter
對(duì)象,表示需要將解析的結(jié)果用什么對(duì)象包裝,該參數(shù)可以省略不寫,那么默認(rèn)是Call<T>
這個(gè)對(duì)象包裝,當(dāng)然,我們要使用Rx的調(diào)用,使用這個(gè)肯定是不行的,所以我們傳入OkRx擴(kuò)展的RxAdapter
對(duì)象,他是使用的Observable<T>
對(duì)象包裝的,同樣他需要一個(gè)泛型,該泛型必須和Convert
的泛型一致,否則就發(fā)生了類型轉(zhuǎn)換異常。以上兩個(gè)參數(shù)具體的注意事項(xiàng)我們后續(xù)詳細(xì)再說。
Observable<String> call = OkGo.post(Urls.URL_METHOD)//
.headers("aaa", "111")//
.params("bbb", "222")//
.getCall(StringConvert.create(), RxAdapter.<String>create());
3.調(diào)用Rx轉(zhuǎn)換代碼
現(xiàn)在我們已經(jīng)獲取了Observable
對(duì)象了,熟悉RxJava
的你難道還不會(huì)使用了嗎,以下是簡(jiǎn)單的在請(qǐng)求前彈出loading,結(jié)束后展示信息的代碼。
call.doOnSubscribe(new Action0() {
@Override
public void call() {
showLoading(); //開始請(qǐng)求前顯示對(duì)話框
}
})//
.observeOn(AndroidSchedulers.mainThread())//切換到主線程
.subscribe(new Action1<String>() {
@Override
public void call(String s) {
dismissLoading(); //請(qǐng)求成功,關(guān)閉對(duì)話框
handleResponse(s, null, null);
}
}, new Action1<Throwable>() {
@Override
public void call(Throwable throwable) {
throwable.printStackTrace();
dismissLoading(); //請(qǐng)求失敗
showToast("請(qǐng)求失敗");
handleError(null, null);
}
});
4.代碼整合
上面的調(diào)用是不是很簡(jiǎn)單,有人可能覺得鏈試代碼太長(zhǎng),沒關(guān)系,我們完全可以像Retrofit一樣,自己寫一個(gè)ServerApi
類,這里面管理了所有的接口請(qǐng)求和參數(shù),只是OkGo并不是采用的注解和反射實(shí)現(xiàn)的,而是通過傳參來實(shí)現(xiàn),相信對(duì)你你來講,這樣的方式更加直觀。我們?cè)賹⒄{(diào)用配合上lambda
表達(dá)式,那么最后的結(jié)果是這樣的:
這樣的請(qǐng)求方式有沒有驚艷到你!!
OkGo.post(Urls.URL_METHOD)//
.headers("aaa", "111")//
.params("bbb", "222")//
.getCall(StringConvert.create(), RxAdapter.<String>create())//以上為產(chǎn)生請(qǐng)求事件,請(qǐng)求默認(rèn)發(fā)生在IO線程
.doOnSubscribe(() -> {
showLoading(); //開始請(qǐng)求前顯示對(duì)話框
})
.observeOn(AndroidSchedulers.mainThread())//切換到主線程
.subscribe(s -> {
dismissLoading(); //請(qǐng)求成功,關(guān)閉對(duì)話框
handleResponse(s, null, null);
}, throwable -> {
throwable.printStackTrace();
dismissLoading(); //請(qǐng)求失敗
showToast("請(qǐng)求失敗");
handleError(null, null);
});
5。其他請(qǐng)求
- 如果你想請(qǐng)求
String
,那么將第2
步中的getCall
方法,就是你想要的。
getCall(StringConvert.create(), RxAdapter.<String>create())
- 如果你想請(qǐng)求
Bitmap
,那么將第2
步中的getCall
方法,改成如下形式
getCall(BitmapConvert.create(), RxAdapter.<Bitmap>create())
- 如果你想下載
File
,那么還是修改這行
getCall(new FileConvert(), RxAdapter.<File>create())
- 如果你想直接解析
Json
對(duì)象,聰明的你一定知道還是這行。注意看Convert最后有個(gè)大括號(hào),千萬不能忘記
getCall(new JsonConvert<ServerModel>() {}, RxAdapter.<ServerModel>create())
- 如果你想直接解析
List<Bean>
對(duì)象,也很簡(jiǎn)單。注意看Convert最后有個(gè)大括號(hào),千萬不能忘記
getCall(new JsonConvert<List<ServerModel>>() {}, RxAdapter.<List<ServerModel>>create())
我想,對(duì)于一款普通的app,這些請(qǐng)求一定能滿足你90%以上的需求,而且使用方便,只需要改一行代碼,就能直接獲取到你想要的數(shù)據(jù)。
6.取消請(qǐng)求
推薦對(duì)每一個(gè)網(wǎng)絡(luò)請(qǐng)求的Subscription
對(duì)象都交由統(tǒng)一的CompositeSubscription
去管理,在界面銷毀或者需要取消的地方調(diào)用。
例如:在Activity中,當(dāng)Activity銷毀取消請(qǐng)求,可以在onDestory里面統(tǒng)一取消。
@Override
protected void onDestroy() {
super.onDestroy();
unSubscribe();
}
三、自定義Convert使用
目前內(nèi)部提供的包含Converter
, StringConvert
,BitmapConvert
,FileConvert
,可以根據(jù)自己的需求去自定義Convert
-
Converter
: 接口,所有轉(zhuǎn)換器必須實(shí)現(xiàn) -
StringConvert
:將網(wǎng)絡(luò)結(jié)果解析轉(zhuǎn)成String
-
BitmapConvert
:將網(wǎng)絡(luò)結(jié)果解析轉(zhuǎn)成Bitmap
-
FileConvert
:將網(wǎng)絡(luò)結(jié)果解析轉(zhuǎn)成File