Retrofit 源碼流程分析

今天我們主要聊一聊 Retrofit 的源碼窘哈,他是怎樣對 OkHttp 包裝的脆贵。

此次分析源碼的版本 Retrofit 2.5.0

首先我們先了解一下 Retrofit 用法牍汹。

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://api.github.com/")
        .build();
         
GitHubService service = retrofit.create(GitHubService.class);

Call<List<Repo>> call = service.listRepos("octocat");

//發(fā)送網(wǎng)絡請求(異步)
call.enqueue(new Callback<List<Repo>>() {
    @Override
    public void onResponse(Call<List<Repo>> call, Response<List<Repo>> response) {

    }

    @Override
    public void onFailure(Call<List<Repo>> call, Throwable t) {

    }
});

// 發(fā)送網(wǎng)絡請求(同步)
Response<List<Repo>> response = call.execute();

Retrofit 的 Builder 建造者模式

首先我們看到 Retrofit 的 Builder 建造者模式西疤,

public Retrofit build() {
    // 配置 baseUrl
    if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
    }
    
    // 配置 OkHttpClient
    okhttp3.Call.Factory callFactory = this.callFactory;
    if (callFactory == null) {
        callFactory = new OkHttpClient();
    }

    // 執(zhí)行 callback 的線程
    Executor callbackExecutor = this.callbackExecutor;
    if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
    }

    // Call 適配器,比如 RxJava、Java8 適配器
    List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
    callAdapterFactories.addAll(platform.defaultCallAdapterFactories(callbackExecutor));

    // 數(shù)據(jù)轉(zhuǎn)換器,比如 Gson、Jackson 等轉(zhuǎn)換器
    List<Converter.Factory> converterFactories = new ArrayList<>(
      1 + this.converterFactories.size() + platform.defaultConverterFactoriesSize());
        converterFactories.add(new BuiltInConverters());
        converterFactories.addAll(this.converterFactories);
        converterFactories.addAll(platform.defaultConverterFactories());

        return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
          unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
    }
}

根據(jù)接口方法獲取 Service

接下來我們再往下看 retrofit.create() 方法

public <T> T create(final Class<T> service) {
    ...
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();
          private final Object[] emptyArgs = new Object[0];

          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
              throws Throwable {
            // 處理默認方法
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            // 處理接口方法
            return loadServiceMethod(method).invoke(args != null ? args : emptyArgs);
          }
        });
    }

create() 本身就是一個動態(tài)代理醋界。

調(diào)用 Service 的方法就會走動態(tài)代理

先看 loadServiceMethod() 方法,等會再看 invoke();

ServiceMethod<?> loadServiceMethod(Method method) {
    // 查詢方法緩存
    ServiceMethod<?> result = serviceMethodCache.get(method);
    if (result != null) return result;
    
    synchronized (serviceMethodCache) {
      result = serviceMethodCache.get(method);
      if (result == null) {
        // 解析方法的注解以及返回類型確定各項參數(shù)以及 Call 適配器提完、數(shù)據(jù)轉(zhuǎn)換器形纺。
        result = ServiceMethod.parseAnnotations(this, method);
        serviceMethodCache.put(method, result);
      }
    }
    return result;
}

繼續(xù)往下看 ServiceMethod.parseAnnotations() 方法。

static <T> ServiceMethod<T> parseAnnotations(Retrofit retrofit, Method method) {
    // 解析方法的注解徒欣、參數(shù)注解逐样、請求頭等等,具體解析方式自己看 parseAnnotations() 方法的代碼
    RequestFactory requestFactory = RequestFactory.parseAnnotations(retrofit, method);

    Type returnType = method.getGenericReturnType();
    if (Utils.hasUnresolvableType(returnType)) {
      throw methodError(method,
          "Method return type must not include a type variable or wildcard: %s", returnType);
    }
    if (returnType == void.class) {
      throw methodError(method, "Service methods cannot return void.");
    }
    // 解析并創(chuàng)建 Call 適配器打肝、數(shù)據(jù)轉(zhuǎn)換器
    return HttpServiceMethod.parseAnnotations(retrofit, method, requestFactory);
  }

繼續(xù)查看 HttpServiceMethod.parseAnnotations() 方法脂新。

static <ResponseT, ReturnT> HttpServiceMethod<ResponseT, ReturnT> parseAnnotations(
      Retrofit retrofit, Method method, RequestFactory requestFactory) {
    // 根據(jù)返回類型創(chuàng)建并獲取 CallAdapter
    CallAdapter<ResponseT, ReturnT> callAdapter = createCallAdapter(retrofit, method);
    Type responseType = callAdapter.responseType();
    if (responseType == Response.class || responseType == okhttp3.Response.class) {
      throw methodError(method, "'"
          + Utils.getRawType(responseType).getName()
          + "' is not a valid response body type. Did you mean ResponseBody?");
    }
    if (requestFactory.httpMethod.equals("HEAD") && !Void.class.equals(responseType)) {
      throw methodError(method, "HEAD method must use Void as response type.");
    }
    
    // 根據(jù) Response 類型創(chuàng)建并獲取 Converter
    Converter<ResponseBody, ResponseT> responseConverter =
        createResponseConverter(retrofit, method, responseType);

    okhttp3.Call.Factory callFactory = retrofit.callFactory;
    return new HttpServiceMethod<>(requestFactory, callFactory, callAdapter, responseConverter);
}

