基于 Gilde 4.3.1

上一篇Glide 源碼學(xué)習(xí),了解 Glide 圖片加載原理中分析了 Glide 加載圖片的過(guò)程，因?yàn)槠L(zhǎng)沒(méi)有去分析 Glide 的另一個(gè)重要模塊: 圖片緩存

Glide 緩存設(shè)置

先看代碼

ImgurGlide.with(getApplicationContext())
    .load(imageUrl)
    .skipMemoryCache(true)
    .diskCacheStrategy(DiskCacheStrategy.NONE)
    .into(imageView);

其中 skipMemoryCache(true) 表示不使用內(nèi)存緩存策略，默認(rèn)是支持內(nèi)存緩存。

diskCacheStrategy(DiskCacheStrategy.NONE) 指定一個(gè)磁盤(pán)緩存策略 DiskCacheStrategy.NONE 表示磁盤(pán)不緩存，默認(rèn)開(kāi)啟緩存。

內(nèi)存緩存

Glide 源碼學(xué)習(xí),了解 Glide 圖片加載原理 中已經(jīng)說(shuō)明，在 Engine.load() 方法中判斷是否有緩存，如果有就返回緩存圖片。這里再詳細(xì)說(shuō)明一下，這里說(shuō)的緩存是內(nèi)存緩存

  public <R> LoadStatus load(……) {
    ……

    EngineKey key = keyFactory.buildKey(model, signature, width, height, transformations,
        resourceClass, transcodeClass, options);

    EngineResource<?> cached = loadFromCache(key, isMemoryCacheable);
    if (cached != null) {
      cb.onResourceReady(cached, DataSource.MEMORY_CACHE);
      ……
      return null;
    }

    EngineResource<?> active = loadFromActiveResources(key, isMemoryCacheable);
    if (active != null) {
      cb.onResourceReady(active, DataSource.MEMORY_CACHE);
      ……
      return null;
    }

    ……
  }

我們看到了兩個(gè)方法 loadFromCache(key, isMemoryCacheable) 和 loadFromActiveResources(key, isMemoryCacheable) 兩個(gè)方法。只要任何一個(gè)不為空就認(rèn)為內(nèi)存里面有緩存，直接調(diào)用 cb.onResourceReady(cached, DataSource.MEMORY_CACHE) 返回圖片。

private EngineResource<?> loadFromCache(Key key, boolean isMemoryCacheable) {
  if (!isMemoryCacheable) {
    return null;
  }

  EngineResource<?> cached = getEngineResourceFromCache(key);
  if (cached != null) {
    cached.acquire();
    activeResources.put(key, new ResourceWeakReference(key, cached, getReferenceQueue()));
  }
  return cached;
}

private EngineResource<?> loadFromActiveResources(Key key, boolean isMemoryCacheable) {
  if (!isMemoryCacheable) {
    return null;
  }

  EngineResource<?> active = null;
  WeakReference<EngineResource<?>> activeRef = activeResources.get(key);
  if (activeRef != null) {
    active = activeRef.get();
    if (active != null) {
      active.acquire();
    } else {
      activeResources.remove(key);
    }
  }

  return active;
}

通過(guò)對(duì)比上面兩個(gè)方法，區(qū)別如下：

1. loadFromCache 方法通過(guò) getEngineResourceFromCache 查詢(xún)是否有緩存。
2. 如果 getEngineResourceFromCache 有緩存，在返回之前會(huì)加入到 activeResources 中。
3. loadFromActiveResources 查詢(xún) activeResources Map 對(duì)象，如果有緩存則返回。
4. activeResources 中的 value 是一個(gè)若引用。

然后看下 getEngineResourceFromCache 方法

 private EngineResource<?> getEngineResourceFromCache(Key key) {
   Resource<?> cached = cache.remove(key);

   final EngineResource<?> result;
   if (cached == null) {
     result = null;
   } else if (cached instanceof EngineResource) {
     // Save an object allocation if we've cached an EngineResource (the typical case).
     result = (EngineResource<?>) cached;
   } else {
     result = new EngineResource<>(cached, true /*isMemoryCacheable*/);
   }
   return result;
 }

這里發(fā)現(xiàn) cache 是一個(gè) MemoryCache 的實(shí)現(xiàn)類(lèi)，我們要先找到一個(gè)具體的實(shí)現(xiàn)類(lèi)。

我們先查看一下 Engine 的構(gòu)造方法。再 GlideBuilder.build() 方法中

public Glide build(Context context) {
   ……
   
   if (memoryCache == null) {
     memoryCache = new LruResourceCache(memorySizeCalculator.getMemoryCacheSize());
   }

   if (diskCacheFactory == null) {
     diskCacheFactory = new InternalCacheDiskCacheFactory(context);
   }

   if (engine == null) {
     engine =
         new Engine(
             memoryCache,
             ……);
   }

   RequestManagerRetriever requestManagerRetriever = new RequestManagerRetriever(
       requestManagerFactory);

   return new Glide(……);
 }

