okHttp源碼分析

OkHttp 是一套處理 HTTP 網(wǎng)絡請求的依賴庫寡痰,由 Square 公司設計研發(fā)并開源挪蹭,目前可以在 Java 和 Kotlin 中使用妨退。

對于 Android App 來說,OkHttp 現(xiàn)在幾乎已經(jīng)占據(jù)了所有的網(wǎng)絡請求操作溃列,RetroFit + OkHttp 實現(xiàn)網(wǎng)絡請求似乎成了一種標配。因此它也是每一個 Android 開發(fā)工程師的必備技能膛薛,了解其內(nèi)部實現(xiàn)原理可以更好地進行功能擴展哭廉、封裝以及優(yōu)化。

異步執(zhí)行的隊列

先從OkHttp的基本使用切入:

先是構建請求相叁,通過 Builder() 構建初始化Dispatcher遵绰,Http協(xié)議類型protocols,Cookie壓縮類型增淹,dns等參數(shù)椿访。

請求操作的起點從 OkHttpClient.newCall().enqueue() 方法開始。

  • newCall

okHttpClient.newCall 把 request 封裝轉成一個 RealCall

這個方法會返回一個 RealCall 類型的對象虑润,通過它將網(wǎng)絡請求操作添加到請求隊列中成玫。

enqueue方法將Callable對象轉換成一個異步的AsyncCall的runnable對象。

AsyncCall是RealCall的內(nèi)部類,并且把它交給了client的dispatch對象哭当。

Dispatcher 是 OkHttpClient 的調(diào)度器猪腕,是一種門戶模式。主要用來實現(xiàn)執(zhí)行钦勘、取消異步請求操作陋葡。本質(zhì)上是內(nèi)部維護了一個線程池去執(zhí)行異步操作,并且在 Dispatcher 內(nèi)部根據(jù)一定的策略彻采,保證最大并發(fā)個數(shù)腐缤、同一 host 主機允許執(zhí)行請求的線程個數(shù)等。

在enqueue方法會先判斷在運行的asyncCalls數(shù)量是不是已經(jīng)達到最大的64個肛响,并且還會判斷當前運行的主機數(shù)(也就是網(wǎng)頁URL主要部分岭粤,端口前面的主地址)是不是超過了最大的5個。如果都小于特笋,則將當前的AsyncCall加入到正在執(zhí)行的集合中剃浇,否則加入準備執(zhí)行的集合中。加入到正在執(zhí)行的集合中猎物,就會調(diào)用線程池的執(zhí)行方法虎囚。最終去了AsyncCall的execute方法

這里為什么不是run方法的原因是因為AsyncCall繼承的NamedRunnable的run方法中調(diào)用了execute方法

在AsyncCall的execute方法中,就會來到最重要的一個部分霸奕,也就是攔截器的部分。而等攔截器執(zhí)行完吉拳,攔截器方法返回的就是Response质帅。

攔截器

而真正獲取請求結果的方法是在 getResponseWithInterceptorChain 方法中,從名字也能看出其內(nèi)部是一個攔截器的調(diào)用鏈留攒,具體代碼如下:

在添加上述幾個攔截器之前煤惩,會調(diào)用 client.interceptors 將開發(fā)人員設置的攔截器添加到列表當中。

而如果是需要在進行連接后回傳數(shù)據(jù)進行攔截的的話炼邀,也會通過調(diào)用 client.networkInterceptors魄揉。

例如自定義緩存攔截器加載在后面,也就是addNetworkInterceptor拭宁,來實現(xiàn)自定義緩存策略攔截器洛退。如果是調(diào)用 client.interceptors ,則因為回傳數(shù)據(jù)已經(jīng)進過CacheInterceptor杰标,所以無法生效兵怯。而調(diào)用 client.networkInterceptors 則是在接收到resp后,resp會先來到 networkInterceptors 添加的攔截器腔剂,進行緩存策略的更改媒区,再回傳給 CacheInterceptor 上層進行緩存策略判斷。

RetryAndFollowUpInterceptor攔截器

內(nèi)部為一個死循環(huán),每次都會重試丟給下一級處理袜漩。

