OkHttp3 源码分析(一)------简单流程

看了有一段时间的OkHttp3的源码了。今天动笔开始写一写,本篇文章只是简单的写一下OkHttp3的一个过程。(以后的文章会对OkHttp3的内部进行分析)。

OkHttp3 优点:

1.支持http1/http2
2.对一台机器的所有请求共享同一个socket
3.内部有连接池,减少创建和链接时过多的时间消耗

设计模式

整个OkHttp用到很多设计模式:

1.外观模式:

OKHttpClient 里面封装了很多的类对象。其实就是将OKHttp的很多功能模块,全部封装到这个类中,让这个类单独提供对外的API。

 外观模式(Facade Pattern)隐藏系统的复杂性,并向客户端提供了一个客户端可以访问系统的接口。这种类型的设计模式属于结构型模式,它向现有的系统添加一个接口,来隐藏系统的复杂性。
这种模式涉及到一个单一的类,该类提供了客户端请求的简化方法和对现有系统类方法的委托调用。

2.建造者模式

正因为内部功能块比较多,大量使用了建造者模式,比如Reuqest的创建,等等吧。

建造者模式(Builder Pattern)使用多个简单的对象一步一步构建成一个复杂的对象。这种类型的设计模式属于创建型模式,它提供了一种创建对象的最佳方式。
一个 Builder 类会一步一步构造最终的对象。该 Builder 类是独立于其他对象的。

主体架构和大概流程

IMG_20180129_093053.png

OkHttp的主要使用就是:
new OkHttpClient().newCall(request).execute();(同步);
new OkHttpClient().newCall(request).enqueue();(异步)
通过这行代码,我们可以捋出OkHttp的大致流程:

execute同步请求的方法:

newCall(request)的方法是返回一个RealCall

 @Override public Call newCall(Request request) {
    return new RealCall(this, request, false /* for web socket */);
  }


  @Override public Response execute() throws IOException {
    synchronized (this) {
      if (executed) throw new IllegalStateException("Already Executed");
      executed = true;
    }
//是用来跟踪调用栈的信息的,不用深究
    captureCallStackTrace();
    try {
A://此方法只是把请求加入队列并没有真正执行;
      client.dispatcher().executed(this);
B://真正执行请求进行网络请求返回结果
      Response result = getResponseWithInterceptorChain();
      if (result == null) throw new IOException("Canceled");
      return result;
    } finally {
      client.dispatcher().finished(this);
    }
  }

A:此处调用了Dispatcher的executed的方法 把Call加入到队列中runningSyncCalls.add(call);(稍后分析Dispatcher)

B:调用拦截器返回结果;

enqueue异步请求的方法:

调用RealCall的enqueue方法

  @Override public void enqueue(Callback responseCallback) {
    synchronized (this) {
      if (executed) throw new IllegalStateException("Already Executed");
      executed = true;
    }
    captureCallStackTrace();
A:
    client.dispatcher().enqueue(new AsyncCall(responseCallback));
  }

A:调用了Dispatcher的enqueue方法。可以看到此方法参数中创建了一个AsyncCall(构建call对象)。
其中Dispatcher的enqueue的方法


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

可以看出此段代码也是把请求加入队列,然后执行 executorService().execute(call),其中AsyncCall 继承NamedRunnable 是一个线程,我们应该看他的execute()方法,此方法中也同样调用了 Response response = getResponseWithInterceptorChain();方法。
executorService属于线程池,所以此方法executorService().execute(call)执行的是AsyncCall方法的execute方法;(稍后会对Dispatcher进行分析)

Dispatcher(任务分发器)

我们知道OkHttp内部是有一个线程池的,这个线程池就在Dispatcher中,其实这个类就是一个任务队列。
那么我们来看一下Dispatcher的成员变量:

//最大并发请求数为64
  private int maxRequests = 64;
//每个主机最大请求数是5
  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<>();

看完成员变量我们发现其中有两个异步队列,这是为什么?

采用Deque作为缓存,按照入队的顺序先进先出,Deque双端队列,继承自Queue,我们通过这连个队列我们不难看出是采用了生产消费者模式,结合线程池实现了低阻塞的运行。在大多数时候,每个缓存它们都只是访问自己的双端队列,这样的话极大地减少了竞争。当工作者线程需要访问另一个队列时,它会从队列的尾部而不是头部获取工作,因此进一步降低了队列上的竞争程度。

Dispatcher的线程池ExecutorService


  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;
  }