這里可以看到 memoryCache 是一個(gè) LruCache 的實(shí)現(xiàn)。LruCache算法（Least Recently Used），也叫近期最少使用算法,根據(jù)名字就能看出緩存策略，這里不深入探究。

所以總結(jié)一下內(nèi)存緩存策略(這里總結(jié)的比較簡(jiǎn)單，更詳細(xì)的可以參考陳文超happylion 關(guān)于 glide 三層緩存的調(diào)研)

1. skipMemoryCache(true) 關(guān)聯(lián)到 loadFromCache 和 loadFromActiveResources 方法的控制變量 isMemoryCacheable 。
2. 如果 isMemoryCacheable 為 false，則不檢查緩存。
3. 優(yōu)先從 LruResourceCache 讀取緩存。
4. 如果 LruResourceCache 沒(méi)有，則從 activeResources 緩存中讀取。

以上是使用緩存的方式，下面我們看下如何把圖片寫(xiě)入緩存。Glide 源碼學(xué)習(xí),了解 Glide 圖片加載原理我們已經(jīng)知道 EngineJob.handleResultOnMainThread() 方法是圖片下載成功后，UI 線(xiàn)程執(zhí)行的回調(diào)。

 void handleResultOnMainThread() {
   ……
   engineResource.acquire();
   listener.onEngineJobComplete(key, engineResource);

   for (ResourceCallback cb : cbs) {
     if (!isInIgnoredCallbacks(cb)) {
       engineResource.acquire();
       cb.onResourceReady(engineResource, dataSource);
     }
   }
   // Our request is complete, so we can release the resource.
   engineResource.release();

   release(false /*isRemovedFromQueue*/);
 }

先看 listener.onEngineJobComplete(key, engineResource) 這里 listener 就是 Engine.onEngineJobComplete()

public void onEngineJobComplete(Key key, EngineResource<?> resource) {
    ……
    if (resource.isCacheable()) {
      activeResources.put(key, new ResourceWeakReference(key, resource, getReferenceQueue()));
    }
    ……
}

這里會(huì)把返回的圖片寫(xiě)入 activeResources 。

然后再看 engineResource.release()

 void release() {
   ……
   if (--acquired == 0) {
     listener.onResourceReleased(key, this);
   }
 }

這里的 listener.onResourceReleased() 就是 Engine.listener.onResourceReleased()

 public void onResourceReleased(Key cacheKey, EngineResource resource) {
   Util.assertMainThread();
   activeResources.remove(cacheKey);
   if (resource.isCacheable()) {
     cache.put(cacheKey, resource);
   } else {
     resourceRecycler.recycle(resource);
   }
 }

總結(jié)一下流程圖

glide_cache_01.png

磁盤(pán)緩存

磁盤(pán)緩存和網(wǎng)絡(luò)請(qǐng)求一樣，都是耗時(shí)操作。所以磁盤(pán)緩存的邏輯從 DecodeJob.run() 方法開(kāi)始找。

run() -> runWrapped() -> getNextStage()

 private Stage getNextStage(Stage current) {
   switch (current) {
     case INITIALIZE:
       return diskCacheStrategy.decodeCachedResource()
           ? Stage.RESOURCE_CACHE : getNextStage(Stage.RESOURCE_CACHE);
     case RESOURCE_CACHE:
       return diskCacheStrategy.decodeCachedData()
           ? Stage.DATA_CACHE : getNextStage(Stage.DATA_CACHE);
     case DATA_CACHE:
       // Skip loading from source if the user opted to only retrieve the resource from cache.
       return onlyRetrieveFromCache ? Stage.FINISHED : Stage.SOURCE;
     case SOURCE:
     case FINISHED:
       return Stage.FINISHED;
     default:
       throw new IllegalArgumentException("Unrecognized stage: " + current);
   }
 }

這里我們不難知道返回的 Stage 和 diskCacheStrategy 有關(guān)。這里的 diskCacheStrategy 就是我們?cè)O(shè)置的 ImgurGlide.with().load().diskCacheStrategy(diskCacheStrategy).into()

DiskCacheStrategy 提供了集中內(nèi)置對(duì)象

DiskCacheStrategy.ALL
DiskCacheStrategy.NONE
DiskCacheStrategy.DATA
DiskCacheStrategy.RESOURCE
DiskCacheStrategy.AUTOMATIC

這幾種對(duì)象都是 DiskCacheStrategy 的實(shí)現(xiàn)類(lèi)，有興趣的可以去研究一下。

getNextStage() 方法可以看出優(yōu)先檢查是否是 ResourceCache 然后再檢查是不是 DataCache。

然后執(zhí)行 getNextGenerator()

 private DataFetcherGenerator getNextGenerator() {
   switch (stage) {
     case RESOURCE_CACHE:
       return new ResourceCacheGenerator(decodeHelper, this);
     case DATA_CACHE:
       return new DataCacheGenerator(decodeHelper, this);
     case SOURCE:
       return new SourceGenerator(decodeHelper, this);
     case FINISHED:
       return null;
     default:
       throw new IllegalStateException("Unrecognized stage: " + stage);
   }
 }

