源码分析->撕开OkHttp(8)拦截器CacheInterceptor

源码分析基于 3.14.4
关键字:拦截器CacheInterceptor

https://www.jianshu.com/p/60aaee13ff65上一篇,讲了CallServerInterceptor拦截器的作用。

这次分析CacheInterceptor

缓存拦截,顾名思义就是做缓存处理的。

还是看CacheInterceptor.intercept

(1)说实在话,缓存的逻辑比较复杂,我也不是每个细节都看懂了,只知道个大概;
(2)cache.get(chain.request()),根据url的MD5值获取缓存cacheCandidate ,candidate是候选的意思,表示可能会返回这个;
(3)new CacheStrategy.Factory,根据Request、Response 、当前时间创建缓存策略CacheStrategy ,这里面是对能否使用缓存做逻辑处理,后面会重点分析;
(4)networkRequest 表示请求实体,cacheResponse 表示缓存实体,两者共同决定使用请求还是缓存;
(5)无请求且无缓存,则networkRequest == null && cacheResponse == null成立,构建504Response返回,通常发生在客户端只希望使用缓存,请求头带only-if-cached的情况;
(6)无请求,则networkRequest == null条件成立,直接返回缓存;
(7)添加(6)不成立,即有请求,则调用后续拦截器发起请求;
(8)后续拦截器返回,即服务器返回结果,有缓存且服务器返回304(表示内容没有变化,可以用缓存),则networkResponse.code() == HTTP_NOT_MODIFIED条件成立,更新缓存的发起请求时间、接收响应时间、缓存响应、网络响应,最后返回;
(9)不是返回304,响应有body且可以缓存,例如返回200且请求头不带no-store且响应头不带no-store,则HttpHeaders.hasBody(response) && CacheStrategy.isCacheable(response, networkRequest)条件成立,把响应缓存起来并返回;
(10)如果请求是POST、DELETED的,删除缓存;
(11)条件(9)不成立,则直接返回响应;

 @Override public Response intercept(Chain chain) throws IOException {
    Response cacheCandidate = cache != null
        ? cache.get(chain.request())
        : null;

    long now = System.currentTimeMillis();

    CacheStrategy strategy = new CacheStrategy.Factory(now, chain.request(), cacheCandidate).get();
    Request networkRequest = strategy.networkRequest;
    Response cacheResponse = strategy.cacheResponse;
    ......    
    if (networkRequest == null && cacheResponse == null) {
      return new Response.Builder()
          .request(chain.request())
          .protocol(Protocol.HTTP_1_1)
          .code(504)
          .message("Unsatisfiable Request (only-if-cached)")
          .body(Util.EMPTY_RESPONSE)
          .sentRequestAtMillis(-1L)
          .receivedResponseAtMillis(System.currentTimeMillis())
          .build();
    }
   
    if (networkRequest == null) {
      return cacheResponse.newBuilder()
          .cacheResponse(stripBody(cacheResponse))
          .build();
    }
 ......
 networkResponse = chain.proceed(networkRequest);
......
    if (cacheResponse != null) {
      if (networkResponse.code() == HTTP_NOT_MODIFIED) {
        Response response = cacheResponse.newBuilder()
            .headers(combine(cacheResponse.headers(), networkResponse.headers()))
            .sentRequestAtMillis(networkResponse.sentRequestAtMillis())
            .receivedResponseAtMillis(networkResponse.receivedResponseAtMillis())
            .cacheResponse(stripBody(cacheResponse))
            .networkResponse(stripBody(networkResponse))
            .build();
        networkResponse.body().close();

        cache.trackConditionalCacheHit();
        cache.update(cacheResponse, response);
        return response;
      } 
    ......
    }

    Response response = networkResponse.newBuilder()
        .cacheResponse(stripBody(cacheResponse))
        .networkResponse(stripBody(networkResponse))
        .build();

    if (cache != null) {
      if (HttpHeaders.hasBody(response) && CacheStrategy.isCacheable(response, networkRequest)) {
        CacheRequest cacheRequest = cache.put(response);
        return cacheWritingResponse(cacheRequest, response);
      }

      if (HttpMethod.invalidatesCache(networkRequest.method())) {
         cache.remove(networkRequest);
         ......
      }
    }
    return response;
  }
流程1.png
看下构建缓存策略是如何处理networkRequest 以及cacheResponse的,主要看CacheStrategy.Factory构造方法以及get方法;

