OkHttp 源碼分析系列(四)- ConnectionPool

??分析完了攔截器悔耘,感覺意猶未盡。其實(shí)在分析攔截器我擂,就已經(jīng)涉及到連接池的概念衬以,但是當(dāng)時(shí)只是一筆帶過缓艳,本來打算寫在系列(三)中的。但是寫下來的話看峻,估計(jì)篇幅比較大阶淘,所以打算單獨(dú)開一篇文章來分析ConnectionPool

1. 概述

??在整個(gè)OkHttp的流程中互妓,我們?cè)谀睦锟吹竭^ConnectionPool的身影呢溪窒?
??首先,在OKHttpClient.Builder的構(gòu)造方法里面冯勉,對(duì)ConnectionPool進(jìn)行了初始化澈蚌。我還記得,當(dāng)時(shí)我在分析OKHttpClient.Builder的構(gòu)造方法時(shí)灼狰,當(dāng)時(shí)說后面會(huì)詳細(xì)的講解它宛瞄。這不,如約而至交胚。
??其次份汗,我們還在StreamAllocationnewStream方法看到過ConnectionPoolStreamAllocation在調(diào)用findConnection方法尋找一個(gè)可以使用Connection蝴簇,這里也涉及到ConnectionPool杯活。findConnection方法在尋找Connection時(shí),首先會(huì)嘗試復(fù)用StreamAllocation本身的Connection,如果這個(gè)Connection不可用的話熬词,那么就會(huì)去ConnectionPool去尋找合適的Connection旁钧。
??總的來說,ConnectionPool負(fù)責(zé)所有的連接荡澎,包括連接的復(fù)用均践,以及無用連接的清理晤锹。本文也從這兩個(gè)方面對(duì)ConnectionPool進(jìn)行分析摩幔。

2. get方法和put方法

??外部通過調(diào)用get方法來獲取一個(gè)可以使用Connection對(duì)象,通過put方法添加一個(gè)新的連接。我們來具體的看看鞭铆,這兩個(gè)方法究竟做了那些事情或衡。

(1). get方法

??get方法是從連接池里面獲取一個(gè)連接供使用。

  @Nullable RealConnection get(Address address, StreamAllocation streamAllocation, Route route) {
    assert (Thread.holdsLock(this));
    for (RealConnection connection : connections) {
      if (connection.isEligible(address, route)) {
        streamAllocation.acquire(connection, true);
        return connection;
      }
    }
    return null;
  }

??其實(shí)get方法表達(dá)的意思比較簡(jiǎn)單车遂,就是遍歷connections,找到一個(gè)合適的連接封断。判斷一個(gè)連接是否可以使用,是通過isEligible方法實(shí)現(xiàn)的舶担。
??isEligible方法內(nèi)部主要是通過判斷當(dāng)前Connection擁有的StreamAllocation是否超過的限制坡疼,或者當(dāng)前Connection是否不允許分配stream等等途徑,進(jìn)而判斷當(dāng)前Connection是否有效衣陶。
??為什么需要判斷Connection擁有的StreamAllocation是否超過的限制呢柄瑰?因?yàn)樵?code>StreamAllocation的acquire方法里面做了如此操作:

  public void acquire(RealConnection connection, boolean reportedAcquired) {
    assert (Thread.holdsLock(connectionPool));
    if (this.connection != null) throw new IllegalStateException();

    this.connection = connection;
    this.reportedAcquired = reportedAcquired;
    connection.allocations.add(new StreamAllocationReference(this, callStackTrace));
  }

??從acquire方法里面闸氮,我們可以發(fā)現(xiàn),首先給StreamAllocationconnection賦值教沾;其次蒲跨,把當(dāng)前的StreamAllocation對(duì)象添加到connectionallocations數(shù)組里面,表示當(dāng)前的Connection被分配給這個(gè)StreamAllocation授翻。
??看完了get方法或悲,我們?cè)趤砜纯?code>put方法。

(2).put方法

??直接來看看put方法的實(shí)現(xiàn):

  void put(RealConnection connection) {
    assert (Thread.holdsLock(this));
    if (!cleanupRunning) {
      cleanupRunning = true;
      executor.execute(cleanupRunnable);
    }
    connections.add(connection);
  }