@Override public Response intercept(Chain chain) throws IOException {
    Request request = chain.request();
    RealInterceptorChain realChain = (RealInterceptorChain) chain;
    Call call = realChain.call();

    /**
    部分代碼省略
    **/    

    while (true) {
      /**
      部分代碼省略
      **/    
      Response response;
      boolean releaseConnection = true;
      try {
        response = realChain.proceed(request, streamAllocation, null, null);
        releaseConnection = false;
      } catch (RouteException e) {
        // The attempt to connect via a route failed. The request will not have been sent.
        if (!recover(e.getLastConnectException(), streamAllocation, false, request)) {
          throw e.getLastConnectException();
        }
        releaseConnection = false;
        continue;
      } catch (IOException e) {
        // An attempt to communicate with a server failed. The request may have been sent.
        boolean requestSendStarted = !(e instanceof ConnectionShutdownException);
        if (!recover(e, streamAllocation, requestSendStarted, request)) throw e;
        releaseConnection = false;
        continue;
      } finally {
        /**
        部分代碼省略
        **/    
      }

      if (++followUpCount > MAX_FOLLOW_UPS) {
        streamAllocation.release();
        throw new ProtocolException("Too many follow-up requests: " + followUpCount);
      }

      if (followUp.body() instanceof UnrepeatableRequestBody) {
        streamAllocation.release();
        throw new HttpRetryException("Cannot retry streamed HTTP body", response.code());
      }

      if (!sameConnection(response, followUp.url())) {
        streamAllocation.release();
        streamAllocation = new StreamAllocation(client.connectionPool(),
            createAddress(followUp.url()), call, eventListener, callStackTrace);
        this.streamAllocation = streamAllocation;
      } else if (streamAllocation.codec() != null) {
        throw new IllegalStateException("Closing the body of " + response
            + " didn't close its backing stream. Bad interceptor?");
      }

      /**
      部分代碼省略
      **/    

  }

是否跳出循環(huán)看是否為致命異常绪爸,如果不是致命異常起愈,例如連接超時前域,則進行重試。

并且在這個攔截器中媳瞪,還會處理重定向307粘优、308等仇味。會通過獲取新的頭部信息,生產(chǎn)一個新的請求雹顺,交給下級丹墨。

RetryAndFollowUpInterceptor中followUpRequest方法處理狀態(tài)碼

BridgeInterceptor攔截器

主要設置一些通用的請求頭,Content-type嬉愧,connection贩挣,content-length,Cookie没酣。做一些返回的處理王财,如果被壓縮,采用Zip解壓裕便,保存Cookie绒净。

@Override public Response intercept(Chain chain) throws IOException {
    Request userRequest = chain.request();
    Request.Builder requestBuilder = userRequest.newBuilder();

    RequestBody body = userRequest.body();
    if (body != null) {
      MediaType contentType = body.contentType();
      if (contentType != null) {
        requestBuilder.header("Content-Type", contentType.toString());
      }

      long contentLength = body.contentLength();
      if (contentLength != -1) {
        requestBuilder.header("Content-Length", Long.toString(contentLength));
        requestBuilder.removeHeader("Transfer-Encoding");
      } else {
        requestBuilder.header("Transfer-Encoding", "chunked");
        requestBuilder.removeHeader("Content-Length");
      }
    }

    if (userRequest.header("Host") == null) {
      requestBuilder.header("Host", hostHeader(userRequest.url(), false));
    }

    if (userRequest.header("Connection") == null) {
      requestBuilder.header("Connection", "Keep-Alive");
    }

    // If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
    // the transfer stream.
    boolean transparentGzip = false;
    if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
      transparentGzip = true;
      requestBuilder.header("Accept-Encoding", "gzip");
    }

    List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
    }

    if (userRequest.header("User-Agent") == null) {
      requestBuilder.header("User-Agent", Version.userAgent());
    }

    Response networkResponse = chain.proceed(requestBuilder.build());

    HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());

    Response.Builder responseBuilder = networkResponse.newBuilder()
        .request(userRequest);

    if (transparentGzip
        && "gzip".equalsIgnoreCase(networkResponse.header("Content-Encoding"))
        && HttpHeaders.hasBody(networkResponse)) {
      GzipSource responseBody = new GzipSource(networkResponse.body().source());
      Headers strippedHeaders = networkResponse.headers().newBuilder()
          .removeAll("Content-Encoding")
          .removeAll("Content-Length")
          .build();
      responseBuilder.headers(strippedHeaders);
      String contentType = networkResponse.header("Content-Type");
      responseBuilder.body(new RealResponseBody(contentType, -1L, Okio.buffer(responseBody)));
    }

    return responseBuilder.build();
  }

CacheInterceptor攔截器

負責 HTTP 請求的緩存處理。