先看CacheStrategy.Factory构造方法,
主要是构建缓存策略构造,获取缓存发起时间(即发起请求时间)、缓存接收数据、读取跟缓存相关的请求头(Date、Expires、Last-Modified等);

    public Factory(long nowMillis, Request request, Response cacheResponse) {
      this.nowMillis = nowMillis;
      this.request = request;
      this.cacheResponse = cacheResponse;

      if (cacheResponse != null) {
        this.sentRequestMillis = cacheResponse.sentRequestAtMillis();
        this.receivedResponseMillis = cacheResponse.receivedResponseAtMillis();
        Headers headers = cacheResponse.headers();
        for (int i = 0, size = headers.size(); i < size; i++) {
          String fieldName = headers.name(i);
          String value = headers.value(i);
          if ("Date".equalsIgnoreCase(fieldName)) {
            servedDate = HttpDate.parse(value);
            servedDateString = value;
          } else if ("Expires".equalsIgnoreCase(fieldName)) {
            expires = HttpDate.parse(value);
          } else if ("Last-Modified".equalsIgnoreCase(fieldName)) {
            lastModified = HttpDate.parse(value);
            lastModifiedString = value;
          } else if ("ETag".equalsIgnoreCase(fieldName)) {
            etag = value;
          } else if ("Age".equalsIgnoreCase(fieldName)) {
            ageSeconds = HttpHeaders.parseSeconds(value, -1);
          }
        }
      }
    }
CacheStrategy.Factory.get

(1)getCandidate(),获取候选缓存策略;
(2)如果networkRequest 不为空且请求头包含only-if-cached,则把构建一个networkRequest以及cacheResponse为空的缓存策略;

    public CacheStrategy get() {
      CacheStrategy candidate = getCandidate();

      if (candidate.networkRequest != null && request.cacheControl().onlyIfCached()) {
        // We're forbidden from using the network and the cache is insufficient.
        return new CacheStrategy(null, null);
      }

      return candidate;
    }
CacheStrategy.Factory.getCandidate

(1)这个方法有点长,主要是获取各种时间计算;
(2)如果是HTTPS请求但是握手信息为空,则request.isHttps() && cacheResponse.handshake()条件成立,返回cacheResponse为空的缓存策略;
(3)如果缓存不应该被缓存的,则!isCacheable(cacheResponse, request)条件成立,同样返回cacheResponse为空的缓存策略,例如cacheResponse返回码不是200、获取请求头带no-store、或者cacheResponse头带no-store;
(4)如果请求不使用缓存、或者需要询问服务器是否可以使用缓存,则返回cacheResponse为空的缓存策略,例如请求头带no-cache、If-Modified-Since、If-None-Match;
(5)cacheResponseAge,计算缓存年龄;
(6)computeFreshnessLifetime,计算缓存新鲜度;
(7)如果缓存没有过有效期,则ageMillis + minFreshMillis < freshMillis + maxStaleMillis条件成立,返回networkRequest 为空而cacheResponse不为空的缓存策略,表示直接使用缓存;
(8)如果缓存头包含ETag、Last-Modified、Date其中一个请求头,则返回networkRequest 不为空而cacheResponse为空缓存策略,表示需要请求服务器;
(9)条件(8)不成立,则返回networkRequest 且cacheResponse不为空的缓存策略,表示需要跟服务器协商,这个缓存能不能使用;

    private CacheStrategy getCandidate() {
      ......
      if (request.isHttps() && cacheResponse.handshake() == null) {
        return new CacheStrategy(request, null);
      }
      if (!isCacheable(cacheResponse, request)) {
        return new CacheStrategy(request, null);
      } 
      CacheControl requestCaching = request.cacheControl();
      if (requestCaching.noCache() || hasConditions(request)) {
        return new CacheStrategy(request, null);
      }

      CacheControl responseCaching = cacheResponse.cacheControl();      
      ......
      if (!responseCaching.noCache() && ageMillis + minFreshMillis < freshMillis + maxStaleMillis) {
       ......
        return new CacheStrategy(null, builder.build());
      }
      ......
      String conditionName;
      String conditionValue;
      if (etag != null) {
        conditionName = "If-None-Match";
        conditionValue = etag;
      } else if (lastModified != null) {
        conditionName = "If-Modified-Since";
        conditionValue = lastModifiedString;
      } else if (servedDate != null) {
        conditionName = "If-Modified-Since";
        conditionValue = servedDateString;
      } else {
        return new CacheStrategy(request, null); // No condition! Make a regular request.
      }

      Headers.Builder conditionalRequestHeaders = request.headers().newBuilder();
      Internal.instance.addLenient(conditionalRequestHeaders, conditionName, conditionValue);

      Request conditionalRequest = request.newBuilder()
          .headers(conditionalRequestHeaders.build())
          .build();
      return new CacheStrategy(conditionalRequest, cacheResponse);
    }
总结

(1)CacheInterceptor缓存拦截,顾名思义就是做缓存处理的;
(2)OkHttp默认支持缓存,配置OkHttpClient.cahe就可以开启缓存,只要服务器做相应处理;
(3)只缓存GET请求;
(4)缓存策略中的networkRequest 以及cacheResponse决定是否使用缓存;
networkRequest 、cacheResponse两者为空,表示客户端只希望使用缓存only-if-cached,返回504响应;
networkRequest 为空,cacheResponse不为空,则返回缓存;
networkRequest 不为空,cacheResponse为空,则没有缓存可以使用,需要请求服务器;
networkRequest 、cacheResponse两者都不为空,则需要跟服务器协商,过去缓存能不能使用。

以上分析有不对的地方,请指出,互相学习,谢谢哦!

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

推荐阅读更多精彩内容