okhttp 源码学习(三)Dispatcher 深入解析

在上一节中,我对Dispatcher进行了概述。本节主要内容就是带大家了解Dispatcher如何完成任务调度,并进行管理同步/异步的请求状态,如何维护一个线程池,来执行请求。

成员变量

为了下文描述更直观,这里我们先熟悉一下Dispathcer的几个重要的成员变量。我们还是结合源码来看:

public final class Dispatcher {
  private int maxRequests = 64;
  private int maxRequestsPerHost = 5;
  private @Nullable Runnable idleCallback;

  /** Executes calls. Created lazily. */
  private @Nullable ExecutorService executorService;

  /** Ready async calls in the order they'll be run. */
  private final Deque<AsyncCall> readyAsyncCalls = new ArrayDeque<>();

  /** Running asynchronous calls. Includes canceled calls that haven't finished yet. */
  private final Deque<AsyncCall> runningAsyncCalls = new ArrayDeque<>();

  /** Running synchronous calls. Includes canceled calls that haven't finished yet. */
  private final Deque<RealCall> runningSyncCalls = new ArrayDeque<>();
  
  ...
}

以上是Dispatcher类的所有成员变量,从备注的翻译我们也能理解。当然为了照顾所有小伙伴,我这里还是来解释一下。

  • ExecutorService
    这个就是Dispatcher的线程池,维护所有异步请求,执行高效网络操作,使用懒创建方式。初始化代码如下:
public synchronized ExecutorService executorService() {
    if (executorService == null) {
      executorService = new ThreadPoolExecutor(0, Integer.MAX_VALUE, 60, TimeUnit.SECONDS,
          new SynchronousQueue<Runnable>(), Util.threadFactory("OkHttp Dispatcher", false));
    }
    return executorService;
  }
  • readyAsyncCalls
    就绪的异步请求队列,保存所有就绪的异步请求,等待线程池来执行。
  • runningAsyncCalls
    正在执行的异步请求队列,保存所有正在执行的异步请求,包含那些已被取消的但是还没完成的请求Call。
  • runningSyncCalls
    同步请求队列,用于保存所有同步请求Call,包含那些已被取消的但是还没完成的请求Call。

如何维护同步请求状态

对于同步请求,Dispatcher就是通过runningSyncCalls管理的,下面从源码中分析一下如何做到的。
我们先回到RealCall的execute方法中

@Override public Response execute() throws IOException {
    synchronized (this) {
      if (executed) throw new IllegalStateException("Already Executed");
      executed = true;
    }
    captureCallStackTrace();
    eventListener.callStart(this);
    try {
      client.dispatcher().executed(this);
      Response result = getResponseWithInterceptorChain();
      if (result == null) throw new IOException("Canceled");
      return result;
    } catch (IOException e) {
      eventListener.callFailed(this, e);
      throw e;
    } finally {
      client.dispatcher().finished(this);
    }
  }

我们注意到这里通过调用client.dispatcher().executed(this);方法add这个call

 /** Used by {@code Call#execute} to signal it is in-flight. */
  synchronized void executed(RealCall call) {
    runningSyncCalls.add(call);
  }

并在finally代码块中执行client.dispatcher().finished(this);来remove这个call

  /** Used by {@code Call#execute} to signal completion. */
  void finished(RealCall call) {
    finished(runningSyncCalls, call, false);
  }

  private <T> void finished(Deque<T> calls, T call, boolean promoteCalls) {
    int runningCallsCount;
    Runnable idleCallback;
    synchronized (this) {
      if (!calls.remove(call)) throw new AssertionError("Call wasn't in-flight!");
      if (promoteCalls) promoteCalls();
      runningCallsCount = runningCallsCount();
      idleCallback = this.idleCallback;
    }

    if (runningCallsCount == 0 && idleCallback != null) {
      idleCallback.run();
    }
  }

如何维护异步请求状态

这里讲述的将是Dispatcher中的核心思想。我们先回到第一部分成员变量,我们发现异步请求使用了两个队列来存放,Why?。且执行异步请求的线程池初始化时第二个参数maximumPoolSize使用的是Integer.MAX_VALUE,Why?
其实,这里采用到了生产者消费者模式来实现管理,接下来我将带大家了解Dispatcher是怎么做的。
为了大家更好的理解这个问题,我们把Dispatcher理解成生产者,ExecutorService理解成消费者。有了生产者和消费者,就需要有两个队列来存放正在执行异步请求和等待的异步请求,也就是Deque<AsyncCall> readyAsyncCallsDeque<AsyncCall> runningAsyncCalls这两个队列,这就回答了第一个问题。
我们注意到我们的线程池maximumPoolSize使用的是Integer.MAX_VALUE居然没有对线程数量做限制。那么是不是这样呢?我们来看一下Dispatcher的enqueue()方法。