??put方法表達(dá)的意思更加簡(jiǎn)單堪唐,直接將Connection對(duì)象添加到connections數(shù)組巡语。不過這里有一個(gè)地方需要注意,就是如果cleanupRunningfalse羔杨,就會(huì)想線程池里面添加一個(gè)cleanupRunnable捌臊,這里的目的進(jìn)行清理操作。這個(gè)馬上就會(huì)說兜材。
??總的來說理澎,ConnectionPoolget方法和put方法還是比較簡(jiǎn)單的。接下來我們來看看ConnectionPool的清理操作曙寡。

3. 清理無用的連接

??從上面我們已經(jīng)知道糠爬,ConnectionPool是通過一個(gè)cleanupRunnable來完成清理工作的。我們來看看cleanupRunnable的實(shí)現(xiàn):

  private final Runnable cleanupRunnable = new Runnable() {
    @Override public void run() {
      while (true) {
        long waitNanos = cleanup(System.nanoTime());
        if (waitNanos == -1) return;
        if (waitNanos > 0) {
          long waitMillis = waitNanos / 1000000L;
          waitNanos -= (waitMillis * 1000000L);
          synchronized (ConnectionPool.this) {
            try {
              ConnectionPool.this.wait(waitMillis, (int) waitNanos);
            } catch (InterruptedException ignored) {
            }
          }
        }
      }
    }
  };

??這個(gè)cleanupRunnable是一個(gè)死循環(huán)的任務(wù)举庶,只要cleanup方法不返回-1执隧,就會(huì)一直執(zhí)行。
??當(dāng)cleanup方法沒有返回-1户侥,當(dāng)前的Runnable就會(huì)進(jìn)入睡眠狀態(tài)镀琉。看來真正的操作是在cleanup方法里面蕊唐,我們來看看:

  long cleanup(long now) {
    int inUseConnectionCount = 0;
    int idleConnectionCount = 0;
    RealConnection longestIdleConnection = null;
    long longestIdleDurationNs = Long.MIN_VALUE;

    // Find either a connection to evict, or the time that the next eviction is due.
    synchronized (this) {
      for (Iterator<RealConnection> i = connections.iterator(); i.hasNext(); ) {
        RealConnection connection = i.next();

        // If the connection is in use, keep searching.
        if (pruneAndGetAllocationCount(connection, now) > 0) {
          inUseConnectionCount++;
          continue;
        }

        idleConnectionCount++;

        // If the connection is ready to be evicted, we're done.
        long idleDurationNs = now - connection.idleAtNanos;
        if (idleDurationNs > longestIdleDurationNs) {
          longestIdleDurationNs = idleDurationNs;
          longestIdleConnection = connection;
        }
      }

      if (longestIdleDurationNs >= this.keepAliveDurationNs
          || idleConnectionCount > this.maxIdleConnections) {
        // We've found a connection to evict. Remove it from the list, then close it below (outside
        // of the synchronized block).
        connections.remove(longestIdleConnection);
      } else if (idleConnectionCount > 0) {
        // A connection will be ready to evict soon.
        return keepAliveDurationNs - longestIdleDurationNs;
      } else if (inUseConnectionCount > 0) {
        // All connections are in use. It'll be at least the keep alive duration 'til we run again.
        return keepAliveDurationNs;
      } else {
        // No connections, idle or in use.
        cleanupRunning = false;
        return -1;
      }
    }

    closeQuietly(longestIdleConnection.socket());

    // Cleanup again immediately.
    return 0;
  }

??ConnectionPool的清理操作在cleanup方法里面體現(xiàn)的淋漓盡致屋摔。我們具體的分析cleanup方法。
??首先替梨,通過for循環(huán)找到當(dāng)前正在使用的Connection數(shù)量和未使用的Connection數(shù)量钓试,還有最大空閑時(shí)間和最大空閑時(shí)間的Connection亡嫌,這些在下面的判斷都是用的丰滑。
??找到的最大空閑時(shí)間跟默認(rèn)的最大空閑時(shí)間比較躺酒,如果大于的話岩齿,表示當(dāng)前Connection已經(jīng)超過了最大的空閑時(shí)間嫌吠,應(yīng)該被回收外恕,所以我們看到它會(huì)被remove掉:

      if (longestIdleDurationNs >= this.keepAliveDurationNs
          || idleConnectionCount > this.maxIdleConnections) {
        // We've found a connection to evict. Remove it from the list, then close it below (outside
        // of the synchronized block).
        connections.remove(longestIdleConnection);
      }

