OkHttp源码笔记之流程简析

最新推荐文章于 2024-09-24 10:03:56 发布

禄的光线

最新推荐文章于 2024-09-24 10:03:56 发布

阅读量176

点赞数

分类专栏：源码 OkHttp 文章标签： okhttp okhttp请求流程

本文链接：https://blog.csdn.net/qq_35523678/article/details/87275386

版权

源码同时被 2 个专栏收录

9 篇文章 0 订阅

订阅专栏

OkHttp

7 篇文章 0 订阅

订阅专栏

这篇博客主要记录下okhttp源码系列的流程，也为了避免下次再忘记看过的东西，废话不多说，直接切入今天的主题。

起始

先简单了解下使用到的类：

OkHttpClient：使用okhttp的起点类，它配合管理包括分发，响应拦截，网络配置（超时，重定向重试）等。此外OkHttpClient是以buider模式创建已经初始化一些必要的基本参数

Call: 请求调用的抽象接口，支持同步和异步请求。同步调用：execute , 异步调用：enqueue。支持cancel。需依赖request
（实际我们用的是RealCall）

Request: 承载网络请求信息，其中包含 headers， method：GET/POST ， url， requestBody（Post时报文体）。

Response：请求回应（包含body， request，同时包含缓存回应，网络回应，重试回应等等状态记录）

Dispatcher: 请求分发，分为：同步分发，异步分发。

Interceptor: 拦截器（流程重点）暂有以下：
RetryAndFlowUpInterceptor: 重试以及重定向处理，除去我们自己定义的拦截器，它是第一层拦截器
BridgeInterceptor：   桥接拦截器（支持gzip格式传输等等）
CacheInterceptor:  缓存拦截器  （支持缓存数据，可自定义缓存策略）
ConnectInterceptor:  连接拦截器  （创建及封装socket连接通信）
CallServerInterceptor:  服务拦截器  （封装完善请求并接收响应，先基本都直接配合retrofit直接包装整个过程）

大体流程

okhttp的请求起始方法为OkHttpClient的newCall方法

分为两种：同步(execute)与异步(enqueue)

  OkHttpClient.Builder builder = new OkHttpClient.Builder();
        OkHttpClient okHttpClient = builder.build();
        Request request = new Request.Builder().url(url).build();

         Response response =okHttpClient.newCall(request).execute(); // 同步拿到结果

 okHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                // todo 请求失败的处理
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                // todo 请求成功的处理
            }
        });

当同步时

    @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 {
          responseCallback.onFailure(RealCall.this, e);
        }
      } finally {
        client.dispatcher().finished(this);
      }
    }

异步时

    @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 {
          responseCallback.onFailure(RealCall.this, e);
        }
      } finally {
        client.dispatcher().finished(this);
      }
    }

中间滤过了添加任务到队列的步骤，接下来几篇再去了解。可以看到最终都是调用到了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);
  }

首先是使用容器统一管理了依次包含之前我们自己配置的拦截器及RetryAndFlowUpInterceptor、BridgeInterceptor、CacheInterceptor、ConnectInterceptor、CallServerInterceptor，然后大招来了

 public Response proceed(Request request, StreamAllocation streamAllocation, HttpCodec httpCodec,
      RealConnection connection) throws IOException {
    if (index >= interceptors.size()) throw new AssertionError();

    calls++;

    // If we already have a stream, confirm that the incoming request will use it.
    if (this.httpCodec != null && !this.connection.supportsUrl(request.url())) {
      throw new IllegalStateException("network interceptor " + interceptors.get(index - 1)
          + " must retain the same host and port");
    }

    // If we already have a stream, confirm that this is the only call to chain.proceed().
    if (this.httpCodec != null && calls > 1) {
      throw new IllegalStateException("network interceptor " + interceptors.get(index - 1)
          + " must call proceed() exactly once");
    }

    // Call the next interceptor in the chain.
    RealInterceptorChain next = new RealInterceptorChain(
        interceptors, streamAllocation, httpCodec, connection, index + 1, request);
    Interceptor interceptor = interceptors.get(index);
    Response response = interceptor.intercept(next);

    // Confirm that the next interceptor made its required call to chain.proceed().
    if (httpCodec != null && index + 1 < interceptors.size() && next.calls != 1) {
      throw new IllegalStateException("network interceptor " + interceptor
          + " must call proceed() exactly once");
    }

    // Confirm that the intercepted response isn't null.
    if (response == null) {
      throw new NullPointerException("interceptor " + interceptor + " returned null");
    }

    return response;
  }

从chain的proceed启动到结束的过程优美的诠释了责任链模式的魅力，为方便理解用一张图注释下（图比较简陋，多见谅哈）

从图中可以看出通过责任链把不同的功能实现了分层，每层只关心自己的一部分，传递顺序类似事件传递的流程，从外到里又从里及外。其核心在于这三行代码

   // Call the next interceptor in the chain.
    RealInterceptorChain next = new RealInterceptorChain(
        interceptors, streamAllocation, httpCodec, connection, index + 1, request);
    Interceptor interceptor = interceptors.get(index);
    Response response = interceptor.intercept(next);

责任链从在执行第一个拦截器interceptor通过proceed方法启动时，会首先调用我们自己定义的拦截器（公共参数、headers等），但在这之前会先创建责任链的下一个承接点（即下一个interceptor），并作为参数传递给当前iterceptor，在执行当前interceptor的intercept时在合适的时间会调用责任链的proceed方法此时当前intercepter暂停并且执行下一个interceptor的intercept方法，以此类推，直到请求结果返回在从责任链的尾端陆续调用各个interceptor的剩余要执行的代码，至此整个流程完成。例如下