synchronized void enqueue(AsyncCall call) {
    if (runningAsyncCalls.size() < maxRequests && runningCallsForHost(call) < maxRequestsPerHost) {
      runningAsyncCalls.add(call);
      executorService().execute(call);
    } else {
      readyAsyncCalls.add(call);
    }
  }

我们注意到这里有两个参数maxRequestsmaxRequestsPerHost即最大请求数、最大同主机同时请求数。当请求超过这两个最大值,将会存放到等待队列中,因此,线程池ExecutorService线程池的大小将在这里得到限制,并不是初始化传入的Integer.MAX_VALUE,这就回答了第二个问题。
那么有同学肯定在疑问,就绪队列中的请求又是什么时候执行的呢?why。这里将涉及的一个很核心的方法promoteCalls()
别急,我们接着往下看,异步请求在子线程中执行即RealCall.AsyncCall.execute()方法实现请求:

@Override protected void execute() {
      boolean signalledCallback = false;
      try {
        Response response = getResponseWithInterceptorChain();
        if (retryAndFollowUpInterceptor.isCanceled()) {
          signalledCallback = true;
          responseCallback.onFailure(RealCall.this, new IOException("Canceled"));
        } else {
          signalledCallback = true;
          responseCallback.onResponse(RealCall.this, response);
        }
      } catch (IOException e) {
        if (signalledCallback) {
          // Do not signal the callback twice!
          Platform.get().log(INFO, "Callback failure for " + toLoggableString(), e);
        } else {
          eventListener.callFailed(RealCall.this, e);
          responseCallback.onFailure(RealCall.this, e);
        }
      } finally {
        client.dispatcher().finished(this);
      }
    }

注意到在finally中同样执行了client.dispatcher().finished(this);

 /** Used by {@code AsyncCall#run} to signal completion. */
  void finished(AsyncCall call) {
    finished(runningAsyncCalls, call, true);
  }

  private <T> void finished(Deque<T> calls, T call, boolean promoteCalls) {
    int runningCallsCount;
    Runnable idleCallback;
    synchronized (this) {
      if (!calls.remove(call)) throw new AssertionError("Call wasn't in-flight!");
      if (promoteCalls) promoteCalls();
      runningCallsCount = runningCallsCount();
      idleCallback = this.idleCallback;
    }

    if (runningCallsCount == 0 && idleCallback != null) {
      idleCallback.run();
    }
  }

异步请求执行的finished方法参数AsyncCall ,此时注意到调用最终实现到finished方法时传入的promoteCalls参数为true,因此对于异步请求结束时,除了从异步请求队列runningAsyncCalls中remove结束的异步请求,同时调用了promoteCalls()方法。注意到这个过程是线程不安全的,所有放到同步代码块中去执行。这个promoteCalls()方法又是干什么的呢?我们来看一下源码:

  private void promoteCalls() {
    if (runningAsyncCalls.size() >= maxRequests) return; // Already running max capacity.
    if (readyAsyncCalls.isEmpty()) return; // No ready calls to promote.

    for (Iterator<AsyncCall> i = readyAsyncCalls.iterator(); i.hasNext(); ) {
      AsyncCall call = i.next();

      if (runningCallsForHost(call) < maxRequestsPerHost) {
        i.remove();
        runningAsyncCalls.add(call);
        executorService().execute(call);
      }

      if (runningAsyncCalls.size() >= maxRequests) return; // Reached max capacity.
    }
  }

其实这个方法的作用就是管理任务队列的,我们注意到中间有一段for循环,在if中判断正在执行的call请求是否小于maxRequestsPerHost,小于的话就将就绪队列readyAsyncCalls中的请求添加到正在执行的队列runningAsyncCalls中,同时移除就绪队列中请求,再调用线程池来执行这个被移除的就绪队列请求call。

小结

写到这里,关于Dispatcher的源码解析已经告一段落,想必大家对该类也有了一点的认识。回过头来看看Dispatcher的定义是不是更清晰了呢。
上一节 okhttp 源码学习(二)基本流程
下一节 okhttp 源码学习(四)RetryAndFollowUpInterceptor 深入解析

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,802评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,109评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,683评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,458评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,452评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,505评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,901评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,550评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,763评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,556评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,629评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,330评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,898评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,897评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,140评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,807评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,339评论 2 342

推荐阅读更多精彩内容