使用单利的方式创建线程池,那么我们来解释一下线程池的几个参数
1.int corePoolSize: 0 线程池的基本大小,即在没有任务需要执行的时候线程池的大小,并且只有在工作队列满了的情况下才会创建超出这个数量的线程。
2.int maxmumPoolSize: Integer.MAX_VALUE 最大线程数,就是当前任务进行时,此线程池能扩充的最大值。这里是无限大。
3.long keepAliveTime:60 当前线程数大于核心线程数,成为空闲线程,当空闲线程存活时间大于这个时间就会被取消
4.TimeUnit unit: TimeUnit.SECONDS 存活时间的单位是秒
5.BlockingQueue<Runnable> workQueue: new SynchronousQueue<Runnable>() 一个阻塞队列,用来存储等待执行的任务
6.ThreadFactory threadFactory: 创建线程的工厂 Util.threadFactory("OkHttp Dispatcher", false)

前面我们分析了同步和一部的方法,就不做过多解释了。

我们来看一下如何从ready到runing的添加的。
每次Call结束的时候都会调用finshed
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!");
          //每次remove完后,执行promoteCalls来轮转。
          if (promoteCalls) promoteCalls();
          runningCallsCount = runningCallsCount();
          idleCallback = this.idleCallback;
        }
        //线程池为空时,执行回调
        if (runningCallsCount == 0 && idleCallback != null) {
          idleCallback.run();
        }
      }
这个方法可以看出来是遍历了readyAsyncCalls,把Call一一添加到了RunningAysncCalls。
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; 
        }
   }

getResponseWithInterceptorChain()

这一步是OkHttp中最重要的一部,也是核心。

 Response getResponseWithInterceptorChain() throws IOException {
    // Build a full stack of interceptors.
    List<Interceptor> interceptors = new ArrayList<>();
    interceptors.addAll(client.interceptors());
    interceptors.add(retryAndFollowUpInterceptor);
    interceptors.add(new BridgeInterceptor(client.cookieJar()));
    interceptors.add(new CacheInterceptor(client.internalCache()));
    interceptors.add(new ConnectInterceptor(client));
    if (!forWebSocket) {
      interceptors.addAll(client.networkInterceptors());
    }
    interceptors.add(new CallServerInterceptor(forWebSocket));

    Interceptor.Chain chain = new RealInterceptorChain(
        interceptors, null, null, null, 0, originalRequest);
    return chain.proceed(originalRequest);
  }

代码很简单就是将
自定义的拦截器和OkHttp内置的拦截器放到一个List集合中,然后把拦截器集合和Request一起创建了一个RealInterceptorChain对象,然后调用proceed方法把整个拦截器组合成链状。最终返回一个Response

责任链模式:一个请求沿着一条“链”传递,直到该“链”上的某个处理者处理它为止。

  • client.interceptors() :
    自定义的拦截器
  • retryAndFollowUpInterceptor:
    失败后重连或者服务器返回请求重新发起请求的拦截器。
  • BridgeInterceptor:
    链接客户端代码和网络代码的桥梁,也就是说配置请求内容(设置内容长度,内容编码,设置gzip压缩,添加cookie,设置其他报头)
  • CacheInterceptor
    缓存机制拦截器,也就是说有没有满足请求的缓存有的话返回Cache。当服务器返回数据有变化时更新Cache,如果当前Cache失效就删除。
  • ConnectInterceptor:
    建立服务器连接,正式开启了网络请求,调用连接池,开启Socket链接。
  • networkInterceptors:
    配置 OkHttpClient 时设置
  • CallServerInterceptor
    向服务器发送请求,并最终返回Response对象供客户端使用。
如何让整个链状拦截器运转起来的?咱们现在看一下proceed方法
//正式开始调用拦截器工作  
public Response proceed(Request request, StreamAllocation streamAllocation, HttpCodec httpCodec,RealConnection connection){

    //省略部分与本文无关的代码

    // 调用链中的下一个拦截器
    RealInterceptorChain next = new RealInterceptorChain(
        interceptors, streamAllocation, httpCodec, connection, index + 1, request);
    Interceptor interceptor = interceptors.get(index);
    Response response = interceptor.intercept(next);

   //确保每个拦截器都调用了proceed方法()
      if (httpCodec != null && index + 1 < interceptors.size() && next.calls != 1) {
      throw new IllegalStateException("network interceptor " + interceptor
          + " must call proceed() exactly once");
    }
   //省略部分与本文无关的代码
    return response;
  }

其中有个index变量,每次调用都加1,然后获得下一个拦截器,procced方法并没有用for循环来遍历interceptors集合,而是重新创建了一个RealInterceptorChain对象,且新对象的index在原来RealInterceptorChain对象index之上进行index+1,并把新的拦截器链对象RealInterceptorChain交给当前拦截器Interceptor 的intercept方法;查看BridgeInterceptor、CacheInterceptor等Okhttp内置拦截器就可以印证这一点:在它们intercept的内部都调用了chain.proceed()方法,且每次调用都在会创建一个RealInterceptorChain对象。所以整个拦截器的工作流程是这样的:


微信图片_20180129200804.jpg

那么到此为止一个完整的Okttp请求的流程就已经完成。

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

推荐阅读更多精彩内容