繼續(xù)回去看 invoke() 方法

@Override ReturnT invoke(Object[] args) {
    // 轉(zhuǎn)換成相應的類型
    return callAdapter.adapt(
        new OkHttpCall<>(requestFactory, args, callFactory, responseConverter));
}

// 以 Retrofit 默認適配器為例,假設 SDK version 小于 24
@Override public Call<Object> adapt(Call<Object> call) {
    return new ExecutorCallbackCall<>(callbackExecutor, call);
}

發(fā)送異步網(wǎng)絡請求

@Override public void enqueue(final Callback<T> callback) {
      checkNotNull(callback, "callback == null");
      // 這里 delegate 是 OkHttpCall 對象
      // 大家可以自己看一看 OkHttpCall 的 enqueue() 方法粗梭,它本身就是對 okhttp3.Call 的包裝争便。
      delegate.enqueue(new Callback<T>() {
        @Override public void onResponse(Call<T> call, final Response<T> response) {
          // callbackExecutor 最初配置的線程運行環(huán)境
          callbackExecutor.execute(new Runnable() {
            @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);
            }
          });
        }
      });
}

發(fā)送同步網(wǎng)絡請求

@Override public Response<T> execute() throws IOException {
      // 這里 delegate 是 OkHttpCall 對象
      return delegate.execute();
}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市断医,隨后出現(xiàn)的幾起案子滞乙,更是在濱河造成了極大的恐慌奏纪,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,858評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件斩启,死亡現(xiàn)場離奇詭異序调,居然都是意外死亡,警方通過查閱死者的電腦和手機兔簇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評論 3 395
  • 文/潘曉璐 我一進店門发绢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人垄琐,你說我怎么就攤上這事边酒。” “怎么了狸窘?”我有些...
    開封第一講書人閱讀 165,282評論 0 356
  • 文/不壞的土叔 我叫張陵甚纲,是天一觀的道長。 經(jīng)常有香客問我朦前,道長介杆,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,842評論 1 295
  • 正文 為了忘掉前任韭寸,我火速辦了婚禮春哨,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘恩伺。我一直安慰自己赴背,他們只是感情好,可當我...
    茶點故事閱讀 67,857評論 6 392
  • 文/花漫 我一把揭開白布晶渠。 她就那樣靜靜地躺著凰荚,像睡著了一般。 火紅的嫁衣襯著肌膚如雪褒脯。 梳的紋絲不亂的頭發(fā)上便瑟,一...
    開封第一講書人閱讀 51,679評論 1 305
  • 那天,我揣著相機與錄音番川,去河邊找鬼到涂。 笑死,一個胖子當著我的面吹牛颁督,可吹牛的內(nèi)容都是我干的践啄。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼沉御,長吁一口氣:“原來是場噩夢啊……” “哼屿讽!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起吠裆,我...
    開封第一講書人閱讀 39,311評論 0 276
  • 序言:老撾萬榮一對情侶失蹤伐谈,失蹤者是張志新(化名)和其女友劉穎烂完,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體衩婚,經(jīng)...
    沈念sama閱讀 45,767評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡窜护,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年效斑,在試婚紗的時候發(fā)現(xiàn)自己被綠了非春。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,090評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡缓屠,死狀恐怖奇昙,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情敌完,我是刑警寧澤储耐,帶...
    沈念sama閱讀 35,785評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站滨溉,受9級特大地震影響什湘,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜晦攒,卻給世界環(huán)境...
    茶點故事閱讀 41,420評論 3 331
  • 文/蒙蒙 一闽撤、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧脯颜,春花似錦哟旗、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至矾芙,卻和暖如春舍沙,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背剔宪。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評論 1 271
  • 我被黑心中介騙來泰國打工场勤, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人歼跟。 一個月前我還...
    沈念sama閱讀 48,298評論 3 372
  • 正文 我出身青樓和媳,卻偏偏與公主長得像,于是被迫代替她去往敵國和親哈街。 傳聞我的和親對象是個殘疾皇子留瞳,可洞房花燭夜當晚...
    茶點故事閱讀 45,033評論 2 355

推薦閱讀更多精彩內(nèi)容

  • 目錄介紹 1.首先回顧Retrofit簡單使用方法 2.Retrofit的創(chuàng)建流程源碼分析2.1 Retrofit...
    楊充211閱讀 1,061評論 0 16
  • 一、什么是Retrofit A type-safe HTTP client for Android and Jav...
    andcoder閱讀 770評論 2 3
  • 前言 注解式的框架非成兀火她倘,注解以其輕量璧微,簡潔等特性被人們所喜愛者,關(guān)鍵是它解藕硬梁。網(wǎng)絡請求的框架非常多前硫,比較受歡迎的...
    薩達哈魯醬閱讀 580評論 0 5
  • Retrofit的使用從很早之前就已經(jīng)開始了, 但是一直沒有深入研究為什么使用Retrofit只要定義一個接口, ...
    CoderMonkey閱讀 1,437評論 3 15
  • 1.position:fixed:在瀏覽器上靜止不動,相對瀏覽器進行定位荧止,設置top:20px屹电;left:20px...
    落木兮兮閱讀 409評論 3 2