Retrofit 2 源碼解析
關(guān)于Retrofit 2的使用請(qǐng)看上一篇http://www.itdecent.cn/p/52ad1fb8f6e1
直接點(diǎn)開(kāi)Retrofit 類,在注釋中就告訴了我們?cè)趺词褂茫?/p>

App應(yīng)用程序通過(guò) Retrofit 請(qǐng)求網(wǎng)絡(luò),實(shí)際上是使用 Retrofit 接口層封裝請(qǐng)求參數(shù)、Header、Url 等信息,之后由 OkHttp 完成后續(xù)的請(qǐng)求操作 ,在服務(wù)端返回?cái)?shù)據(jù)之后,OkHttp 將原始的結(jié)果交給 Retrofit,Retrofit根據(jù)用戶的需求對(duì)結(jié)果進(jìn)行解析
Retrofit對(duì)比其他網(wǎng)絡(luò)請(qǐng)求框架

通過(guò)解析 網(wǎng)絡(luò)請(qǐng)求接口的注解 配置 網(wǎng)絡(luò)請(qǐng)求參數(shù)
通過(guò) 動(dòng)態(tài)代理 生成 網(wǎng)絡(luò)請(qǐng)求對(duì)象
通過(guò) 網(wǎng)絡(luò)請(qǐng)求適配器 將 網(wǎng)絡(luò)請(qǐng)求對(duì)象 進(jìn)行平臺(tái)適配 Android、Rxjava、Guava和java8
通過(guò) 網(wǎng)絡(luò)請(qǐng)求執(zhí)行器 發(fā)送網(wǎng)絡(luò)請(qǐng)求
通過(guò) 數(shù)據(jù)轉(zhuǎn)換器 解析服務(wù)器返回的數(shù)據(jù)
通過(guò) 回調(diào)執(zhí)行器 切換線程(子線程 ->>主線程)
用戶在主線程處理返回結(jié)果

請(qǐng)求過(guò)程分析
- 創(chuàng)建Retrofit實(shí)例
- 創(chuàng)建 網(wǎng)絡(luò)請(qǐng)求接口實(shí)例 并 配置網(wǎng)絡(luò)請(qǐng)求參數(shù)
- 發(fā)送網(wǎng)絡(luò)請(qǐng)求
- 處理服務(wù)器返回?cái)?shù)據(jù)
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://fanyi.youdao.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();
把上面的請(qǐng)求分為五個(gè)步驟,如下:

步驟一
private final Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();
// 網(wǎng)絡(luò)請(qǐng)求配置對(duì)象(對(duì)網(wǎng)絡(luò)請(qǐng)求接口中方法注解進(jìn)行解析后得到的對(duì)象)
// 作用:存儲(chǔ)網(wǎng)絡(luò)請(qǐng)求相關(guān)的配置,如網(wǎng)絡(luò)請(qǐng)求的方法、數(shù)據(jù)轉(zhuǎn)換器、網(wǎng)絡(luò)請(qǐng)求適配器、網(wǎng)絡(luò)請(qǐng)求工廠、基地址等
private final HttpUrl baseUrl;
// 網(wǎng)絡(luò)請(qǐng)求的url地址
private final okhttp3.Call.Factory callFactory;
// 網(wǎng)絡(luò)請(qǐng)求器的工廠
// 作用:生產(chǎn)網(wǎng)絡(luò)請(qǐng)求器(Call)
// Retrofit是默認(rèn)使用okhttp
private final List<CallAdapter.Factory> adapterFactories;
// 網(wǎng)絡(luò)請(qǐng)求適配器工廠的集合
// 作用:放置網(wǎng)絡(luò)請(qǐng)求適配器工廠
// 網(wǎng)絡(luò)請(qǐng)求適配器工廠作用:生產(chǎn)網(wǎng)絡(luò)請(qǐng)求適配器(CallAdapter)
// 下面會(huì)詳細(xì)說(shuō)明
private final List<Converter.Factory> converterFactories;
// 數(shù)據(jù)轉(zhuǎn)換器工廠的集合
// 作用:放置數(shù)據(jù)轉(zhuǎn)換器工廠
// 數(shù)據(jù)轉(zhuǎn)換器工廠作用:生產(chǎn)數(shù)據(jù)轉(zhuǎn)換器(converter)
private final Executor callbackExecutor;
// 回調(diào)方法執(zhí)行器
private final boolean validateEagerly;
// 標(biāo)志位
// 作用:是否提前對(duì)業(yè)務(wù)接口中的注解進(jìn)行驗(yàn)證轉(zhuǎn)換的標(biāo)志位
<-- Retrofit類的構(gòu)造函數(shù) -->
Retrofit(okhttp3.Call.Factory callFactory, HttpUrl baseUrl,
List<Converter.Factory> converterFactories, List<CallAdapter.Factory> adapterFactories,
Executor callbackExecutor, boolean validateEagerly) {
this.callFactory = callFactory;
this.baseUrl = baseUrl;
this.converterFactories = unmodifiableList(converterFactories);
this.adapterFactories = unmodifiableList(adapterFactories);
// unmodifiableList(list)近似于UnmodifiableList<E>(list)
// 作用:創(chuàng)建的新對(duì)象能夠?qū)ist數(shù)據(jù)進(jìn)行訪問(wèn),但不可通過(guò)該對(duì)象對(duì)list集合中的元素進(jìn)行修改
this.callbackExecutor = callbackExecutor;
this.validateEagerly = validateEagerly;
...
// 僅貼出關(guān)鍵代碼
}
private final Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();
// 網(wǎng)絡(luò)請(qǐng)求配置對(duì)象(對(duì)網(wǎng)絡(luò)請(qǐng)求接口中方法注解進(jìn)行解析后得到的對(duì)象)
// 作用:存儲(chǔ)網(wǎng)絡(luò)請(qǐng)求相關(guān)的配置,如網(wǎng)絡(luò)請(qǐng)求的方法、數(shù)據(jù)轉(zhuǎn)換器、網(wǎng)絡(luò)請(qǐng)求適配器、網(wǎng)絡(luò)請(qǐng)求工廠、基地址等
private final HttpUrl baseUrl;
// 網(wǎng)絡(luò)請(qǐng)求的url地址
private final okhttp3.Call.Factory callFactory;
// 網(wǎng)絡(luò)請(qǐng)求器的工廠
// 作用:生產(chǎn)網(wǎng)絡(luò)請(qǐng)求器(Call)
// Retrofit是默認(rèn)使用okhttp
private final List<CallAdapter.Factory> adapterFactories;
// 網(wǎng)絡(luò)請(qǐng)求適配器工廠的集合
// 作用:放置網(wǎng)絡(luò)請(qǐng)求適配器工廠
// 網(wǎng)絡(luò)請(qǐng)求適配器工廠作用:生產(chǎn)網(wǎng)絡(luò)請(qǐng)求適配器(CallAdapter)
// 下面會(huì)詳細(xì)說(shuō)明
private final List<Converter.Factory> converterFactories;
// 數(shù)據(jù)轉(zhuǎn)換器工廠的集合
// 作用:放置數(shù)據(jù)轉(zhuǎn)換器工廠
// 數(shù)據(jù)轉(zhuǎn)換器工廠作用:生產(chǎn)數(shù)據(jù)轉(zhuǎn)換器(converter)
private final Executor callbackExecutor;
// 回調(diào)方法執(zhí)行器
private final boolean validateEagerly;
// 標(biāo)志位
// 作用:是否提前對(duì)業(yè)務(wù)接口中的注解進(jìn)行驗(yàn)證轉(zhuǎn)換的標(biāo)志位
<-- Retrofit類的構(gòu)造函數(shù) -->
Retrofit(okhttp3.Call.Factory callFactory, HttpUrl baseUrl,
List<Converter.Factory> converterFactories, List<CallAdapter.Factory> adapterFactories,
Executor callbackExecutor, boolean validateEagerly) {
this.callFactory = callFactory;
this.baseUrl = baseUrl;
this.converterFactories = unmodifiableList(converterFactories);
this.adapterFactories = unmodifiableList(adapterFactories);
// unmodifiableList(list)近似于UnmodifiableList<E>(list)
// 作用:創(chuàng)建的新對(duì)象能夠?qū)ist數(shù)據(jù)進(jìn)行訪問(wèn),但不可通過(guò)該對(duì)象對(duì)list集合中的元素進(jìn)行修改
this.callbackExecutor = callbackExecutor;
this.validateEagerly = validateEagerly;
...
// 僅貼出關(guān)鍵代碼
}
CallAdapterFactory:該Factory生產(chǎn)的是CallAdapter,那么CallAdapter又是什么呢
定義:網(wǎng)絡(luò)請(qǐng)求執(zhí)行器(Call)的適配器
Call在Retrofit里默認(rèn)是OkHttpCall
在Retrofit中提供了四種CallAdapterFactory: ExecutorCallAdapterFactory(默認(rèn))、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory 用最小代價(jià)兼容更多平臺(tái),即能適配更多的使用場(chǎng)景
作用:將默認(rèn)的網(wǎng)絡(luò)請(qǐng)求執(zhí)行器(OkHttpCall)轉(zhuǎn)換成適合被不同平臺(tái)來(lái)調(diào)用的網(wǎng)絡(luò)請(qǐng)求執(zhí)行器形式一開(kāi)始Retrofit只打算利用OkHttpCall通過(guò)ExecutorCallbackCall切換線程;但后來(lái)發(fā)現(xiàn)使用Rxjava更加方便(不需要Handler來(lái)切換線程)。想要實(shí)現(xiàn)Rxjava的情況,那就得使用RxJavaCallAdapterFactoryCallAdapter將OkHttpCall轉(zhuǎn)換成Rxjava(Scheduler):
// 把response封裝成rxjava的Observeble,然后進(jìn)行流式操作
Retrofit.Builder.addCallAdapterFactory(newRxJavaCallAdapterFactory().create());
// 關(guān)于RxJava的使用這里不作更多的展開(kāi)
步驟二
可以看到第二步里面build()調(diào)用了
[圖片上傳失敗...(image-74f7a6-1524191132468)]
而這個(gè)PlatFrom方法 里面有調(diào)用了findPlatform()去判斷平臺(tái)是安卓還是Java8還是其他
private static Platform findPlatform() {
try {
Class.forName("android.os.Build");
if (Build.VERSION.SDK_INT != 0) {
return new Android();
}
} catch (ClassNotFoundException ignored) {
}
try {
Class.forName("java.util.Optional");
return new Java8();
} catch (ClassNotFoundException ignored) {
}
try {
Class.forName("org.robovm.apple.foundation.NSObject");
return new IOS();
} catch (ClassNotFoundException ignored) {
}
return new Platform();
}
這里返回的是一個(gè)Platform對(duì)象, 就是什么平臺(tái),這里我們主要看下安卓
static class Android extends Platform {
// 創(chuàng)建默認(rèn)的網(wǎng)絡(luò)請(qǐng)求適配器工廠
// 該默認(rèn)工廠生產(chǎn)的 adapter 會(huì)使得Call在異步調(diào)用時(shí)在指定的 Executor 上執(zhí)行回調(diào)
// 在Retrofit中提供了四種CallAdapterFactory: ExecutorCallAdapterFactory(默認(rèn))、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory
// 采用了策略模式
@Override public Executor defaultCallbackExecutor() {
return new MainThreadExecutor();
}
// 返回一個(gè)默認(rèn)的回調(diào)方法執(zhí)行器
// 該執(zhí)行器作用:切換線程(子->>主線程),并在主線程(UI線程)中執(zhí)行回調(diào)方法
@Override CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
return new ExecutorCallAdapterFactory(callbackExecutor);
}
static class MainThreadExecutor implements Executor {
private final Handler handler = new Handler(Looper.getMainLooper());
@Override public void execute(Runnable r) {
handler.post(r);
}
}
}
用于接收服務(wù)器返回?cái)?shù)據(jù)后進(jìn)行線程切換在主線程顯示結(jié)果,這個(gè)直接綁定一個(gè)主線程的handler ,用于處理在UI線程更新
再看下 Builder的構(gòu)造
<-- 步驟5 -->
// Builder類的構(gòu)造函數(shù)2(有參)
public Builder(Platform platform) {
// 接收Platform對(duì)象(Android平臺(tái))
this.platform = platform;
// 通過(guò)傳入BuiltInConverters()對(duì)象配置數(shù)據(jù)轉(zhuǎn)換器工廠(converterFactories)
// converterFactories是一個(gè)存放數(shù)據(jù)轉(zhuǎn)換器Converter.Factory的數(shù)組
// 配置converterFactories即配置里面的數(shù)據(jù)轉(zhuǎn)換器
converterFactories.add(new BuiltInConverters());
// BuiltInConverters是一個(gè)內(nèi)置的數(shù)據(jù)轉(zhuǎn)換器工廠(繼承Converter.Factory類)
// new BuiltInConverters()是為了初始化數(shù)據(jù)轉(zhuǎn)換器
}
Builder設(shè)置了默認(rèn)的:平臺(tái)類型對(duì)象:Android ,網(wǎng)絡(luò)請(qǐng)求適配器工廠:CallAdapterFactory 數(shù)據(jù)轉(zhuǎn)換器工廠: converterFactory設(shè)置了默認(rèn)值,但未真正配置到具體的Retrofit類的成員變量當(dāng)中
步驟三
/**
* Set the API base URL.
*
* @see #baseUrl(HttpUrl)
*/
public Builder baseUrl(String baseUrl) {
checkNotNull(baseUrl, "baseUrl == null");
HttpUrl httpUrl = HttpUrl.parse(baseUrl);
if (httpUrl == null) {
throw new IllegalArgumentException("Illegal URL: " + baseUrl);
}
return baseUrl(httpUrl);
}
然后再調(diào)用 HttpUrl.parse(“”)
public static HttpUrl parse(String url) {
Builder builder = new Builder();
Builder.ParseResult result = builder.parse(null, url);
return result == Builder.ParseResult.SUCCESS ? builder.build() : null;
}
/** Values which have a host replace the host of {@code baseUrl} and values also with a scheme
* replace the scheme of {@code baseUrl}.
* <p>
* Base URL: http://example.com/<br>
* Endpoint: https://github.com/square/retrofit/<br>
* Result: https://github.com/square/retrofit/
* <p>
* Base URL: http://example.com<br>
* Endpoint: //github.com/square/retrofit/<br>
* Result: http://github.com/square/retrofit/ (note the scheme stays 'http')
*/
public Builder baseUrl(HttpUrl baseUrl) {
checkNotNull(baseUrl, "baseUrl == null");
//把URL參數(shù)分割成幾個(gè)路徑碎片
List<String> pathSegments = baseUrl.pathSegments();
// 檢測(cè)最后一個(gè)碎片來(lái)檢查URL參數(shù)是不是以"/"結(jié)尾
// 不是就拋出異常
if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
}
this.baseUrl = baseUrl;
return this;
}
這里首先檢查是否為空,自己在寫(xiě)的時(shí)候就是url地址末尾沒(méi)有加 / 就報(bào)錯(cuò)了
步驟四
方法中調(diào)用:
public static GsonConverterFactory create() {
return create(new Gson());
}
// 創(chuàng)建了一個(gè)含有Gson對(duì)象實(shí)例的GsonConverterFactory
private GsonConverterFactory(Gson gson) {
if (gson == null) throw new NullPointerException("gson == null");
this.gson = gson;
}
GsonConverterFactory.creat()是創(chuàng)建了一個(gè)含有Gson對(duì)象實(shí)例的GsonConverterFactory,并返回給addConverterFactory()接下來(lái)繼續(xù)看:addConverterFactory()
// 將上面創(chuàng)建的GsonConverterFactory放入到 converterFactories數(shù)組
// 在第二步放入一個(gè)內(nèi)置的數(shù)據(jù)轉(zhuǎn)換器工廠BuiltInConverters()后又放入了一個(gè)GsonConverterFactory
public Builder addConverterFactory(Converter.Factory factory) {
converterFactories.add(checkNotNull(factory, "factory == null"));
return this;
}
注意這里面的converterFactories 是一個(gè)List 集合。步驟4用于創(chuàng)建一個(gè)含有Gson對(duì)象實(shí)例的GsonConverterFactory并放入到數(shù)據(jù)轉(zhuǎn)換器工廠converterFactories里 即Retrofit默認(rèn)使用Gson進(jìn)行解析 若使用其他解析方式(如Json、XML或Protocobuf),也可通過(guò)自定義數(shù)據(jù)解析器來(lái)實(shí)現(xiàn)(必須繼承 Converter.Factory)
步驟五
/**
* Create the {@link Retrofit} instance using the configured values.
* <p>
* Note: If neither {@link #client} nor {@link #callFactory} is called a default {@link
* OkHttpClient} will be created and used.
*/
public Retrofit build() {
if (baseUrl == null) {
throw new IllegalStateException("Base URL required.");
}
okhttp3.Call.Factory callFactory = this.callFactory;
if (callFactory == null) {
callFactory = new OkHttpClient();
}
<-- 配置回調(diào)方法執(zhí)行器(callbackExecutor)-->
Executor callbackExecutor = this.callbackExecutor;
// 如果沒(méi)指定,則默認(rèn)使用Platform檢測(cè)環(huán)境時(shí)的默認(rèn)callbackExecutor
// 即Android默認(rèn)的callbackExecutor
if (callbackExecutor == null) {
callbackExecutor = platform.defaultCallbackExecutor();
}
<-- 配置網(wǎng)絡(luò)請(qǐng)求適配器工廠(CallAdapterFactory)-->
// Make a defensive copy of the adapters and add the default Call adapter.
List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
// 向該集合中添加了步驟2中創(chuàng)建的CallAdapter.Factory請(qǐng)求適配器(添加在集合器末尾
adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
// 請(qǐng)求適配器工廠集合存儲(chǔ)順序:自定義1適配器工廠、自定義2適配器工廠...默認(rèn)適配器工廠(ExecutorCallAdapterF
// Make a defensive copy of the converters.
<-- 配置數(shù)據(jù)轉(zhuǎn)換器工廠:converterFactory -->
// 在步驟2中已經(jīng)添加了內(nèi)置的數(shù)據(jù)轉(zhuǎn)換器BuiltInConverters()(添加到集合器的首位)
// 在步驟4中又插入了一個(gè)Gson的轉(zhuǎn)換器 - GsonConverterFactory(添加到集合器的首二位)
List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);
// 數(shù)據(jù)轉(zhuǎn)換器工廠集合存儲(chǔ)的是:默認(rèn)數(shù)據(jù)轉(zhuǎn)換器工廠( BuiltInConverters)、自定義1數(shù)據(jù)轉(zhuǎn)換器工廠(GsonConverterFactory)、自定義2數(shù)據(jù)轉(zhuǎn)換器工廠....
// 注:
//1\. 獲取合適的網(wǎng)絡(luò)請(qǐng)求適配器和數(shù)據(jù)轉(zhuǎn)換器都是從adapterFactories和converterFactories集合的首位-末位開(kāi)始遍歷
// 因此集合中的工廠位置越靠前就擁有越高的使用權(quán)限
// 最終返回一個(gè)Retrofit的對(duì)象,并傳入上述已經(jīng)配置好的成員變量
return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
callbackExecutor, validateEagerly);
}
在build源碼中作者的注釋中提到,如果既不是client 也不是回調(diào)工廠會(huì)創(chuàng)建一個(gè)默認(rèn)的okhttpClient,// 如果沒(méi)指定,則默認(rèn)使用okhttp所以Retrofit默認(rèn)使用okhttp進(jìn)行網(wǎng)絡(luò)請(qǐng)求
使用建造者模式通過(guò)Builder類建立了一個(gè)Retrofit實(shí)例,具體創(chuàng)建細(xì)節(jié)是配置了:
平臺(tái)類型對(duì)象(Platform - Android)
網(wǎng)絡(luò)請(qǐng)求的url地址(baseUrl)
網(wǎng)絡(luò)請(qǐng)求工廠(callFactory)
默認(rèn)使用OkHttpCall
網(wǎng)絡(luò)請(qǐng)求適配器工廠的集合(adapterFactories):本質(zhì)是配置了網(wǎng)絡(luò)請(qǐng)求適配器工廠- 默認(rèn)是ExecutorCallAdapterFactory
數(shù)據(jù)轉(zhuǎn)換器工廠的集合(converterFactories) :本質(zhì)是配置了數(shù)據(jù)轉(zhuǎn)換器工廠
回調(diào)方法執(zhí)行器(callbackExecutor) 默認(rèn)回調(diào)方法執(zhí)行器作用是:切換線程(子線程 - 主線程)
請(qǐng)求接口的實(shí)例
步驟
<-- 步驟1:定義接收網(wǎng)絡(luò)數(shù)據(jù)的類 -->
<-- JavaBean.java -->
public class JavaBean {
.. // 這里就不介紹了
}
<-- 步驟2:定義網(wǎng)絡(luò)請(qǐng)求的接口類 -->
<-- AccessApi.java -->
public interface AccessApi {
// 注解GET:采用Get方法發(fā)送網(wǎng)絡(luò)請(qǐng)求
// Retrofit把網(wǎng)絡(luò)請(qǐng)求的URL分成了2部分:1部分baseurl放在創(chuàng)建Retrofit對(duì)象時(shí)設(shè)置;另一部分在網(wǎng)絡(luò)請(qǐng)求接口設(shè)置(即這里)
// 如果接口里的URL是一個(gè)完整的網(wǎng)址,那么放在創(chuàng)建Retrofit對(duì)象時(shí)設(shè)置的部分可以不設(shè)置
@GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
// 接受網(wǎng)絡(luò)請(qǐng)求數(shù)據(jù)的方法
Call<JavaBean> getCall();
// 返回類型為Call<*>,*是解析得到的數(shù)據(jù)類型,即JavaBean
}
<-- 步驟3:在MainActivity創(chuàng)建接口類實(shí)例 -->
AccessApi NetService = retrofit.create(AccessApi.class);
<-- 步驟4:對(duì)發(fā)送請(qǐng)求的url進(jìn)行封裝,即生成最終的網(wǎng)絡(luò)請(qǐng)求對(duì)象 -->
Call<JavaBean> call = NetService.getCall();
create 方法講解
public <T> T create(final Class<T> service) {
if (validateEagerly) {
// 判斷是否需要提前驗(yàn)證
eagerlyValidateMethods(service);
// 具體方法作用:
// 1\. 給接口中每個(gè)方法的注解進(jìn)行解析并得到一個(gè)ServiceMethod對(duì)象
// 2\. 以Method為鍵將該對(duì)象存入LinkedHashMap集合中
// 特別注意:如果不是提前驗(yàn)證則進(jìn)行動(dòng)態(tài)解析對(duì)應(yīng)方法(下面會(huì)詳細(xì)說(shuō)明),得到一個(gè)ServiceMethod對(duì)象,最后存入到LinkedHashMap集合中,類似延遲加載(默認(rèn))
}
// 創(chuàng)建了網(wǎng)絡(luò)請(qǐng)求接口的動(dòng)態(tài)代理對(duì)象,即通過(guò)動(dòng)態(tài)代理創(chuàng)建網(wǎng)絡(luò)請(qǐng)求接口的實(shí)例 (并最終返回)
// 該動(dòng)態(tài)代理是為了拿到網(wǎng)絡(luò)請(qǐng)求接口實(shí)例上所有注解
return (T) Proxy.newProxyInstance(
service.getClassLoader(), // 動(dòng)態(tài)生成接口的實(shí)現(xiàn)類
new Class<?>[] { service }, // 動(dòng)態(tài)創(chuàng)建實(shí)例
new InvocationHandler() { // 將代理類的實(shí)現(xiàn)交給 InvocationHandler類作為具體的實(shí)現(xiàn)(下面會(huì)解釋)
private final Platform platform = Platform.get();
// 在 InvocationHandler類的invoke()實(shí)現(xiàn)中,除了執(zhí)行真正的邏輯(如再次轉(zhuǎn)發(fā)給真正的實(shí)現(xiàn)類對(duì)象),還可以進(jìn)行一些有用的操作
// 如統(tǒng)計(jì)執(zhí)行時(shí)間、進(jìn)行初始化和清理、對(duì)接口調(diào)用進(jìn)行檢查等。
@Override
public Object invoke(Object proxy, Method method, Object... args)
throws Throwable {
// 下面會(huì)詳細(xì)介紹 invoke()的實(shí)現(xiàn)
// 即下面三行代碼
ServiceMethod serviceMethod = loadServiceMethod(method);
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
return serviceMethod.callAdapter.adapt(okHttpCall);
}
});
}
// 特別注意
// return (T) roxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler invocationHandler)
// 可以解讀為:getProxyClass(loader, interfaces) .getConstructor(InvocationHandler.class).newInstance(invocationHandler);
// 即通過(guò)動(dòng)態(tài)生成的代理類,調(diào)用interfaces接口的方法實(shí)際上是通過(guò)調(diào)用InvocationHandler對(duì)象的invoke()來(lái)完成指定的功能
// 先記住結(jié)論,在講解步驟4的時(shí)候會(huì)再次詳細(xì)說(shuō)明
<-- 關(guān)注點(diǎn)1:eagerlyValidateMethods() -->
private void eagerlyValidateMethods(Class<?> service) {
Platform platform = Platform.get();
for (Method method : service.getDeclaredMethods()) {
if (!platform.isDefaultMethod(method)) { loadServiceMethod(method); }
// 將傳入的ServiceMethod對(duì)象加入LinkedHashMap<Method, ServiceMethod>集合
// 使用LinkedHashMap集合的好處:lruEntries.values().iterator().next()獲取到的是集合最不經(jīng)常用到的元素,提供了一種Lru算法的實(shí)現(xiàn)
}
}
`return (T) roxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler invocationHandler)通過(guò)代理模式中的動(dòng)態(tài)代理模式,動(dòng)態(tài)生成網(wǎng)絡(luò)請(qǐng)求接口的代理類,并將代理類的實(shí)例創(chuàng)建交給InvocationHandler類 作為具體的實(shí)現(xiàn),并最終返回一個(gè)動(dòng)態(tài)代理對(duì)象。
生成實(shí)例過(guò)程中含有生成實(shí)現(xiàn)類的緩存機(jī)制(單例模式),下面會(huì)詳細(xì)分析
使用動(dòng)態(tài)代理的好處:
當(dāng)NetService對(duì)象調(diào)用getCall()接口中方法時(shí)會(huì)進(jìn)行攔截,調(diào)用都會(huì)集中轉(zhuǎn)發(fā)到 InvocationHandler#invoke (),可集中進(jìn)行處理
獲得網(wǎng)絡(luò)請(qǐng)求接口實(shí)例上的所有注解
更方便封裝ServiceMethod
下面將詳細(xì)分析InvocationHandler類 # invoke()里的具體實(shí)現(xiàn)
new InvocationHandler() {
private final Platform platform = Platform.get();
@Override
public Object invoke(Object proxy, Method method, Object... args)
throws Throwable {
// 將詳細(xì)介紹下面代碼
// 關(guān)注點(diǎn)1
// 作用:讀取網(wǎng)絡(luò)請(qǐng)求接口里的方法,并根據(jù)前面配置好的屬性配置serviceMethod對(duì)象
ServiceMethod serviceMethod = loadServiceMethod(method);
// 關(guān)注點(diǎn)2
// 作用:根據(jù)配置好的serviceMethod對(duì)象創(chuàng)建okHttpCall對(duì)象
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
// 關(guān)注點(diǎn)3
// 作用:調(diào)用OkHttp,并根據(jù)okHttpCall返回rejava的Observe對(duì)象或者返回Call
return serviceMethod.callAdapter.adapt(okHttpCall);
}
ServiceMethod serviceMethod = loadServiceMethod(method);
<-- loadServiceMethod(method)方法講解 -->
// 一個(gè) ServiceMethod 對(duì)象對(duì)應(yīng)于網(wǎng)絡(luò)請(qǐng)求接口里的一個(gè)方法
// loadServiceMethod(method)負(fù)責(zé)加載 ServiceMethod:
ServiceMethod loadServiceMethod(Method method) {
ServiceMethod result;
// 設(shè)置線程同步鎖
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
// ServiceMethod類對(duì)象采用了單例模式進(jìn)行創(chuàng)建
// 即創(chuàng)建ServiceMethod對(duì)象前,先看serviceMethodCache有沒(méi)有緩存之前創(chuàng)建過(guò)的網(wǎng)絡(luò)請(qǐng)求實(shí)例
// 若沒(méi)緩存,則通過(guò)建造者模式創(chuàng)建 serviceMethod 對(duì)象
if (result == null) {
// 下面會(huì)詳細(xì)介紹ServiceMethod生成實(shí)例的過(guò)程
result = new ServiceMethod.Builder(this, method).build();
serviceMethodCache.put(method, result);
}
}
return result;
}
// 這里就是上面說(shuō)的創(chuàng)建實(shí)例的緩存機(jī)制:采用單例模式從而實(shí)現(xiàn)一個(gè) ServiceMethod 對(duì)象對(duì)應(yīng)于網(wǎng)絡(luò)請(qǐng)求接口里的一個(gè)方法
// 注:由于每次獲取接口實(shí)例都是傳入 class 對(duì)象
// 而 class 對(duì)象在進(jìn)程內(nèi)單例的,所以獲取到它的同一個(gè)方法 Method 實(shí)例也是單例的,所以這里的緩存是有效的。
下面,我將分3個(gè)步驟詳細(xì)分析serviceMethod實(shí)例的創(chuàng)建過(guò)程:
Paste_Image.png
步驟1:ServiceMethod類 構(gòu)造函數(shù)
Paste_Image.png
<– ServiceMethod 類 –>
public final class ServiceMethod {
final okhttp3.Call.Factory callFactory; // 網(wǎng)絡(luò)請(qǐng)求工廠
final CallAdapter<?> callAdapter;
// 網(wǎng)絡(luò)請(qǐng)求適配器工廠
// 具體創(chuàng)建是在new ServiceMethod.Builder(this, method).build()最后的build()中
// 下面會(huì)詳細(xì)說(shuō)明
private final Converter<ResponseBody, T> responseConverter;
// Response內(nèi)容轉(zhuǎn)換器
// 作用:負(fù)責(zé)把服務(wù)器返回的數(shù)據(jù)(JSON或者其他格式,由 ResponseBody 封裝)轉(zhuǎn)化為 T 類型的對(duì)象;
private final HttpUrl baseUrl; // 網(wǎng)絡(luò)請(qǐng)求地址
private final String relativeUrl; // 網(wǎng)絡(luò)請(qǐng)求的相對(duì)地址
private final String httpMethod; // 網(wǎng)絡(luò)請(qǐng)求的Http方法
private final Headers headers; // 網(wǎng)絡(luò)請(qǐng)求的http請(qǐng)求頭 鍵值對(duì)
private final MediaType contentType; // 網(wǎng)絡(luò)請(qǐng)求的http報(bào)文body的類型
private final ParameterHandler<?>[] parameterHandlers;
// 方法參數(shù)處理器
// 作用:負(fù)責(zé)解析 API 定義時(shí)每個(gè)方法的參數(shù),并在構(gòu)造 HTTP 請(qǐng)求時(shí)設(shè)置參數(shù);
// 下面會(huì)詳細(xì)說(shuō)明
// 說(shuō)明:從上面的成員變量可以看出,ServiceMethod對(duì)象包含了訪問(wèn)網(wǎng)絡(luò)的所有基本信息
<– ServiceMethod 類的構(gòu)造函數(shù) –>
// 作用:傳入各種網(wǎng)絡(luò)請(qǐng)求參數(shù)
ServiceMethod(Builder builder) {
this.callFactory = builder.retrofit.callFactory();
this.callAdapter = builder.callAdapter;
this.responseConverter = builder.responseConverter;
this.baseUrl = builder.retrofit.baseUrl();
this.relativeUrl = builder.relativeUrl;
this.httpMethod = builder.httpMethod;
this.headers = builder.headers;
this.contentType = builder.contentType; .
this.hasBody = builder.hasBody; y
this.isFormEncoded = builder.isFormEncoded;
this.isMultipart = builder.isMultipart;
this.parameterHandlers = builder.parameterHandlers;
}
步驟2:ServiceMethod的Builder()
public Builder(Retrofit retrofit, Method method) {
this.retrofit = retrofit;
this.method = method;
// 獲取網(wǎng)絡(luò)請(qǐng)求接口方法里的注釋
this.methodAnnotations = method.getAnnotations();
// 獲取網(wǎng)絡(luò)請(qǐng)求接口方法里的參數(shù)類型
this.parameterTypes = method.getGenericParameterTypes();
//獲取網(wǎng)絡(luò)請(qǐng)求接口方法里的注解內(nèi)容
this.parameterAnnotationsArray = method.getParameterAnnotations();
}
步驟3:ServiceMethod的build()
Paste_Image.png
// 作用:控制ServiceMethod對(duì)象的生成流程
public ServiceMethod build() {
callAdapter = createCallAdapter();
// 根據(jù)網(wǎng)絡(luò)請(qǐng)求接口方法的返回值和注解類型,從Retrofit對(duì)象中獲取對(duì)應(yīng)的網(wǎng)絡(luò)請(qǐng)求適配器 -->關(guān)注點(diǎn)1
responseType = callAdapter.responseType();
// 根據(jù)網(wǎng)絡(luò)請(qǐng)求接口方法的返回值和注解類型,從Retrofit對(duì)象中獲取該網(wǎng)絡(luò)適配器返回的數(shù)據(jù)類型
responseConverter = createResponseConverter();
// 根據(jù)網(wǎng)絡(luò)請(qǐng)求接口方法的返回值和注解類型,從Retrofit對(duì)象中獲取對(duì)應(yīng)的數(shù)據(jù)轉(zhuǎn)換器 -->關(guān)注點(diǎn)3
// 構(gòu)造 HTTP 請(qǐng)求時(shí),我們傳遞的參數(shù)都是String
// Retrofit 類提供 converter把傳遞的參數(shù)都轉(zhuǎn)化為 String
// 其余類型的參數(shù)都利用 Converter.Factory 的stringConverter 進(jìn)行轉(zhuǎn)換
// @Body 和 @Part 類型的參數(shù)利用Converter.Factory 提供的 requestBodyConverter 進(jìn)行轉(zhuǎn)換
// 這三種 converter 都是通過(guò)“詢問(wèn)”工廠列表進(jìn)行提供,而工廠列表我們可以在構(gòu)造 Retrofit 對(duì)象時(shí)進(jìn)行添加。
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
// 解析網(wǎng)絡(luò)請(qǐng)求接口中方法的注解
// 主要是解析獲取Http請(qǐng)求的方法
// 注解包括:DELETE、GET、POST、HEAD、PATCH、PUT、OPTIONS、HTTP、retrofit2.http.Headers、Multipart、FormUrlEncoded
// 處理主要是調(diào)用方法 parseHttpMethodAndPath(String httpMethod, String value, boolean hasBody) ServiceMethod中的httpMethod、hasBody、relativeUrl、relativeUrlParamNames域進(jìn)行賦值
int parameterCount = parameterAnnotationsArray.length;
// 獲取當(dāng)前方法的參數(shù)數(shù)量
parameterHandlers = new ParameterHandler<?>[parameterCount];
for (int p = 0; p < parameterCount; p++) {
Type parameterType = parameterTypes[p];
Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
// 為方法中的每個(gè)參數(shù)創(chuàng)建一個(gè)ParameterHandler<?>對(duì)象并解析每個(gè)參數(shù)使用的注解類型
// 該對(duì)象的創(chuàng)建過(guò)程就是對(duì)方法參數(shù)中注解進(jìn)行解析
// 這里的注解包括:Body、PartMap、Part、FieldMap、Field、Header、QueryMap、Query、Path、Url
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
}
return new ServiceMethod<>(this);
<-- 總結(jié) -->
// 1\. 根據(jù)返回值類型和方法標(biāo)注從Retrofit對(duì)象的的網(wǎng)絡(luò)請(qǐng)求適配器工廠集合和內(nèi)容轉(zhuǎn)換器工廠集合中分別獲取到該方法對(duì)應(yīng)的網(wǎng)絡(luò)請(qǐng)求適配器和Response內(nèi)容轉(zhuǎn)換器;
// 2\. 根據(jù)方法的標(biāo)注對(duì)ServiceMethod的域進(jìn)行賦值
// 3\. 最后為每個(gè)方法的參數(shù)的標(biāo)注進(jìn)行解析,獲得一個(gè)ParameterHandler<?>對(duì)象
// 該對(duì)象保存有一個(gè)Request內(nèi)容轉(zhuǎn)換器——根據(jù)參數(shù)的類型從Retrofit的內(nèi)容轉(zhuǎn)換器工廠集合中獲取一個(gè)Request內(nèi)容轉(zhuǎn)換器或者一個(gè)String內(nèi)容轉(zhuǎn)換器。
}
<-- 關(guān)注點(diǎn)1:createCallAdapter() -->
private CallAdapter<?> createCallAdapter() {
// 獲取網(wǎng)絡(luò)請(qǐng)求接口里方法的返回值類型
Type returnType = method.getGenericReturnType();
// 獲取網(wǎng)絡(luò)請(qǐng)求接口接口里的注解
// 此處使用的是@Get
Annotation[] annotations = method.getAnnotations();
try {
return retrofit.callAdapter(returnType, annotations);
// 根據(jù)網(wǎng)絡(luò)請(qǐng)求接口方法的返回值和注解類型,從Retrofit對(duì)象中獲取對(duì)應(yīng)的網(wǎng)絡(luò)請(qǐng)求適配器
// 下面會(huì)詳細(xì)說(shuō)明retrofit.callAdapter() -- >關(guān)注點(diǎn)2
}
<-- 關(guān)注點(diǎn)2:retrofit.callAdapter() -->
public CallAdapter<?> callAdapter(Type returnType, Annotation[] annotations) {
return nextCallAdapter(null, returnType, annotations);
}
public CallAdapter<?> nextCallAdapter(CallAdapter.Factory skipPast, Type returnType,
Annotation[] annotations) {
// 創(chuàng)建 CallAdapter 如下
// 遍歷 CallAdapter.Factory 集合尋找合適的工廠(該工廠集合在第一步構(gòu)造 Retrofit 對(duì)象時(shí)進(jìn)行添加(第一步時(shí)已經(jīng)說(shuō)明))
// 如果最終沒(méi)有工廠提供需要的 CallAdapter,將拋出異常
for (int i = start, count = adapterFactories.size(); i < count; i++) {
CallAdapter<?> adapter = adapterFactories.get(i).get(returnType, annotations, this);
if (adapter != null) {
return adapter;
}
}
<-- 關(guān)注點(diǎn)3:createResponseConverter() -->
private Converter<ResponseBody, T> createResponseConverter() {
Annotation[] annotations = method.getAnnotations();
try {
// responseConverter 還是由 Retrofit 類提供 -->關(guān)注點(diǎn)4
return retrofit.responseBodyConverter(responseType, annotations);
} catch (RuntimeException e) {
throw methodError(e, "Unable to create converter for %s", responseType);
}
}
<-- 關(guān)注點(diǎn)4:responseBodyConverter() -->
public <T> Converter<ResponseBody, T> responseBodyConverter(Type type, Annotation[] annotations) {
return nextResponseBodyConverter(null, type, annotations);
}
public <T> Converter<ResponseBody, T> nextResponseBodyConverter(Converter.Factory skipPast,
int start = converterFactories.indexOf(skipPast) + 1;
for (int i = start, count = converterFactories.size(); i < count; i++) {
// 獲取Converter 過(guò)程:(和獲取 callAdapter 基本一致)
Converter<ResponseBody, ?> converter =
converterFactories.get(i).responseBodyConverter(type, annotations, this);
// 遍歷 Converter.Factory 集合并尋找合適的工廠(該工廠集合在構(gòu)造 Retrofit 對(duì)象時(shí)進(jìn)行添加(第一步時(shí)已經(jīng)說(shuō)明))
// 由于構(gòu)造Retroifit采用的是Gson解析方式,所以取出的是GsonResponseBodyConverter
// Retrofit - Converters 還提供了 JSON,XML,ProtoBuf 等類型數(shù)據(jù)的轉(zhuǎn)換功能。
// 繼續(xù)看responseBodyConverter() -->關(guān)注點(diǎn)5
}
<– 關(guān)注點(diǎn)5:responseBodyConverter() –>
@Override
public Converter<ResponseBody, ?> responseBodyConverter(Type type,
Annotation[] annotations, Retrofit retrofit) {
TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
// 根據(jù)目標(biāo)類型,利用 Gson#getAdapter 獲取相應(yīng)的 adapter
return new GsonResponseBodyConverter<>(gson, adapter);
}
// 做數(shù)據(jù)轉(zhuǎn)換時(shí)調(diào)用 Gson 的 API 即可。
final class GsonResponseBodyConverter<T> implements Converter<ResponseBody, T> {
private final Gson gson;
private final TypeAdapter<T> adapter;
GsonResponseBodyConverter(Gson gson, TypeAdapter<T> adapter) {
this.gson = gson;
this.adapter = adapter;
}
@Override
public T convert(ResponseBody value) throws IOException {
JsonReader jsonReader = gson.newJsonReader(value.charStream());
try {
return adapter.read(jsonReader);
} finally {
value.close();
}
}
}
當(dāng)選擇了RxjavaCallAdapterFactory后,Rxjava通過(guò)策略模式選擇對(duì)應(yīng)的adapter
關(guān)于策略模式的講解,請(qǐng)看文章策略模式(Strategy Pattern)- 最易懂的設(shè)計(jì)模式解析
具體過(guò)程是:根據(jù)網(wǎng)絡(luò)接口方法的返回值類型來(lái)選擇具體要用哪種CallAdapterFactory,然后創(chuàng)建具體的CallAdapter實(shí)例
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
根據(jù)第一步配置好的ServiceMethod對(duì)象和輸入的請(qǐng)求參數(shù)創(chuàng)建okHttpCall對(duì)象
<--OkHttpCall類 -->
public class OkHttpCall {
private final ServiceMethod<T> serviceMethod; // 含有所有網(wǎng)絡(luò)請(qǐng)求參數(shù)信息的對(duì)象
private final Object[] args; // 網(wǎng)絡(luò)請(qǐng)求接口的參數(shù)
private okhttp3.Call rawCall; //實(shí)際進(jìn)行網(wǎng)絡(luò)訪問(wèn)的類
private Throwable creationFailure; //幾個(gè)狀態(tài)標(biāo)志位
private boolean executed;
private volatile boolean canceled;
<--OkHttpCall構(gòu)造函數(shù) -->
public OkHttpCall(ServiceMethod<T> serviceMethod, Object[] args) {
// 傳入了配置好的ServiceMethod對(duì)象和輸入的請(qǐng)求參數(shù)
this.serviceMethod = serviceMethod;
this.args = args;
}
#####第三行:return serviceMethod.callAdapter.adapt(okHttpCall);
將第二步創(chuàng)建的OkHttpCall對(duì)象傳給第一步創(chuàng)建的serviceMethod對(duì)象中對(duì)應(yīng)的網(wǎng)絡(luò)請(qǐng)求適配器工廠的adapt()
返回對(duì)象類型:Android默認(rèn)的是Call<>;若設(shè)置了RxJavaCallAdapterFactory,返回的則是Observable<>
<-- adapt()詳解-->
public <R> Call<R> adapt(Call<R> call) {
return new ExecutorCallbackCall<>(callbackExecutor, call);
}
ExecutorCallbackCall(Executor callbackExecutor, Call<T> delegate) {
this.delegate = delegate;
// 把上面創(chuàng)建并配置好參數(shù)的OkhttpCall對(duì)象交給靜態(tài)代理delegate
// 靜態(tài)代理和動(dòng)態(tài)代理都屬于代理模式
// 靜態(tài)代理作用:代理執(zhí)行被代理者的方法,且可在要執(zhí)行的方法前后加入自己的動(dòng)作,進(jìn)行對(duì)系統(tǒng)功能的拓展
this.callbackExecutor = callbackExecutor;
// 傳入上面定義的回調(diào)方法執(zhí)行器
// 用于進(jìn)行線程切換
}
采用了裝飾模式:ExecutorCallbackCall = 裝飾者,而里面真正去執(zhí)行網(wǎng)絡(luò)請(qǐng)求的還是OkHttpCall
使用裝飾模式的原因:希望在OkHttpCall發(fā)送請(qǐng)求時(shí)做一些額外操作。這里的額外操作是線程轉(zhuǎn)換,即將子線程切換到主線程
OkHttpCall的enqueue()是進(jìn)行網(wǎng)絡(luò)異步請(qǐng)求的:當(dāng)你調(diào)用OkHttpCall.enqueue()時(shí),回調(diào)的callback是在子線程中,需要通過(guò)Handler轉(zhuǎn)換到主線程進(jìn)行回調(diào)。ExecutorCallbackCall就是用于線程回調(diào);
當(dāng)然以上是原生Retrofit使用的切換線程方式。如果你用Rxjava,那就不會(huì)用到這個(gè)ExecutorCallbackCall而是RxJava的Call,此處不過(guò)多展開(kāi)
步驟4講解:Call call = NetService.getCall();
NetService對(duì)象實(shí)際上是動(dòng)態(tài)代理對(duì)象Proxy.newProxyInstance()(步驟3中已說(shuō)明),并不是真正的網(wǎng)絡(luò)請(qǐng)求接口創(chuàng)建的對(duì)象
當(dāng)NetService對(duì)象調(diào)用getCall()時(shí)會(huì)被動(dòng)態(tài)代理對(duì)象Proxy.newProxyInstance()攔截,然后調(diào)用自身的InvocationHandler # invoke()
invoke(Object proxy, Method method, Object… args)會(huì)傳入3個(gè)參數(shù):Object proxy:(代理對(duì)象)、
Method method(調(diào)用的getCall())
Object… args(方法的參數(shù),即getCall()中的)
接下來(lái)利用Java反射獲取到getCall()的注解信息,配合args參數(shù)創(chuàng)建ServiceMethod對(duì)象。
如上面步驟3描述,此處不再次講解
最終創(chuàng)建并返回一個(gè)OkHttpCall類型的Call對(duì)象
- OkHttpCall類是OkHttp的包裝類
- 創(chuàng)建了OkHttpCall類型的Call對(duì)象還不能發(fā)送網(wǎng)絡(luò)請(qǐng)求,需要?jiǎng)?chuàng)建Request對(duì)象才能發(fā)送網(wǎng)絡(luò)請(qǐng)求
總結(jié)
Retrofit采用了 外觀模式 統(tǒng)一調(diào)用創(chuàng)建網(wǎng)絡(luò)請(qǐng)求接口實(shí)例和網(wǎng)絡(luò)請(qǐng)求參數(shù)配置的方法,具體細(xì)節(jié)是:
動(dòng)態(tài)創(chuàng)建網(wǎng)絡(luò)請(qǐng)求接口的實(shí)例(代理模式 - 動(dòng)態(tài)代理)
創(chuàng)建 serviceMethod 對(duì)象(建造者模式 & 單例模式(緩存機(jī)制))
對(duì) serviceMethod 對(duì)象進(jìn)行網(wǎng)絡(luò)請(qǐng)求參數(shù)配置:通過(guò)解析網(wǎng)絡(luò)請(qǐng)求接口方法的參數(shù)、返回值和注解類型,從Retrofit對(duì)象中獲取對(duì)應(yīng)的網(wǎng)絡(luò)請(qǐng)求的url地址、網(wǎng)絡(luò)請(qǐng)求執(zhí)行器、網(wǎng)絡(luò)請(qǐng)求適配器 & 數(shù)據(jù)轉(zhuǎn)換器。(策略模式)
對(duì) serviceMethod 對(duì)象加入線程切換的操作,便于接收數(shù)據(jù)后通過(guò)Handler從子線程切換到主線程從而對(duì)返回?cái)?shù)據(jù)結(jié)果進(jìn)行處理(裝飾模式)
最終創(chuàng)建并返回一個(gè)OkHttpCall類型的網(wǎng)絡(luò)請(qǐng)求對(duì)象
- 執(zhí)行網(wǎng)絡(luò)請(qǐng)求
Retrofit默認(rèn)使用OkHttp,即OkHttpCall類(實(shí)現(xiàn)了 retrofit2.Call接口)
但可以自定義選擇自己需要的Call類
OkHttpCall提供了兩種網(wǎng)絡(luò)請(qǐng)求方式:
同步請(qǐng)求:OkHttpCall.execute()
異步請(qǐng)求:OkHttpCall.enqueue()
下面將詳細(xì)介紹這兩種網(wǎng)絡(luò)請(qǐng)求方式。
對(duì)于OkHttpCall的enqueue()、execute()此處不往下分析,有興趣的讀者可以看OkHttp的源碼
3.1 同步請(qǐng)求OkHttpCall.execute()
發(fā)送請(qǐng)求過(guò)程
步驟1:對(duì)網(wǎng)絡(luò)請(qǐng)求接口的方法中的每個(gè)參數(shù)利用對(duì)應(yīng)ParameterHandler進(jìn)行解析,再根據(jù)ServiceMethod對(duì)象創(chuàng)建一個(gè)OkHttp的Request對(duì)象
步驟2:使用OkHttp的Request發(fā)送網(wǎng)絡(luò)請(qǐng)求;
步驟3:對(duì)返回的數(shù)據(jù)使用之前設(shè)置的數(shù)據(jù)轉(zhuǎn)換器(GsonConverterFactory)解析返回的數(shù)據(jù),最終得到一個(gè)Response對(duì)象
3.1.2 具體使用
Response response = call.execute();
上面簡(jiǎn)單的一行代碼,其實(shí)包含了整個(gè)發(fā)送網(wǎng)絡(luò)同步請(qǐng)求的三個(gè)步驟。
源碼分析
@Override
public Response<T> execute() throws IOException {
okhttp3.Call call;
// 設(shè)置同步鎖
synchronized (this) {
call = rawCall;
if (call == null) {
try {
call = rawCall = createRawCall();
// 步驟1:創(chuàng)建一個(gè)OkHttp的Request對(duì)象請(qǐng)求 -->關(guān)注1
} catch (IOException | RuntimeException e) {
creationFailure = e;
throw e;
}
}
}
return parseResponse(call.execute());
// 步驟2:調(diào)用OkHttpCall的execute()發(fā)送網(wǎng)絡(luò)請(qǐng)求(同步)
// 步驟3:解析網(wǎng)絡(luò)請(qǐng)求返回的數(shù)據(jù)parseResponse() -->關(guān)注2
}
<-- 關(guān)注1:createRawCall() -->
private okhttp3.Call createRawCall() throws IOException {
Request request = serviceMethod.toRequest(args);
// 從ServiceMethod的toRequest()返回一個(gè)Request對(duì)象
okhttp3.Call call = serviceMethod.callFactory.newCall(request);
// 根據(jù)serviceMethod和request對(duì)象創(chuàng)建 一個(gè)okhttp3.Request
if (call == null) {
throw new NullPointerException("Call.Factory returned null.");
}
return call;
}
<-- 關(guān)注2:parseResponse()-->
Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
ResponseBody rawBody = rawResponse.body();
rawResponse = rawResponse.newBuilder()
.body(new NoContentResponseBody(rawBody.contentType(), rawBody.contentLength()))
.build();
// 收到返回?cái)?shù)據(jù)后進(jìn)行狀態(tài)碼檢查
// 具體關(guān)于狀態(tài)碼說(shuō)明下面會(huì)詳細(xì)介紹
int code = rawResponse.code();
if (code < 200 || code >= 300) {
}
if (code == 204 || code == 205) {
return Response.success(null, rawResponse);
}
ExceptionCatchingRequestBody catchingBody = new ExceptionCatchingRequestBody(rawBody);
try {
T body = serviceMethod.toResponse(catchingBody);
// 等Http請(qǐng)求返回后 & 通過(guò)狀態(tài)碼檢查后,將response body傳入ServiceMethod中,ServiceMethod通過(guò)調(diào)用Converter接口(之前設(shè)置的GsonConverterFactory)將response body轉(zhuǎn)成一個(gè)Java對(duì)象,即解析返回的數(shù)據(jù)
// 生成Response類
return Response.success(body, rawResponse);
} catch (RuntimeException e) {
... // 異常處理
}
}
特別注意:
ServiceMethod幾乎保存了一個(gè)網(wǎng)絡(luò)請(qǐng)求所需要的數(shù)據(jù)
發(fā)送網(wǎng)絡(luò)請(qǐng)求時(shí),OkHttpCall需要從ServiceMethod中獲得一個(gè)Request對(duì)象
解析數(shù)據(jù)時(shí),還需要通過(guò)ServiceMethod使用Converter(數(shù)據(jù)轉(zhuǎn)換器)轉(zhuǎn)換成Java對(duì)象進(jìn)行數(shù)據(jù)解析
為了提高效率,Retrofit還會(huì)對(duì)解析過(guò)的請(qǐng)求ServiceMethod進(jìn)行緩存,存放在Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();對(duì)象中,即第二步提到的單例模式
關(guān)于狀態(tài)碼檢查時(shí)的狀態(tài)碼說(shuō)明:
Paste_Image.png
以上便是整個(gè)以同步的方式發(fā)送網(wǎng)絡(luò)請(qǐng)求的過(guò)程。
異步請(qǐng)求OkHttpCall.enqueue()
發(fā)送請(qǐng)求過(guò)程
步驟1:對(duì)網(wǎng)絡(luò)請(qǐng)求接口的方法中的每個(gè)參數(shù)利用對(duì)應(yīng)ParameterHandler進(jìn)行解析,再根據(jù)ServiceMethod對(duì)象創(chuàng)建一個(gè)OkHttp的Request對(duì)象
步驟2:使用OkHttp的Request發(fā)送網(wǎng)絡(luò)請(qǐng)求;
步驟3:對(duì)返回的數(shù)據(jù)使用之前設(shè)置的數(shù)據(jù)轉(zhuǎn)換器(GsonConverterFactory)解析返回的數(shù)據(jù),最終得到一個(gè)Response對(duì)象
步驟4:進(jìn)行線程切換從而在主線程處理返回的數(shù)據(jù)結(jié)果
若使用了RxJava,則直接回調(diào)到主線程
異步請(qǐng)求的過(guò)程跟同步請(qǐng)求類似,唯一不同之處在于:異步請(qǐng)求會(huì)將回調(diào)方法交給回調(diào)執(zhí)行器在指定的線程中執(zhí)行。
指定的線程此處是指主線程(UI線程)
具體使用
call.enqueue(new Callback<JavaBean>() {
@Override
public void onResponse(Call<JavaBean> call, Response<JavaBean> response) {
System.out.println(response.isSuccessful());
if (response.isSuccessful()) {
response.body().show();
}
else {
try {
System.out.println(response.errorBody().string());
} catch (IOException e) {
e.printStackTrace();
} ;
}
}
從上面分析有:call是一個(gè)靜態(tài)代理
使用靜態(tài)代理的作用是:在okhttpCall發(fā)送網(wǎng)絡(luò)請(qǐng)求的前后進(jìn)行額外操作
這里的額外操作是:線程切換,即將子線程切換到主線程,從而在主線程對(duì)返回的數(shù)據(jù)結(jié)果進(jìn)行處理
源碼分析
<-- call.enqueue()解析 -->
@Override
public void enqueue(final Callback<T> callback) {
delegate.enqueue(new Callback<T>() {
// 使用靜態(tài)代理 delegate進(jìn)行異步請(qǐng)求 ->>分析1
// 等下記得回來(lái)
@Override
public void onResponse(Call<T> call, final Response<T> response) {
// 步驟4:線程切換,從而在主線程顯示結(jié)果
callbackExecutor.execute(new Runnable() {
// 最后Okhttp的異步請(qǐng)求結(jié)果返回到callbackExecutor
// callbackExecutor.execute()通過(guò)Handler異步回調(diào)將結(jié)果傳回到主線程進(jìn)行處理(如顯示在Activity等等),即進(jìn)行了線程切換
// 具體是如何做線程切換 ->>分析2
@Override
public void run() {
if (delegate.isCanceled()) {
callback.onFailure(ExecutorCallbackCall.this, new IOException("Canceled"));
} else {
callback.onResponse(ExecutorCallbackCall.this, response);
}
}
});
}
@Override
public void onFailure(Call<T> call, final Throwable t) {
callbackExecutor.execute(new Runnable() {
@Override public void run() {
callback.onFailure(ExecutorCallbackCall.this, t);
}
});
}
});
}
<-- 分析1:delegate.enqueue()解析 -->
@Override
public void enqueue(final Callback<T> callback) {
okhttp3.Call call;
Throwable failure;
// 步驟1:創(chuàng)建OkHttp的Request對(duì)象,再封裝成OkHttp.call
// delegate代理在網(wǎng)絡(luò)請(qǐng)求前的動(dòng)作:創(chuàng)建OkHttp的Request對(duì)象,再封裝成OkHttp.call
synchronized (this) {
if (executed) throw new IllegalStateException("Already executed.");
executed = true;
call = rawCall;
failure = creationFailure;
if (call == null && failure == null) {
try {
call = rawCall = createRawCall();
// 創(chuàng)建OkHttp的Request對(duì)象,再封裝成OkHttp.call
// 方法同發(fā)送同步請(qǐng)求,此處不作過(guò)多描述
} catch (Throwable t) {
failure = creationFailure = t;
}
}
// 步驟2:發(fā)送網(wǎng)絡(luò)請(qǐng)求
// delegate是OkHttpcall的靜態(tài)代理
// delegate靜態(tài)代理最終還是調(diào)用Okhttp.enqueue進(jìn)行網(wǎng)絡(luò)請(qǐng)求
call.enqueue(new okhttp3.Callback() {
@Override
public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse)
throws IOException {
Response<T> response;
try {
// 步驟3:解析返回?cái)?shù)據(jù)
response = parseResponse(rawResponse);
} catch (Throwable e) {
callFailure(e);
return;
}
callSuccess(response);
}
@Override
public void onFailure(okhttp3.Call call, IOException e) {
try {
callback.onFailure(OkHttpCall.this, e);
} catch (Throwable t) {
t.printStackTrace();
}
}
private void callFailure(Throwable e) {
try {
callback.onFailure(OkHttpCall.this, e);
} catch (Throwable t) {
t.printStackTrace();
}
}
private void callSuccess(Response<T> response) {
try {
callback.onResponse(OkHttpCall.this, response);
} catch (Throwable t) {
t.printStackTrace();
}
}
});
}
// 請(qǐng)回去上面分析1的起點(diǎn)
<-- 分析2:異步請(qǐng)求后的線程切換-->
// 線程切換是通過(guò)一開(kāi)始創(chuàng)建Retrofit對(duì)象時(shí)Platform在檢測(cè)到運(yùn)行環(huán)境是Android時(shí)進(jìn)行創(chuàng)建的:(之前已分析過(guò))
// 采用適配器模式
static class Android extends Platform {
// 創(chuàng)建默認(rèn)的回調(diào)執(zhí)行器工廠
// 如果不將RxJava和Retrofit一起使用,一般都是使用該默認(rèn)的CallAdapter.Factory
// 后面會(huì)對(duì)RxJava和Retrofit一起使用的情況進(jìn)行分析
@Override
CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
return new ExecutorCallAdapterFactory(callbackExecutor);
}
@Override
public Executor defaultCallbackExecutor() {
// 返回一個(gè)默認(rèn)的回調(diào)方法執(zhí)行器
// 該執(zhí)行器負(fù)責(zé)在主線程(UI線程)中執(zhí)行回調(diào)方法
return new MainThreadExecutor();
}
// 獲取主線程Handler
static class MainThreadExecutor implements Executor {
private final Handler handler = new Handler(Looper.getMainLooper());
@Override
public void execute(Runnable r) {
// Retrofit獲取了主線程的handler
// 然后在UI線程執(zhí)行網(wǎng)絡(luò)請(qǐng)求回調(diào)后的數(shù)據(jù)顯示等操作。
handler.post(r);
}
}
// 切換線程的流程:
// 1\. 回調(diào)ExecutorCallAdapterFactory生成了一個(gè)ExecutorCallbackCall對(duì)象
// 2\. 通過(guò)調(diào)用ExecutorCallbackCall.enqueue(CallBack)從而調(diào)用MainThreadExecutor的execute()通過(guò)handler切換到主線程處理返回結(jié)果(如顯示在Activity等等)
}
以上便是整個(gè)以 異步方式發(fā)送網(wǎng)絡(luò)請(qǐng)求的過(guò)程。
總結(jié)
Retrofit 本質(zhì)上是一個(gè) RESTful 的HTTP 網(wǎng)絡(luò)請(qǐng)求框架的封裝,即通過(guò) 大量的設(shè)計(jì)模式 封裝了 OkHttp ,使得簡(jiǎn)潔易用。具體過(guò)程如下:
Retrofit 將 Http請(qǐng)求 抽象 成 Java接口
在接口里用 注解 描述和配置 網(wǎng)絡(luò)請(qǐng)求參數(shù)
用動(dòng)態(tài)代理 的方式,動(dòng)態(tài)將網(wǎng)絡(luò)請(qǐng)求接口的注解 解析 成HTTP請(qǐng)求
最后執(zhí)行HTTP請(qǐng)求