CacheInterceptor 主要做以下幾件事情:

  • 根據(jù) Request 獲取當前已有緩存的 Response(有可能為 null)偿衰,并根據(jù)獲取到的緩存 Response挂疆,創(chuàng)建 CacheStrategy 對象。
  • 通過 CacheStrategy 判斷當前緩存中的 Response 是否有效(比如是否過期)下翎,如果緩存 Response 可用則直接返回缤言,否則調(diào)用 chain.proceed() 繼續(xù)執(zhí)行下一個攔截器,也就是發(fā)送網(wǎng)絡請求從服務器獲取遠端 Response视事。具體如下:
  • 如果從服務器端成功獲取 Response胆萧,再判斷是否將此 Response 進行緩存操作。

ConnectInterceptor攔截器

負責建立與服務器地址之間的連接俐东,也就是 TCP 連接跌穗。

建立Socket連接連接緩存,封裝HttpCodec里面封裝了okio的輸入輸出流虏辫,就可以向服務器寫數(shù)據(jù)和返回數(shù)據(jù)瞻离。

CallServerInterceptor攔截器

CallServerInterceptor 是 OkHttp 中最后一個攔截器,也是 OkHttp 中最核心的網(wǎng)路請求部分乒裆,其 intercept 方法如下:

如上圖所示套利,主要分為 2 部分推励。藍線以上的操作是向服務器端發(fā)送請求數(shù)據(jù),藍線以下代表從服務端獲取相應數(shù)據(jù)并構建 Response 對象肉迫。

總結

這節(jié)課主要分析了 OkHttp 的源碼實現(xiàn):

  • OkHttp 內(nèi)部是一個門戶模式验辞,所有的下發(fā)工作都是通過一個門戶 Dispatcher 來進行分發(fā)。

  • 在網(wǎng)絡請求階段通過責任鏈模式喊衫,鏈式的調(diào)用各個攔截器的 intercept 方法跌造。

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市族购,隨后出現(xiàn)的幾起案子壳贪,更是在濱河造成了極大的恐慌,老刑警劉巖寝杖,帶你破解...
    沈念sama閱讀 218,941評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件违施,死亡現(xiàn)場離奇詭異,居然都是意外死亡瑟幕,警方通過查閱死者的電腦和手機磕蒲,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來只盹,“玉大人辣往,你說我怎么就攤上這事≈潮埃” “怎么了站削?”我有些...
    開封第一講書人閱讀 165,345評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長孵稽。 經(jīng)常有香客問我许起,道長,這世上最難降的妖魔是什么肛冶? 我笑而不...
    開封第一講書人閱讀 58,851評論 1 295
  • 正文 為了忘掉前任街氢,我火速辦了婚禮扯键,結果婚禮上睦袖,老公的妹妹穿的比我還像新娘。我一直安慰自己荣刑,他們只是感情好馅笙,可當我...
    茶點故事閱讀 67,868評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著厉亏,像睡著了一般董习。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上爱只,一...
    開封第一講書人閱讀 51,688評論 1 305
  • 那天皿淋,我揣著相機與錄音,去河邊找鬼。 笑死窝趣,一個胖子當著我的面吹牛疯暑,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播哑舒,決...
    沈念sama閱讀 40,414評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼妇拯,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了洗鸵?” 一聲冷哼從身側響起越锈,我...
    開封第一講書人閱讀 39,319評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎膘滨,沒想到半個月后甘凭,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,775評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡吏祸,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年对蒲,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片贡翘。...
    茶點故事閱讀 40,096評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡蹈矮,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出鸣驱,到底是詐尸還是另有隱情泛鸟,我是刑警寧澤,帶...
    沈念sama閱讀 35,789評論 5 346
  • 正文 年R本政府宣布踊东,位于F島的核電站北滥,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏闸翅。R本人自食惡果不足惜再芋,卻給世界環(huán)境...
    茶點故事閱讀 41,437評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望坚冀。 院中可真熱鬧济赎,春花似錦、人聲如沸记某。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽液南。三九已至壳猜,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間滑凉,已是汗流浹背统扳。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評論 1 271
  • 我被黑心中介騙來泰國打工喘帚, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人咒钟。 一個月前我還...
    沈念sama閱讀 48,308評論 3 372
  • 正文 我出身青樓啥辨,卻偏偏與公主長得像,于是被迫代替她去往敵國和親盯腌。 傳聞我的和親對象是個殘疾皇子溉知,可洞房花燭夜當晚...
    茶點故事閱讀 45,037評論 2 355

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