??如果當(dāng)前已經(jīng)有了空閑的Connection媚赖,那么就會(huì)keepAliveDurationNs - longestIdleDurationNs,表示當(dāng)前的cleanupRunnable還需要睡眠keepAliveDurationNs - longestIdleDurationNs時(shí)間漏隐,至于為什么是這么多,大家可以想一想信认,這里就不做過多的解釋串稀。
??其次,就是如果當(dāng)前還有正在使用的Connection,那么當(dāng)前的cleanupRunnable還需要沉睡keepAliveDurationNs狮杨。這個(gè)上面的意思差不多母截。
??如果當(dāng)前既沒有空閑的Connection,又沒有正在使用的Connection橄教,那么表示當(dāng)前的ConnectionPool已經(jīng)空了清寇,可以被回收了。

4. 總結(jié)

??ConnectionPool還是比較簡(jiǎn)單的护蝶,這里對(duì)它進(jìn)行一個(gè)簡(jiǎn)單的總結(jié)华烟。
??1.get方法可以從ConnectionPool里面獲取一個(gè)Connection。如果獲取成功持灰,則會(huì)在Connectionallocations添加對(duì)應(yīng)的StreamAllocation盔夜,表示當(dāng)前Connection被分配給一個(gè)StreamAllocation。這個(gè)會(huì)成為判斷當(dāng)前Connection是否有效的依據(jù)堤魁。
??2.put方法在第一次調(diào)用時(shí)會(huì)啟動(dòng)一個(gè)清理線程喂链。這個(gè)清理線程只會(huì)在當(dāng)前ConnectionPool為空時(shí)才會(huì)退出。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末妥泉,一起剝皮案震驚了整個(gè)濱河市椭微,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌盲链,老刑警劉巖蝇率,帶你破解...
    沈念sama閱讀 219,366評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異刽沾,居然都是意外死亡本慕,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,521評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門侧漓,熙熙樓的掌柜王于貴愁眉苦臉地迎上來锅尘,“玉大人,你說我怎么就攤上這事火架〖螅” “怎么了忙菠?”我有些...
    開封第一講書人閱讀 165,689評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵何鸡,是天一觀的道長。 經(jīng)常有香客問我牛欢,道長骡男,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,925評(píng)論 1 295
  • 正文 為了忘掉前任傍睹,我火速辦了婚禮隔盛,結(jié)果婚禮上犹菱,老公的妹妹穿的比我還像新娘。我一直安慰自己吮炕,他們只是感情好腊脱,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,942評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著龙亲,像睡著了一般陕凹。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上鳄炉,一...
    開封第一講書人閱讀 51,727評(píng)論 1 305
  • 那天杜耙,我揣著相機(jī)與錄音,去河邊找鬼拂盯。 笑死佑女,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的谈竿。 我是一名探鬼主播团驱,決...
    沈念sama閱讀 40,447評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼空凸!你這毒婦竟也來了店茶?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,349評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤劫恒,失蹤者是張志新(化名)和其女友劉穎贩幻,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體两嘴,經(jīng)...
    沈念sama閱讀 45,820評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡丛楚,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,990評(píng)論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了憔辫。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片趣些。...
    茶點(diǎn)故事閱讀 40,127評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖贰您,靈堂內(nèi)的尸體忽然破棺而出坏平,到底是詐尸還是另有隱情,我是刑警寧澤锦亦,帶...
    沈念sama閱讀 35,812評(píng)論 5 346
  • 正文 年R本政府宣布舶替,位于F島的核電站,受9級(jí)特大地震影響杠园,放射性物質(zhì)發(fā)生泄漏顾瞪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,471評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望陈醒。 院中可真熱鬧惕橙,春花似錦、人聲如沸钉跷。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,017評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽爷辙。三九已至惶凝,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間犬钢,已是汗流浹背苍鲜。 一陣腳步聲響...
    開封第一講書人閱讀 33,142評(píng)論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留玷犹,地道東北人混滔。 一個(gè)月前我還...
    沈念sama閱讀 48,388評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像歹颓,于是被迫代替她去往敵國和親坯屿。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,066評(píng)論 2 355

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