網(wǎng)絡(luò)方案說(shuō)明
Android時(shí)下最流行的網(wǎng)絡(luò)方案——“RxJava+Retrofit+OKHttp”,我們先通過(guò)官方介紹簡(jiǎn)單了解一下這幾個(gè)久仰的大名晓淀。
- RxJava
RxJava – Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.
對(duì)于JVM的響應(yīng)式擴(kuò)展 奏甫,一個(gè)在 Java VM 上使用可觀測(cè)的序列來(lái)組成異步的拆讯、基于事件的程序的庫(kù)炎疆。 - Retrofit
Type-safe HTTP client for Android and Java by Square, Inc.
針對(duì)于Java和Android的類型安全的Http客戶端考阱。 - OKHttp
An HTTP+HTTP/2 client for Android and Java applications.
為Android和Java提供的一個(gè)兼容Http、Http2協(xié)議的客戶端粘姜。
通過(guò)上面的介紹鬓照,我們可以得出一個(gè)結(jié)論∠嗤В“RxJava+Retrofit+OKHttp”方案,是一個(gè)響應(yīng)式的纯陨、類型安全的坛芽、兼容Http和Http2的網(wǎng)絡(luò)方案留储。這也是我們?yōu)槭裁床捎眠@個(gè)方案的原因。想要深刻的理解這個(gè)原因咙轩,我們需要自行去理解以下幾個(gè)問(wèn)題获讳。
- 什么是響應(yīng)式變成?
- 什么是類型安全活喊?
- Http協(xié)議的相關(guān)知識(shí)丐膝。
- 問(wèn)題還有很多,有待大家慢慢發(fā)現(xiàn)钾菊。
我們的網(wǎng)絡(luò)庫(kù)帅矗,在上面一些技術(shù)的基礎(chǔ)上,加入了基于DiskLruCache的數(shù)據(jù)緩存方案煞烫,所以準(zhǔn)確的說(shuō)浑此,我們的網(wǎng)絡(luò)方案是“RxJava+Retrofit+OKHttp+DiskLruCache”。
其中響應(yīng)式編程個(gè)非常重要的技術(shù)概念滞详,甚至可以說(shuō)是一種編程思想凛俱。所以我們會(huì)花費(fèi)一些時(shí)間來(lái)說(shuō)一說(shuō)。
響應(yīng)式編程
響應(yīng)式編程是一種通過(guò)異步和數(shù)據(jù)流來(lái)構(gòu)建事物關(guān)系的編程模型料饥。
這是一個(gè)非常高度概括的蒲犬、抽象的、脫離了編程的概念描述岸啡,這是一個(gè)非常準(zhǔn)確概念描述原叮,但是說(shuō)了和沒(méi)說(shuō)一樣,完全不知道是什么東西凰狞。下面我們看一段代碼篇裁,幫助我們從最根本的出發(fā)點(diǎn)上了解這一模型。
int a = 1;
int b = a + 1;
System.out.println(“b = ”+ b) ; // b=2
a = 10;
System.out.println(“b = ”+ b) ;
這一段代碼的運(yùn)行輸出是兩個(gè)b=2赡若,至于為什么达布,我們?cè)诖瞬蛔鲞^(guò)多的闡述。這段代碼的本意其實(shí)是b=a+1逾冬,也就是說(shuō)黍聂,不論我們將a的值變成多少,b的值都應(yīng)該是a+1身腻,也就是說(shuō)第二次打印的預(yù)期結(jié)果應(yīng)該是11产还。
那么我們馬上就想到了以下兩個(gè)辦法。
int a = 1;
int b = a + 1;
System.out.println(“b = ”+ b); // b=2
a = 10;
System.out.println(“b = ”+ (a + 1)) ;
int a = 1;
System.out.println(“b = ”+ b); // b=2
a = 10;
int b = a + 1;
System.out.println(“b = ”+ b) ;
上面兩段代碼嘀趟,都達(dá)到了我們的目的脐区,那么是不是說(shuō)這兩段代碼都是響應(yīng)式編程呢,其實(shí)都不是她按。我們預(yù)期的結(jié)果牛隅,其實(shí)是想維持變量a和變量b的一種關(guān)系炕柔,b=a+1。那么維持這樣一個(gè)簡(jiǎn)單的關(guān)系為什么就是一種響應(yīng)式編程呢媒佣,這是因?yàn)樨袄郏谝粋€(gè)穩(wěn)定的關(guān)系下,如果一方發(fā)生變化默伍,另一方也會(huì)隨之而發(fā)生改變欢嘿,就好像是b對(duì)a的數(shù)值變化產(chǎn)生了響應(yīng),這就是所謂的響應(yīng)式編程也糊。
private int a;
private int b;
public void setA(int a) {
this.a = a;
}
public int getB() {
b = a + 1;
return b;
}
以上的這個(gè)例子炼蹦,可以看做是最簡(jiǎn)單的響應(yīng)式編程,調(diào)用者在每次通過(guò)getB()方法獲取數(shù)據(jù)時(shí)显设,都會(huì)參照a當(dāng)前的值進(jìn)行計(jì)算框弛,也就可以看做是對(duì)a的數(shù)據(jù)變化產(chǎn)生了響應(yīng)。這是一種b對(duì)a的主動(dòng)響應(yīng)捕捂,a并沒(méi)有對(duì)b進(jìn)行通知瑟枫。還有一種方式,就是通過(guò)觀察者模式a的數(shù)值發(fā)生改變時(shí)指攒,主動(dòng)通知b慷妙。
public class Test {
private int a;
private int b;
private OnAChanged onAChanged;
public void setA(int a) {
this.a = a;
onAChanged.onAChanged(a);
}
public int getB() {
return b;
}
public interface OnAChanged {
public void onAChanged(int a);
}
public void setOnAChanged(OnAChanged onAChanged) {
this.onAChanged = onAChanged;
}
public static void main(String[] args) {
Test test = new Test();
test.setOnAChanged(new OnAChanged() {
@Override
public void onAChanged(int a) {
test.setB(a + 1);
}
});
}
}
經(jīng)過(guò)更加復(fù)雜和完善的設(shè)計(jì),并且完美的解決的多線程異步允悦、代碼耦合等問(wèn)題膝擂,RxJava也就應(yīng)運(yùn)而生了。
Ps:響應(yīng)式編程的思想廣泛出現(xiàn)在我們的生活和編碼中隙弛,但是這種響應(yīng)本質(zhì)上是對(duì)信息的響應(yīng)架馋,無(wú)非是a發(fā)生改變時(shí)主動(dòng)通知b,或者b在需要的時(shí)候通過(guò)觀察a得到信息全闷。其實(shí)叉寂,理想狀態(tài)下的響應(yīng)是不依賴于消息的,a發(fā)生改變后总珠,b馬上發(fā)生改變屏鳍,不需要任何的信息傳遞。這種玄而又玄的理想的響應(yīng)式編程模型局服,只出現(xiàn)在神奇的量子力學(xué)領(lǐng)域钓瞭,這種現(xiàn)象叫做量子糾纏。
RxJava-Retrofit-OkHttp的關(guān)系
上圖描述的是三個(gè)庫(kù)之間的依賴關(guān)系淫奔,其中OkHttp是基礎(chǔ)山涡,Retrofit是橋梁,RxJava表現(xiàn)形式,其中Retrofit對(duì)OkHttp具有極強(qiáng)的依賴性鸭丛。
上圖是一個(gè)網(wǎng)絡(luò)的職能和相互關(guān)系的簡(jiǎn)單示意圖霍殴,它們的職能分別如下。
- OKHttp系吩,負(fù)責(zé)與網(wǎng)絡(luò)交互,為Retrofit提供發(fā)起網(wǎng)絡(luò)請(qǐng)求和獲得響應(yīng)數(shù)據(jù)的方法妒蔚。
- Retrofit穿挨,負(fù)責(zé)對(duì)接口、參數(shù)進(jìn)行封裝肴盏,發(fā)起網(wǎng)絡(luò)請(qǐng)求科盛,得到網(wǎng)絡(luò)數(shù)據(jù)并以Flowable等形式傳遞給RxJava。
- RxJava以Consumer菜皂、Subscriber等形式接收Retrofit封裝后的Flowable類型的網(wǎng)絡(luò)數(shù)據(jù)贞绵,并回調(diào)到業(yè)務(wù)層處理。
network網(wǎng)絡(luò)庫(kù)
做了這么多的鋪墊恍飘,下面才要進(jìn)入正題了榨崩,我們看一下網(wǎng)絡(luò)框架的依賴關(guān)系。
從圖上看章母,整個(gè)網(wǎng)絡(luò)庫(kù)在關(guān)系上并沒(méi)有非常復(fù)雜的相互依賴關(guān)系母蛛,我們只需要以NetHelper為出發(fā)點(diǎn),就可以理清整個(gè)庫(kù)的邏輯了乳怎。
NetHelper有以下一些能力彩郊。
- createClient()
創(chuàng)建可以添加通用參數(shù)、通用Header蚪缀、自定義攔截器秫逝,具備網(wǎng)絡(luò)緩存功能和支持Https的OKHttpClient對(duì)象。 - createRetrofit()
可以根據(jù)URL的不同询枚,可以創(chuàng)建多個(gè)Retrofit對(duì)象违帆。 - request()
發(fā)起網(wǎng)絡(luò)請(qǐng)求。 - requestLocalFirst()
先讀取本地緩存數(shù)據(jù)再發(fā)起網(wǎng)絡(luò)請(qǐng)求哩盲。 - addCommonParams()
在網(wǎng)絡(luò)庫(kù)初始化之后加入通用參數(shù)前方。
NetOptions
網(wǎng)絡(luò)基礎(chǔ)配置項(xiàng),使用builder模式廉油,配置項(xiàng)包括:
- <p>支持使用者添加的
- interceptors - 網(wǎng)絡(luò)攔截器惠险,用于添加自定義攔截器
- commonParams - 通用參數(shù),通用參數(shù)可以通過(guò)添加自定義攔截器添加抒线,也可以將通用參數(shù)的鍵值對(duì)加入commonParams
- commonHeaders - 通用請(qǐng)求頭班巩,通用請(qǐng)求頭可以通過(guò)添加自定義攔截器添加,也可以將通用headers的鍵值對(duì)加入commonHeaders
- <p>超時(shí)相關(guān)
- connectTimeout - 鏈接超時(shí)時(shí)長(zhǎng),默認(rèn)10秒
- readTimeout - 讀取操作超時(shí)時(shí)長(zhǎng)抱慌,默認(rèn)60秒
- writeTimeout - 寫(xiě)操作超時(shí)時(shí)長(zhǎng)逊桦,默認(rèn)60秒
- timeUnit - 超時(shí)時(shí)長(zhǎng)的時(shí)間單位,默認(rèn)是秒抑进,@see {@link TimeUnit}强经,會(huì)影響上面三個(gè)超時(shí)時(shí)長(zhǎng)
- <p>緩存相關(guān)
- cacheSize - 網(wǎng)絡(luò)緩存文件大小,默認(rèn)是10M
- cacheDir - 網(wǎng)絡(luò)緩存文件的路徑寺渗,默認(rèn)是context.getCacheDir()+/xes/network;
cache
使用DiskLruCache是因?yàn)镺KHttp自帶的網(wǎng)絡(luò)緩存只支持GET請(qǐng)求匿情,POST請(qǐng)求無(wú)法進(jìn)行數(shù)據(jù)緩存。為了對(duì)數(shù)據(jù)緩存進(jìn)行統(tǒng)一的管理信殊,使用DiskLruCache對(duì)網(wǎng)絡(luò)數(shù)據(jù)進(jìn)行磁盤(pán)緩存炬称。
介紹幾個(gè)比較重要的方法
- String createCacheKey(Request request)
根據(jù)攔截器中的Request對(duì)象生成數(shù)據(jù)緩存的key,其實(shí)就是網(wǎng)絡(luò)請(qǐng)求的URL涡拘,不帶參數(shù)玲躯。 - String createCacheValue(Response response)
根據(jù)攔截器中的Response對(duì)象生成數(shù)據(jù)緩存的value,格式是time(long)#responseContent鳄乏。 - savePostRespones(Request request, Response response)
根據(jù)Request和Response對(duì)接口數(shù)據(jù)進(jìn)行磁盤(pán)緩存跷车。
converter
自定義XesConverterFactory代替Retrofit的GsonConverterFactory,達(dá)到同事支持String和JsonBean的目的橱野。
https
網(wǎng)絡(luò)框架支持https請(qǐng)求姓赤,目前采用信任所有證書(shū)的方案,不進(jìn)行證書(shū)校驗(yàn)仲吏。
retrofit_url
歷史遺留內(nèi)容不铆,不作為對(duì)外開(kāi)放的功能,主要作用是通過(guò)識(shí)別header中的DOMAIN_NAME對(duì)url進(jìn)行動(dòng)態(tài)切換裹唆。
interceptor
這是一個(gè)比較重要的內(nèi)容誓斥,包含以下一些方面。
- HeadersInterceptor
通過(guò)持有NetOptions的commonHeaders屬性许帐,攔截請(qǐng)求添加通用header劳坑。 - ParamsInterceptor
通過(guò)持有NetOptions的commonParams屬性,攔截請(qǐng)求添加通用參數(shù)成畦。 - LocalCacheInterceptor
無(wú)網(wǎng)絡(luò)時(shí)距芬,識(shí)別緩存設(shè)置,直接攔截請(qǐng)求返回本地緩存數(shù)據(jù)循帐。 - NetCacheInterceptor
接口訪問(wèn)成功時(shí)框仔,識(shí)別緩存設(shè)置,保存接口數(shù)據(jù)拄养。
后期需要完善的地方
- 網(wǎng)絡(luò)緩存目前只支持按照url進(jìn)行緩存离斩,如果一個(gè)接口在多處調(diào)用,緩存數(shù)據(jù)無(wú)法區(qū)分。
- 先讀取本地后請(qǐng)求網(wǎng)絡(luò)的API需要傳入5個(gè)參數(shù)跛梗,使用不方便寻馏。
- 網(wǎng)絡(luò)緩存只能保證緩存請(qǐng)求成功的數(shù)據(jù),status!=0的錯(cuò)誤數(shù)據(jù)也會(huì)緩存核偿。
- SSL證書(shū)識(shí)別認(rèn)證诚欠。
- 運(yùn)行過(guò)程中修改通用參數(shù)、通用header等漾岳。