1. 簡介
示意圖
特别注意:
- 準确來說,Retrofit 是一個 RESTful 的 HTTP 網絡請求架構的封裝。
- 原因:網絡請求的工作本質上是
完成,而 Retrofit 僅負責 網絡請求接口的封裝OkHttp
流程圖
- App應用程式通過 Retrofit 請求網絡,實際上是使用 Retrofit 接口層封裝請求參數、Header、Url 等資訊,之後由 OkHttp 完成後續的請求操作
- 在服務端傳回資料之後,OkHttp 将原始的結果交給 Retrofit,Retrofit根據使用者的需求對結果進行解析
2. 與其他網絡請求開源庫對比
除了Retrofit,如今Android中主流的網絡請求架構有:
- Android-Async-Http
- Volley
- OkHttp
下面是簡單介紹:
網絡請求加載 - 介紹
一圖讓你了解全部的網絡請求庫和他們之間的差別!
網絡請求庫 - 對比
附:各個主流網絡請求庫的Github位址
- Android-Async-Http
- Volley
- OkHttp
- Retrofit
3. Retrofit 的具體使用
具體請看我寫的文章:這是一份很詳細的 Retrofit 2.0 使用教程(含執行個體講解)
4. 源碼分析
4.1 Retrofit的本質流程
一般從網絡通信過程如下圖:
網絡請求的過程
- 其實Retrofit的本質和上面是一樣的套路
- 隻是Retrofit通過使用大量的設計模式進行功能子產品的解耦,使得上面的過程進行得更加簡單 & 流暢
如下圖:
Retrofit的本質
具體過程解釋如下:
- 通過解析 網絡請求接口的注解 配置 網絡請求參數
- 通過 動态代理 生成 網絡請求對象
- 通過 網絡請求擴充卡 将 網絡請求對象 進行平台适配
平台包括:Android、Rxjava、Guava和java8
- 通過 網絡請求執行器 發送網絡請求
- 通過 資料轉換器 解析伺服器傳回的資料
- 通過 回調執行器 切換線程(子線程 ->>主線程)
- 使用者在主線程處理傳回結果
下面介紹上面提到的幾個角色
角色說明
特别注意:因下面的 源碼分析 是根據 使用步驟 逐漸帶你debug進去的,是以必須先看文章這是一份很詳細的 Retrofit 2.0 使用教程(含執行個體講解)
4.2 源碼分析
先來回憶Retrofit的使用步驟:
- 建立Retrofit執行個體
- 建立 網絡請求接口執行個體 并 配置網絡請求參數
- 發送網絡請求
封裝了 資料轉換、線程切換的操作
- 處理伺服器傳回的資料
4.2.1 建立Retrofit執行個體
a. 使用步驟
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://fanyi.youdao.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();
b. 源碼分析
Retrofit執行個體是使用建造者模式通過Builder類進行建立的
建造者模式:将一個複雜對象的建構與表示分離,使得使用者在不知道對象的建立細節情況下就可以直接建立複雜的對象。具體請看文章:建造者模式(Builder Pattern)- 最易懂的設計模式解析
接下來,我将分五個步驟對建立Retrofit執行個體進行逐漸分析
分析步驟
步驟1
步驟1
<-- Retrofit類 -->
public final class Retrofit {
private final Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();
// 網絡請求配置對象(對網絡請求接口中方法注解進行解析後得到的對象)
// 作用:存儲網絡請求相關的配置,如網絡請求的方法、資料轉換器、網絡請求擴充卡、網絡請求工廠、基位址等
private final HttpUrl baseUrl;
// 網絡請求的url位址
private final okhttp3.Call.Factory callFactory;
// 網絡請求器的工廠
// 作用:生産網絡請求器(Call)
// Retrofit是預設使用okhttp
private final List<CallAdapter.Factory> adapterFactories;
// 網絡請求擴充卡工廠的集合
// 作用:放置網絡請求擴充卡工廠
// 網絡請求擴充卡工廠作用:生産網絡請求擴充卡(CallAdapter)
// 下面會詳細說明
private final List<Converter.Factory> converterFactories;
// 資料轉換器工廠的集合
// 作用:放置資料轉換器工廠
// 資料轉換器工廠作用:生産資料轉換器(converter)
private final Executor callbackExecutor;
// 回調方法執行器
private final boolean validateEagerly;
// 标志位
// 作用:是否提前對業務接口中的注解進行驗證轉換的标志位
<-- Retrofit類的構造函數 -->
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)
// 作用:建立的新對象能夠對list資料進行通路,但不可通過該對象對list集合中的元素進行修改
this.callbackExecutor = callbackExecutor;
this.validateEagerly = validateEagerly;
...
// 僅貼出關鍵代碼
}
成功建立一個Retrofit對象的标準:配置好Retrofit類裡的成員變量,即配置好:
-
:包含所有網絡請求資訊的對象serviceMethod
-
:網絡請求的url位址baseUrl
-
:網絡請求工廠callFactory
-
:網絡請求擴充卡工廠的集合adapterFactories
-
:資料轉換器工廠的集合converterFactories
-
:回調方法執行器callbackExecutor
所謂
xxxFactory
、“xxx工廠”其實是設計模式中工廠模式的展現:将“類執行個體化的操作”與“使用對象的操作”分開,使得使用者不用知道具體參數就可以執行個體化出所需要的“産品”類。
具體請看我寫的文章
簡單工廠模式(SimpleFactoryPattern)- 最易懂的設計模式解析
工廠方法模式(Factory Method)- 最易懂的設計模式解析
抽象工廠模式(Abstract Factory)- 最易懂的設計模式解析
這裡詳細介紹一下:
CallAdapterFactory
:該
Factory
生産的是
CallAdapter
,那麼
CallAdapter
又是什麼呢?
CallAdapter
詳細介紹
- 定義:網絡請求執行器(Call)的擴充卡
- Call在Retrofit裡預設是
OkHttpCall
- 在Retrofit中提供了四種CallAdapterFactory: ExecutorCallAdapterFactory(預設)、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory
- 作用:将預設的網絡請求執行器(OkHttpCall)轉換成适合被不同平台來調用的網絡請求執行器形式
- 如:一開始
隻打算利用
Retrofit
通過
OkHttpCall
切換線程;但後來發現使用
ExecutorCallbackCall
更加友善(不需要Handler來切換線程)。想要實作
Rxjava
的情況,那就得使用
Rxjava
将
RxJavaCallAdapterFactoryCallAdapter
轉換成
OkHttpCall
:
Rxjava(Scheduler)
// 把response封裝成rxjava的Observeble,然後進行流式操作
Retrofit.Builder.addCallAdapterFactory(newRxJavaCallAdapterFactory().create());
// 關于RxJava的使用這裡不作更多的展開
- Retrofit還支援java8、Guava平台。
- 好處:用最小代價相容更多平台,即能适配更多的使用場景
是以,接下來需要分析的步驟2、步驟3、步驟4、步驟4的目的是配置好上述所有成員變量
步驟2
步驟2
我們先來看Builder類
請按下面提示的步驟進行檢視
<-- Builder類-->
public static final class Builder {
private Platform platform;
private okhttp3.Call.Factory callFactory;
private HttpUrl baseUrl;
private List<Converter.Factory> converterFactories = new ArrayList<>();
private List<CallAdapter.Factory> adapterFactories = new ArrayList<>();
private Executor callbackExecutor;
private boolean validateEagerly;
// 從上面可以發現, Builder類的成員變量與Retrofit類的成員變量是對應的
// 是以Retrofit類的成員變量基本上是通過Builder類進行配置
// 開始看步驟1
<-- 步驟1 -->
// Builder的構造方法(無參)
public Builder() {
this(Platform.get());
// 用this調用自己的有參構造方法public Builder(Platform platform) ->>步驟5(看完步驟2、3、4再看)
// 并通過調用Platform.get()傳入了Platform對象
// 繼續看Platform.get()方法 ->>步驟2
// 記得最後繼續看步驟5的Builder有參構造方法
}
...
}
<-- 步驟2 -->
class Platform {
private static final Platform PLATFORM = findPlatform();
// 将findPlatform()賦給靜态變量
static Platform get() {
return PLATFORM;
// 傳回靜态變量PLATFORM,即findPlatform() ->>步驟3
}
<-- 步驟3 -->
private static Platform findPlatform() {
try {
Class.forName("android.os.Build");
// Class.forName(xxx.xx.xx)的作用:要求JVM查找并加載指定的類(即JVM會執行該類的靜态代碼段)
if (Build.VERSION.SDK_INT != 0) {
return new Android();
// 此處表示:如果是Android平台,就建立并傳回一個Android對象 ->>步驟4
}
} catch (ClassNotFoundException ignored) {
}
try {
// 支援Java平台
Class.forName("java.util.Optional");
return new Java8();
} catch (ClassNotFoundException ignored) {
}
try {
// 支援iOS平台
Class.forName("org.robovm.apple.foundation.NSObject");
return new IOS();
} catch (ClassNotFoundException ignored) {
}
// 從上面看出:Retrofit2.0支援3個平台:Android平台、Java平台、IOS平台
// 最後傳回一個Platform對象(指定了Android平台)給Builder的有參構造方法public Builder(Platform platform) --> 步驟5
// 說明Builder指定了運作平台為Android
return new Platform();
}
...
}
<-- 步驟4 -->
// 用于接收伺服器傳回資料後進行線程切換在主線程顯示結果
static class Android extends Platform {
@Override
CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
return new ExecutorCallAdapterFactory(callbackExecutor);
// 建立預設的網絡請求擴充卡工廠
// 該預設工廠生産的 adapter 會使得Call在異步調用時在指定的 Executor 上執行回調
// 在Retrofit中提供了四種CallAdapterFactory: ExecutorCallAdapterFactory(預設)、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory
// 采用了政策模式
}
@Override
public Executor defaultCallbackExecutor() {
// 傳回一個預設的回調方法執行器
// 該執行器作用:切換線程(子->>主線程),并在主線程(UI線程)中執行回調方法
return new MainThreadExecutor();
}
static class MainThreadExecutor implements Executor {
private final Handler handler = new Handler(Looper.getMainLooper());
// 擷取與Android 主線程綁定的Handler
@Override
public void execute(Runnable r) {
handler.post(r);
// 該Handler是上面擷取的與Android 主線程綁定的Handler
// 在UI線程進行對網絡請求傳回資料處理等操作。
}
}
// 切換線程的流程:
// 1. 回調ExecutorCallAdapterFactory生成了一個ExecutorCallbackCall對象
//2. 通過調用ExecutorCallbackCall.enqueue(CallBack)進而調用MainThreadExecutor的execute()通過handler切換到主線程
}
// 下面繼續看步驟5的Builder有參構造方法
<-- 步驟5 -->
// Builder類的構造函數2(有參)
public Builder(Platform platform) {
// 接收Platform對象(Android平台)
this.platform = platform;
// 通過傳入BuiltInConverters()對象配置資料轉換器工廠(converterFactories)
// converterFactories是一個存放資料轉換器Converter.Factory的數組
// 配置converterFactories即配置裡面的資料轉換器
converterFactories.add(new BuiltInConverters());
// BuiltInConverters是一個内置的資料轉換器工廠(繼承Converter.Factory類)
// new BuiltInConverters()是為了初始化資料轉換器
}
對Builder類分析完畢,總結:Builder設定了預設的
- 平台類型對象:Android
- 網絡請求擴充卡工廠:CallAdapterFactory
CallAdapter用于對原始Call進行再次封裝,如Call<R>到Observable<R>
- 資料轉換器工廠: converterFactory
- 回調執行器:callbackExecutor
特别注意,這裡隻是設定了預設值,但未真正配置到具體的Retrofit類的成員變量當中
步驟3
步驟3
還是按部就班按步驟來觀看
<-- 步驟1 -->
public Builder baseUrl(String baseUrl) {
// 把String類型的url參數轉化為适合OKhttp的HttpUrl類型
HttpUrl httpUrl = HttpUrl.parse(baseUrl);
// 最終傳回帶httpUrl類型參數的baseUrl()
// 下面繼續看baseUrl(httpUrl) ->> 步驟2
return baseUrl(httpUrl);
}
<-- 步驟2 -->
public Builder baseUrl(HttpUrl baseUrl) {
//把URL參數分割成幾個路徑碎片
List<String> pathSegments = baseUrl.pathSegments();
// 檢測最後一個碎片來檢查URL參數是不是以"/"結尾
// 不是就抛出異常
if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
}
this.baseUrl = baseUrl;
return this;
}
- 至此,步驟3分析完畢
- 總結:baseUrl()用于配置Retrofit類的網絡請求url位址
将傳入的String類型url轉化為适合OKhttp的HttpUrl類型的url
步驟4
步驟4
我們從裡往外看,即先看
GsonConverterFactory.creat()
public final class GsonConverterFactory extends Converter.Factory {
<-- 步驟1 -->
public static GsonConverterFactory create() {
// 建立一個Gson對象
return create(new Gson()); ->>步驟2
}
<-- 步驟2 -->
public static GsonConverterFactory create(Gson gson) {
// 建立了一個含有Gson對象執行個體的GsonConverterFactory
return new GsonConverterFactory(gson); ->>步驟3
}
private final Gson gson;
<-- 步驟3 -->
private GsonConverterFactory(Gson gson) {
if (gson == null) throw new NullPointerException("gson == null");
this.gson = gson;
}
- 是以,GsonConverterFactory.creat()是建立了一個含有Gson對象執行個體的GsonConverterFactory,并傳回給
addConverterFactory()
- 接下來繼續看:
addConverterFactory()
// 将上面建立的GsonConverterFactory放入到 converterFactories數組
// 在第二步放入一個内置的資料轉換器工廠BuiltInConverters()後又放入了一個GsonConverterFactory
public Builder addConverterFactory(Converter.Factory factory) {
converterFactories.add(checkNotNull(factory, "factory == null"));
return this;
}
- 至此,分析完畢
- 總結:步驟4用于建立一個含有Gson對象執行個體的GsonConverterFactory并放入到資料轉換器工廠converterFactories裡
- 即Retrofit預設使用Gson進行解析
- 若使用其他解析方式(如Json、XML或Protocobuf),也可通過自定義資料解析器來實作(必須繼承 Converter.Factory)
步驟5
步驟5
終于到了最後一個步驟了。
public Retrofit build() {
<-- 配置網絡請求執行器(callFactory)-->
okhttp3.Call.Factory callFactory = this.callFactory;
// 如果沒指定,則預設使用okhttp
// 是以Retrofit預設使用okhttp進行網絡請求
if (callFactory == null) {
callFactory = new OkHttpClient();
}
<-- 配置回調方法執行器(callbackExecutor)-->
Executor callbackExecutor = this.callbackExecutor;
// 如果沒指定,則預設使用Platform檢測環境時的預設callbackExecutor
// 即Android預設的callbackExecutor
if (callbackExecutor == null) {
callbackExecutor = platform.defaultCallbackExecutor();
}
<-- 配置網絡請求擴充卡工廠(CallAdapterFactory)-->
List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
// 向該集合中添加了步驟2中建立的CallAdapter.Factory請求擴充卡(添加在集合器末尾)
adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
// 請求擴充卡工廠集合存儲順序:自定義1擴充卡工廠、自定義2擴充卡工廠...預設擴充卡工廠(ExecutorCallAdapterFactory)
<-- 配置資料轉換器工廠:converterFactory -->
// 在步驟2中已經添加了内置的資料轉換器BuiltInConverters()(添加到集合器的首位)
// 在步驟4中又插入了一個Gson的轉換器 - GsonConverterFactory(添加到集合器的首二位)
List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);
// 資料轉換器工廠集合存儲的是:預設資料轉換器工廠( BuiltInConverters)、自定義1資料轉換器工廠(GsonConverterFactory)、自定義2資料轉換器工廠....
// 注:
//1. 擷取合适的網絡請求擴充卡和資料轉換器都是從adapterFactories和converterFactories集合的首位-末位開始周遊
// 是以集合中的工廠位置越靠前就擁有越高的使用權限
// 最終傳回一個Retrofit的對象,并傳入上述已經配置好的成員變量
return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
callbackExecutor, validateEagerly);
}
- 至此,步驟5分析完畢
- 總結:在最後一步中,通過前面步驟設定的變量,将Retrofit類的所有成員變量都配置完畢。
- 是以,成功建立了Retrofit的執行個體
總結
Retrofit使用建造者模式通過Builder類建立了一個Retrofit執行個體,具體建立細節是配置了:
- 平台類型對象(Platform - Android)
- 網絡請求的url位址(baseUrl)
- 網絡請求工廠(callFactory)
預設使用OkHttpCall
- 網絡請求擴充卡工廠的集合(adapterFactories)
本質是配置了網絡請求擴充卡工廠- 預設是ExecutorCallAdapterFactory
- 資料轉換器工廠的集合(converterFactories)
本質是配置了資料轉換器工廠
- 回調方法執行器(callbackExecutor)
預設回調方法執行器作用是:切換線程(子線程 - 主線程)
由于使用了建造者模式,是以開發者并不需要關心配置細節就可以建立好Retrofit執行個體,建造者模式get。
在建立Retrofit對象時,你可以通過更多更靈活的方式去處理你的需求,如使用不同的Converter、使用不同的CallAdapter,這也就提供了你使用RxJava來調用Retrofit的可能
2. 建立網絡請求接口的執行個體
2.1 使用步驟
<-- 步驟1:定義接收網絡資料的類 -->
<-- JavaBean.java -->
public class JavaBean {
.. // 這裡就不介紹了
}
<-- 步驟2:定義網絡請求的接口類 -->
<-- AccessApi.java -->
public interface AccessApi {
// 注解GET:采用Get方法發送網絡請求
// Retrofit把網絡請求的URL分成了2部分:1部分baseurl放在建立Retrofit對象時設定;另一部分在網絡請求接口設定(即這裡)
// 如果接口裡的URL是一個完整的網址,那麼放在建立Retrofit對象時設定的部分可以不設定
@GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
// 接受網絡請求資料的方法
Call<JavaBean> getCall();
// 傳回類型為Call<*>,*是解析得到的資料類型,即JavaBean
}
<-- 步驟3:在MainActivity建立接口類執行個體 -->
AccessApi NetService = retrofit.create(AccessApi.class);
<-- 步驟4:對發送請求的url進行封裝,即生成最終的網絡請求對象 -->
Call<JavaBean> call = NetService.getCall();
2.2 源碼分析
- 結論:Retrofit是通過外觀模式 & 代理模式 使用create()方法建立網絡請求接口的執行個體(同時,通過網絡請求接口裡設定的注解進行了網絡請求參數的配置)
- 外觀模式:定義一個統一接口,外部與通過該統一的接口對子系統裡的其他接口進行通路。具體請看:外觀模式(Facade Pattern) - 最易懂的設計模式解析
- 代理模式:通過通路代理對象的方式來間接通路目标對象。具體請看:代理模式(Proxy Pattern)- 最易懂的設計模式解析
- 下面主要分析步驟3和步驟4:
<-- 步驟3:在MainActivity建立接口類執行個體 -->
AccessApi NetService = retrofit.create(NetService.class);
<-- 步驟4:對發送請求的url進行封裝,即生成最終的網絡請求對象 -->
Call<JavaBean> call = NetService.getCall();
步驟3講解: AccessApi NetService = retrofit.create(NetService.class);
AccessApi NetService = retrofit.create(NetService.class);
public <T> T create(final Class<T> service) {
if (validateEagerly) {
// 判斷是否需要提前驗證
eagerlyValidateMethods(service);
// 具體方法作用:
// 1. 給接口中每個方法的注解進行解析并得到一個ServiceMethod對象
// 2. 以Method為鍵将該對象存入LinkedHashMap集合中
// 特别注意:如果不是提前驗證則進行動态解析對應方法(下面會詳細說明),得到一個ServiceMethod對象,最後存入到LinkedHashMap集合中,類似延遲加載(預設)
}
// 建立了網絡請求接口的動态代理對象,即通過動态代理建立網絡請求接口的執行個體 (并最終傳回)
// 該動态代理是為了拿到網絡請求接口執行個體上所有注解
return (T) Proxy.newProxyInstance(
service.getClassLoader(), // 動态生成接口的實作類
new Class<?>[] { service }, // 動态建立執行個體
new InvocationHandler() { // 将代理類的實作交給 InvocationHandler類作為具體的實作(下面會解釋)
private final Platform platform = Platform.get();
// 在 InvocationHandler類的invoke()實作中,除了執行真正的邏輯(如再次轉發給真正的實作類對象),還可以進行一些有用的操作
// 如統計執行時間、進行初始化和清理、對接口調用進行檢查等。
@Override
public Object invoke(Object proxy, Method method, Object... args)
throws Throwable {
// 下面會詳細介紹 invoke()的實作
// 即下面三行代碼
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);
// 即通過動态生成的代理類,調用interfaces接口的方法實際上是通過調用InvocationHandler對象的invoke()來完成指定的功能
// 先記住結論,在講解步驟4的時候會再次詳細說明
<-- 關注點1:eagerlyValidateMethods() -->
private void eagerlyValidateMethods(Class<?> service) {
Platform platform = Platform.get();
for (Method method : service.getDeclaredMethods()) {
if (!platform.isDefaultMethod(method)) { loadServiceMethod(method); }
// 将傳入的ServiceMethod對象加入LinkedHashMap<Method, ServiceMethod>集合
// 使用LinkedHashMap集合的好處:lruEntries.values().iterator().next()擷取到的是集合最不經常用到的元素,提供了一種Lru算法的實作
}
}
建立網絡接口執行個體用了外觀模式 & 代理模式:
使用外觀模式進行通路,裡面用了代理模式
1. 外觀模式
- 外觀模式:定義一個統一接口,外部與通過該統一的接口對子系統裡的其他接口進行通路。具體請看:外觀模式(Facade Pattern) - 最易懂的設計模式解析
- Retrofit對象的外觀(門店) =
retrofit.create()
- 通過這一外觀方法就可以在内部調用各個方法建立網絡請求接口的執行個體和配置網絡請求參數
大大降低了系統的耦合度
2. 代理模式
- 代理模式:通過通路代理對象的方式來間接通路目标對象
分為靜态代理 & 動态代理:
- 靜态代理:代理類在程式運作前已經存在的代理方式
動态代理:代理類在程式運作前不存在、運作時由程式動态生成的代理方式
具體請看文章代理模式(Proxy Pattern)- 最易懂的設計模式解析
-
通過代理模式中的動态代理模式,動态生成網絡請求接口的代理類,并将代理類的執行個體建立交給return (T) roxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler invocationHandler)
作為具體的實作,并最終傳回一個動态代理對象。InvocationHandler類
生成執行個體過程中含有生成實作類的緩存機制(單例模式),下面會詳細分析
使用動态代理的好處:
- 當
對象調用NetService
接口中方法時會進行攔截,調用都會集中轉發到 InvocationHandler#invoke (),可集中進行處理getCall()
- 獲得網絡請求接口執行個體上的所有注解
- 更友善封裝ServiceMethod
下面看源碼分析
下面将詳細分析
InvocationHandler類 # invoke()
裡的具體實作
new InvocationHandler() {
private final Platform platform = Platform.get();
@Override
public Object invoke(Object proxy, Method method, Object... args)
throws Throwable {
// 将詳細介紹下面代碼
// 關注點1
// 作用:讀取網絡請求接口裡的方法,并根據前面配置好的屬性配置serviceMethod對象
ServiceMethod serviceMethod = loadServiceMethod(method);
// 關注點2
// 作用:根據配置好的serviceMethod對象建立okHttpCall對象
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
// 關注點3
// 作用:調用OkHttp,并根據okHttpCall傳回rejava的Observe對象或者傳回Call
return serviceMethod.callAdapter.adapt(okHttpCall);
}
下面将詳細介紹3個關注點的代碼。
關注點1: ServiceMethod serviceMethod = loadServiceMethod(method);
ServiceMethod serviceMethod = loadServiceMethod(method);
<-- loadServiceMethod(method)方法講解 -->
// 一個 ServiceMethod 對象對應于網絡請求接口裡的一個方法
// loadServiceMethod(method)負責加載 ServiceMethod:
ServiceMethod loadServiceMethod(Method method) {
ServiceMethod result;
// 設定線程同步鎖
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
// ServiceMethod類對象采用了單例模式進行建立
// 即建立ServiceMethod對象前,先看serviceMethodCache有沒有緩存之前建立過的網絡請求執行個體
// 若沒緩存,則通過建造者模式建立 serviceMethod 對象
if (result == null) {
// 下面會詳細介紹ServiceMethod生成執行個體的過程
result = new ServiceMethod.Builder(this, method).build();
serviceMethodCache.put(method, result);
}
}
return result;
}
// 這裡就是上面說的建立執行個體的緩存機制:采用單例模式進而實作一個 ServiceMethod 對象對應于網絡請求接口裡的一個方法
// 注:由于每次擷取接口執行個體都是傳入 class 對象
// 而 class 對象在程序内單例的,是以擷取到它的同一個方法 Method 執行個體也是單例的,是以這裡的緩存是有效的。
下面,我将分3個步驟詳細分析
serviceMethod
執行個體的建立過程:
Paste_Image.png
步驟1: ServiceMethod類
構造函數
ServiceMethod類
Paste_Image.png
<-- ServiceMethod 類 -->
public final class ServiceMethod {
final okhttp3.Call.Factory callFactory; // 網絡請求工廠
final CallAdapter<?> callAdapter;
// 網絡請求擴充卡工廠
// 具體建立是在new ServiceMethod.Builder(this, method).build()最後的build()中
// 下面會詳細說明
private final Converter<ResponseBody, T> responseConverter;
// Response内容轉換器
// 作用:負責把伺服器傳回的資料(JSON或者其他格式,由 ResponseBody 封裝)轉化為 T 類型的對象;
private final HttpUrl baseUrl; // 網絡請求位址
private final String relativeUrl; // 網絡請求的相對位址
private final String httpMethod; // 網絡請求的Http方法
private final Headers headers; // 網絡請求的http請求頭 鍵值對
private final MediaType contentType; // 網絡請求的http封包body的類型
private final ParameterHandler<?>[] parameterHandlers;
// 方法參數處理器
// 作用:負責解析 API 定義時每個方法的參數,并在構造 HTTP 請求時設定參數;
// 下面會詳細說明
// 說明:從上面的成員變量可以看出,ServiceMethod對象包含了通路網絡的所有基本資訊
<-- ServiceMethod 類的構造函數 -->
// 作用:傳入各種網絡請求參數
ServiceMethod(Builder<T> 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()
ServiceMethod的Builder()
Paste_Image.png
public Builder(Retrofit retrofit, Method method) {
this.retrofit = retrofit;
this.method = method;
// 擷取網絡請求接口方法裡的注釋
this.methodAnnotations = method.getAnnotations();
// 擷取網絡請求接口方法裡的參數類型
this.parameterTypes = method.getGenericParameterTypes();
//擷取網絡請求接口方法裡的注解内容
this.parameterAnnotationsArray = method.getParameterAnnotations();
}
步驟3: ServiceMethod的build()
ServiceMethod的build()
Paste_Image.png
// 作用:控制ServiceMethod對象的生成流程
public ServiceMethod build() {
callAdapter = createCallAdapter();
// 根據網絡請求接口方法的傳回值和注解類型,從Retrofit對象中擷取對應的網絡請求擴充卡 -->關注點1
responseType = callAdapter.responseType();
// 根據網絡請求接口方法的傳回值和注解類型,從Retrofit對象中擷取該網絡擴充卡傳回的資料類型
responseConverter = createResponseConverter();
// 根據網絡請求接口方法的傳回值和注解類型,從Retrofit對象中擷取對應的資料轉換器 -->關注點3
// 構造 HTTP 請求時,我們傳遞的參數都是String
// Retrofit 類提供 converter把傳遞的參數都轉化為 String
// 其餘類型的參數都利用 Converter.Factory 的stringConverter 進行轉換
// @Body 和 @Part 類型的參數利用Converter.Factory 提供的 requestBodyConverter 進行轉換
// 這三種 converter 都是通過“詢問”工廠清單進行提供,而工廠清單我們可以在構造 Retrofit 對象時進行添加。
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
// 解析網絡請求接口中方法的注解
// 主要是解析擷取Http請求的方法
// 注解包括:DELETE、GET、POST、HEAD、PATCH、PUT、OPTIONS、HTTP、retrofit2.http.Headers、Multipart、FormUrlEncoded
// 處理主要是調用方法 parseHttpMethodAndPath(String httpMethod, String value, boolean hasBody) ServiceMethod中的httpMethod、hasBody、relativeUrl、relativeUrlParamNames域進行指派
int parameterCount = parameterAnnotationsArray.length;
// 擷取目前方法的參數數量
parameterHandlers = new ParameterHandler<?>[parameterCount];
for (int p = 0; p < parameterCount; p++) {
Type parameterType = parameterTypes[p];
Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
// 為方法中的每個參數建立一個ParameterHandler<?>對象并解析每個參數使用的注解類型
// 該對象的建立過程就是對方法參數中注解進行解析
// 這裡的注解包括:Body、PartMap、Part、FieldMap、Field、Header、QueryMap、Query、Path、Url
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
}
return new ServiceMethod<>(this);
<-- 總結 -->
// 1. 根據傳回值類型和方法标注從Retrofit對象的的網絡請求擴充卡工廠集合和内容轉換器工廠集合中分别擷取到該方法對應的網絡請求擴充卡和Response内容轉換器;
// 2. 根據方法的标注對ServiceMethod的域進行指派
// 3. 最後為每個方法的參數的标注進行解析,獲得一個ParameterHandler<?>對象
// 該對象儲存有一個Request内容轉換器——根據參數的類型從Retrofit的内容轉換器工廠集合中擷取一個Request内容轉換器或者一個String内容轉換器。
}
<-- 關注點1:createCallAdapter() -->
private CallAdapter<?> createCallAdapter() {
// 擷取網絡請求接口裡方法的傳回值類型
Type returnType = method.getGenericReturnType();
// 擷取網絡請求接口接口裡的注解
// 此處使用的是@Get
Annotation[] annotations = method.getAnnotations();
try {
return retrofit.callAdapter(returnType, annotations);
// 根據網絡請求接口方法的傳回值和注解類型,從Retrofit對象中擷取對應的網絡請求擴充卡
// 下面會詳細說明retrofit.callAdapter() -- >關注點2
}
...
<-- 關注點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) {
// 建立 CallAdapter 如下
// 周遊 CallAdapter.Factory 集合尋找合适的工廠(該工廠集合在第一步構造 Retrofit 對象時進行添加(第一步時已經說明))
// 如果最終沒有工廠提供需要的 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;
}
}
<-- 關注點3:createResponseConverter() -->
private Converter<ResponseBody, T> createResponseConverter() {
Annotation[] annotations = method.getAnnotations();
try {
// responseConverter 還是由 Retrofit 類提供 -->關注點4
return retrofit.responseBodyConverter(responseType, annotations);
} catch (RuntimeException e) {
throw methodError(e, "Unable to create converter for %s", responseType);
}
}
<-- 關注點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 過程:(和擷取 callAdapter 基本一緻)
Converter<ResponseBody, ?> converter =
converterFactories.get(i).responseBodyConverter(type, annotations, this);
// 周遊 Converter.Factory 集合并尋找合适的工廠(該工廠集合在構造 Retrofit 對象時進行添加(第一步時已經說明))
// 由于構造Retroifit采用的是Gson解析方式,是以取出的是GsonResponseBodyConverter
// Retrofit - Converters 還提供了 JSON,XML,ProtoBuf 等類型資料的轉換功能。
// 繼續看responseBodyConverter() -->關注點5
}
<-- 關注點5:responseBodyConverter() -->
@Override
public Converter<ResponseBody, ?> responseBodyConverter(Type type,
Annotation[] annotations, Retrofit retrofit) {
TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
// 根據目标類型,利用 Gson#getAdapter 擷取相應的 adapter
return new GsonResponseBodyConverter<>(gson, adapter);
}
// 做資料轉換時調用 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();
}
}
}
- 當選擇了RxjavaCallAdapterFactory後,Rxjava通過政策模式選擇對應的adapter
關于政策模式的講解,請看文章政策模式(Strategy Pattern)- 最易懂的設計模式解析
- 具體過程是:根據網絡接口方法的傳回值類型來選擇具體要用哪種CallAdapterFactory,然後建立具體的CallAdapter執行個體
采用工廠模式使得各功能子產品高度解耦
- 上面提到了兩種工廠:CallAdapter.Factory & Converter.Factory分别負責提供不同的功能子產品
- 工廠負責如何提供、提供何種功能子產品
- Retrofit 隻負責提供選擇何種工廠的決策資訊(如網絡接口方法的參數、傳回值類型、注解等)
這正是所謂的高内聚低耦合,工廠模式get。
關于工廠模式請看我寫的文章:
簡單工廠模式(SimpleFactoryPattern)- 最易懂的設計模式解析
工廠方法模式(Factory Method)- 最易懂的設計模式解析
抽象工廠模式(Abstract Factory)- 最易懂的設計模式解析
終于配置完網絡請求參數(即配置好
ServiceMethod
對象)。接下來将講解第二行代碼:
okHttpCall對象
的建立
第二行: OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
根據第一步配置好的
ServiceMethod
對象和輸入的請求參數建立
okHttpCall
對象
<--OkHttpCall類 -->
public class OkHttpCall {
private final ServiceMethod<T> serviceMethod; // 含有所有網絡請求參數資訊的對象
private final Object[] args; // 網絡請求接口的參數
private okhttp3.Call rawCall; //實際進行網絡通路的類
private Throwable creationFailure; //幾個狀态标志位
private boolean executed;
private volatile boolean canceled;
<--OkHttpCall構造函數 -->
public OkHttpCall(ServiceMethod<T> serviceMethod, Object[] args) {
// 傳入了配置好的ServiceMethod對象和輸入的請求參數
this.serviceMethod = serviceMethod;
this.args = args;
}
第三行: return serviceMethod.callAdapter.adapt(okHttpCall);
return serviceMethod.callAdapter.adapt(okHttpCall);
将第二步建立的
OkHttpCall
對象傳給第一步建立的
serviceMethod
對象中對應的網絡請求擴充卡工廠的
adapt()
傳回對象類型:Android預設的是;若設定了RxJavaCallAdapterFactory,傳回的則是
Call<>
Observable<>
<-- adapt()詳解-->
public <R> Call<R> adapt(Call<R> call) {
return new ExecutorCallbackCall<>(callbackExecutor, call);
}
ExecutorCallbackCall(Executor callbackExecutor, Call<T> delegate) {
this.delegate = delegate;
// 把上面建立并配置好參數的OkhttpCall對象交給靜态代理delegate
// 靜态代理和動态代理都屬于代理模式
// 靜态代理作用:代理執行被代理者的方法,且可在要執行的方法前後加入自己的動作,進行對系統功能的拓展
this.callbackExecutor = callbackExecutor;
// 傳入上面定義的回調方法執行器
// 用于進行線程切換
}
- 采用了裝飾模式:ExecutorCallbackCall = 裝飾者,而裡面真正去執行網絡請求的還是OkHttpCall
- 使用裝飾模式的原因:希望在OkHttpCall發送請求時做一些額外操作。這裡的額外操作是線程轉換,即将子線程切換到主線程
- OkHttpCall的enqueue()是進行網絡異步請求的:當你調用OkHttpCall.enqueue()時,回調的callback是在子線程中,需要通過Handler轉換到主線程進行回調。ExecutorCallbackCall就是用于線程回調;
- 當然以上是原生Retrofit使用的切換線程方式。如果你用Rxjava,那就不會用到這個ExecutorCallbackCall而是RxJava的Call,此處不過多展開
步驟4講解: Call<JavaBean> call = NetService.getCall();
Call<JavaBean> call = NetService.getCall();
-
對象實際上是動态代理對象NetService
(步驟3中已說明),并不是真正的網絡請求接口建立的對象Proxy.newProxyInstance()
- 當
對象調用NetService
時會被動态代理對象getCall()
攔截,然後調用自身的Proxy.newProxyInstance()
InvocationHandler # invoke()
-
會傳入3個參數:invoke(Object proxy, Method method, Object... args)
(代理對象)、Object proxy:
(調用的Method method
)getCall()
(方法的參數,即Object... args
中的*)getCall(*)
- 接下來利用Java反射擷取到
的注解資訊,配合args參數建立getCall()
。ServiceMethod對象
如上面步驟3描述,此處不再次講解
最終建立并傳回一個
OkHttpCall
類型的Call對象
類是
OkHttpCall
的包裝類
OkHttp
- 建立了
類型的Call對象還不能發送網絡請求,需要建立
OkHttpCall
對象才能發送網絡請求
Request
總結
Retrofit采用了外觀模式統一調用建立網絡請求接口執行個體和網絡請求參數配置的方法,具體細節是:
- 動态建立網絡請求接口的執行個體(代理模式 - 動态代理)
- 建立
對象(建造者模式 & 單例模式(緩存機制))serviceMethod
- 對
對象進行網絡請求參數配置:通過解析網絡請求接口方法的參數、傳回值和注解類型,從Retrofit對象中擷取對應的網絡請求的url位址、網絡請求執行器、網絡請求擴充卡 & 資料轉換器。(政策模式)serviceMethod
- 對
對象加入線程切換的操作,便于接收資料後通過Handler從子線程切換到主線程進而對傳回資料結果進行處理(裝飾模式)serviceMethod
- 最終建立并傳回一個
類型的網絡請求對象OkHttpCall
3. 執行網絡請求
-
預設使用Retrofit
,即OkHttp
(實作了OkHttpCall類
接口)retrofit2.Call<T>
但可以自定義選擇自己需要的Call類
-
提供了兩種網絡請求方式:OkHttpCall
- 同步請求:
OkHttpCall.execute()
- 異步請求:
OkHttpCall.enqueue()
- 同步請求:
下面将詳細介紹這兩種網絡請求方式。
對于OkHttpCall的enqueue()、execute()此處不往下分析,有興趣的讀者可以看OkHttp的源碼
3.1 同步請求 OkHttpCall.execute()
OkHttpCall.execute()
3.1.1 發送請求過程
- 步驟1:對網絡請求接口的方法中的每個參數利用對應
進行解析,再根據ParameterHandler
對象建立一個ServiceMethod
的OkHttp
對象Request
- 步驟2:使用
的OkHttp
發送網絡請求;Request
- 步驟3:對傳回的資料使用之前設定的資料轉換器(GsonConverterFactory)解析傳回的資料,最終得到一個
對象Response<T>
3.1.2 具體使用
Response<JavaBean> response = call.execute();
上面簡單的一行代碼,其實包含了整個發送網絡同步請求的三個步驟。
3.1.3 源碼分析
@Override
public Response<T> execute() throws IOException {
okhttp3.Call call;
// 設定同步鎖
synchronized (this) {
call = rawCall;
if (call == null) {
try {
call = rawCall = createRawCall();
// 步驟1:建立一個OkHttp的Request對象請求 -->關注1
} catch (IOException | RuntimeException e) {
creationFailure = e;
throw e;
}
}
}
return parseResponse(call.execute());
// 步驟2:調用OkHttpCall的execute()發送網絡請求(同步)
// 步驟3:解析網絡請求傳回的資料parseResponse() -->關注2
}
<-- 關注1:createRawCall() -->
private okhttp3.Call createRawCall() throws IOException {
Request request = serviceMethod.toRequest(args);
// 從ServiceMethod的toRequest()傳回一個Request對象
okhttp3.Call call = serviceMethod.callFactory.newCall(request);
// 根據serviceMethod和request對象建立 一個okhttp3.Request
if (call == null) {
throw new NullPointerException("Call.Factory returned null.");
}
return call;
}
<-- 關注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();
// 收到傳回資料後進行狀态碼檢查
// 具體關于狀态碼說明下面會詳細介紹
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請求傳回後 & 通過狀态碼檢查後,将response body傳入ServiceMethod中,ServiceMethod通過調用Converter接口(之前設定的GsonConverterFactory)将response body轉成一個Java對象,即解析傳回的資料
// 生成Response類
return Response.success(body, rawResponse);
} catch (RuntimeException e) {
... // 異常處理
}
}
特别注意:
-
幾乎儲存了一個網絡請求所需要的資料ServiceMethod
- 發送網絡請求時,
需要從OkHttpCall
中獲得一個Request對象ServiceMethod
- 解析資料時,還需要通過
使用ServiceMethod
(資料轉換器)轉換成Java對象進行資料解析Converter
為了提高效率,Retrofit還會對解析過的請求進行緩存,存放在
ServiceMethod
對象中,即第二步提到的單例模式
Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();
- 關于狀态碼檢查時的狀态碼說明:
Paste_Image.png
以上便是整個以同步的方式發送網絡請求的過程。
3.2 異步請求 OkHttpCall.enqueue()
OkHttpCall.enqueue()
3.2.1 發送請求過程
- 步驟1:對網絡請求接口的方法中的每個參數利用對應
進行解析,再根據ParameterHandler
對象建立一個ServiceMethod
的OkHttp
對象Request
- 步驟2:使用
的OkHttp
發送網絡請求;Request
- 步驟3:對傳回的資料使用之前設定的資料轉換器(GsonConverterFactory)解析傳回的資料,最終得到一個
對象Response<T>
- 步驟4:進行線程切換進而在主線程處理傳回的資料結果
若使用了RxJava,則直接回調到主線程
異步請求的過程跟同步請求類似,唯一不同之處在于:異步請求會将回調方法交給回調執行器在指定的線程中執行。
指定的線程此處是指主線程(UI線程)
3.2.2 具體使用
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
- 使用靜态代理的作用是:在okhttpCall發送網絡請求的前後進行額外操作
這裡的額外操作是:線程切換,即将子線程切換到主線程,進而在主線程對傳回的資料結果進行處理
3.2.3 源碼分析
<-- call.enqueue()解析 -->
@Override
public void enqueue(final Callback<T> callback) {
delegate.enqueue(new Callback<T>() {
// 使用靜态代理 delegate進行異步請求 ->>分析1
// 等下記得回來
@Override
public void onResponse(Call<T> call, final Response<T> response) {
// 步驟4:線程切換,進而在主線程顯示結果
callbackExecutor.execute(new Runnable() {
// 最後Okhttp的異步請求結果傳回到callbackExecutor
// callbackExecutor.execute()通過Handler異步回調将結果傳回到主線程進行處理(如顯示在Activity等等),即進行了線程切換
// 具體是如何做線程切換 ->>分析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:建立OkHttp的Request對象,再封裝成OkHttp.call
// delegate代理在網絡請求前的動作:建立OkHttp的Request對象,再封裝成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();
// 建立OkHttp的Request對象,再封裝成OkHttp.call
// 方法同發送同步請求,此處不作過多描述
} catch (Throwable t) {
failure = creationFailure = t;
}
}
// 步驟2:發送網絡請求
// delegate是OkHttpcall的靜态代理
// delegate靜态代理最終還是調用Okhttp.enqueue進行網絡請求
call.enqueue(new okhttp3.Callback() {
@Override
public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse)
throws IOException {
Response<T> response;
try {
// 步驟3:解析傳回資料
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();
}
}
});
}
// 請回去上面分析1的起點
<-- 分析2:異步請求後的線程切換-->
// 線程切換是通過一開始建立Retrofit對象時Platform在檢測到運作環境是Android時進行建立的:(之前已分析過)
// 采用擴充卡模式
static class Android extends Platform {
// 建立預設的回調執行器工廠
// 如果不将RxJava和Retrofit一起使用,一般都是使用該預設的CallAdapter.Factory
// 後面會對RxJava和Retrofit一起使用的情況進行分析
@Override
CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
return new ExecutorCallAdapterFactory(callbackExecutor);
}
@Override
public Executor defaultCallbackExecutor() {
// 傳回一個預設的回調方法執行器
// 該執行器負責在主線程(UI線程)中執行回調方法
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線程執行網絡請求回調後的資料顯示等操作。
handler.post(r);
}
}
// 切換線程的流程:
// 1. 回調ExecutorCallAdapterFactory生成了一個ExecutorCallbackCall對象
// 2. 通過調用ExecutorCallbackCall.enqueue(CallBack)進而調用MainThreadExecutor的execute()通過handler切換到主線程處理傳回結果(如顯示在Activity等等)
}
以上便是整個以異步方式發送網絡請求的過程。
5. 總結
Retrofit
本質上是一個
RESTful
的
HTTP
網絡請求架構的封裝,即通過 大量的設計模式 封裝了
OkHttp
,使得簡潔易用。具體過程如下:
-
将Retrofit
請求 抽象 成Http
接口Java
- 在接口裡用 注解 描述和配置 網絡請求參數
- 用動态代理 的方式,動态将網絡請求接口的注解 解析 成
請求HTTP
- 最後執行
請求HTTP
最後貼一張非常詳細的
Retrofit
源碼分析圖:
Retrofit源碼分析圖
作者:Carson_Ho
連結:https://www.jianshu.com/p/0c055ad46b6c
來源:簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權,非商業轉載請注明出處。
本文轉載自:https://www.jianshu.com/p/0c055ad46b6c