這里會(huì)返回三種 DataFetcherGenerator ，其中 SourceGenerator 我們已經(jīng)在Glide 源碼學(xué)習(xí),了解 Glide 圖片加載原理中介紹過(guò)。SourceGenerator 是直接使用網(wǎng)絡(luò)加載圖片。

我們這里選擇一個(gè) DataCacheGenerator 分析

 public boolean startNext() {
   while (modelLoaders == null || !hasNextModelLoader()) {
     sourceIdIndex++;
     if (sourceIdIndex >= cacheKeys.size()) {
       return false;
     }

     Key sourceId = cacheKeys.get(sourceIdIndex);
     Key originalKey = new DataCacheKey(sourceId, helper.getSignature());
     cacheFile = helper.getDiskCache().get(originalKey);
     if (cacheFile != null) {
       this.sourceKey = sourceId;
       modelLoaders = helper.getModelLoaders(cacheFile);
       modelLoaderIndex = 0;
     }
   }

   loadData = null;
   boolean started = false;
   while (!started && hasNextModelLoader()) {
     ModelLoader<File, ?> modelLoader = modelLoaders.get(modelLoaderIndex++);
     loadData =
         modelLoader.buildLoadData(cacheFile, helper.getWidth(), helper.getHeight(),
             helper.getOptions());
     if (loadData != null && helper.hasLoadPath(loadData.fetcher.getDataClass())) {
       started = true;
       loadData.fetcher.loadData(helper.getPriority(), this);
     }
   }
   return started;
 }

和分析 SourceGenerator 類(lèi)似，是通過(guò)一系列 ModelLoader 然后通過(guò) loadData.fetcher.loadData(helper.getPriority(), this) 執(zhí)行任務(wù)。

這里的 ModelLoader 處理 File 類(lèi)型的有四種

ByteBufferFileLoader.Factory()
FileLoader.StreamFactory()
FileDecoder()
FileLoaderFileLoader.FileDescriptorFactory()

然后查看每個(gè)類(lèi)的 buildLoadData() 方法創(chuàng)建 LoadData 時(shí)，傳入的 DataFetcher。
發(fā)現(xiàn) DataFetcher.loadData() 方法都是讀取文件或者把文件轉(zhuǎn)成 InputStream 。

如果 startNext() 方法返回 false，表示緩存加載失敗

private void runGenerators() {
  ……
  while (!isCancelled && currentGenerator != null
      && !(isStarted = currentGenerator.startNext())) {
    stage = getNextStage(stage);
    currentGenerator = getNextGenerator();

    if (stage == Stage.SOURCE) {
      reschedule();
      return;
    }
  }
  ……
}

可以看到如果 startNext() 返回失敗，則會(huì)把 state 對(duì)象改為 Stage.SOURCE 然后去網(wǎng)絡(luò)下載圖片。

ResourceCacheGenerator 和 DataCacheGenerator 的區(qū)別也是在 startNext() 方法中，ResourceCache 可以對(duì) decode 只有的資源檢查，看有沒(méi)有緩存，而 DataCacheGenerator 只檢查 decode 之前的資源有沒(méi)有緩存。

因?yàn)橘Y源在 decode 以后可能剛好滿(mǎn)足我們需要的圖片，
所以 ResourceCacheGenerator 的 DataCacheGenerator 差異就在這。

磁盤(pán)緩存在圖片下載以后會(huì)在如果需要緩存 SourceGenerator 會(huì)再次執(zhí)行 startNext()

 public void onDataReady(Object data) {
   DiskCacheStrategy diskCacheStrategy = helper.getDiskCacheStrategy();
   if (data != null && diskCacheStrategy.isDataCacheable(loadData.fetcher.getDataSource())) {
     dataToCache = data;
     //再次執(zhí)行一次 SourceGenerator.startNext() 

     cb.reschedule();
   }……
 }

然后在 startNext() 中執(zhí)行 cacheData()

 public boolean startNext() {
   if (dataToCache != null) {
     Object data = dataToCache;
     dataToCache = null;
     cacheData(data);
   }

   ……
 }

在 cacheData() 中調(diào)用 DiskCache 進(jìn)行文件存儲(chǔ)。

 private void cacheData(Object dataToCache) {
   long startTime = LogTime.getLogTime();
   try {
     Encoder<Object> encoder = helper.getSourceEncoder(dataToCache);
     DataCacheWriter<Object> writer =
         new DataCacheWriter<>(encoder, dataToCache, helper.getOptions());
     originalKey = new DataCacheKey(loadData.sourceKey, helper.getSignature());
     helper.getDiskCache().put(originalKey, writer);
     if (Log.isLoggable(TAG, Log.VERBOSE)) {
       Log.v(TAG, "Finished encoding source to cache"
           + ", key: " + originalKey
           + ", data: " + dataToCache
           + ", encoder: " + encoder
           + ", duration: " + LogTime.getElapsedMillis(startTime));
     }
   } finally {
     loadData.fetcher.cleanup();
   }

   sourceCacheGenerator =
       new DataCacheGenerator(Collections.singletonList(loadData.sourceKey), helper, this);
 }

最后總結(jié)一下時(shí)序圖

glide_cache_02.png