Android源码分析:手把手带你分析 Glide的缓存功能

前言

  • Glide,该功能非常强大 Android 图片加载开源框架 相信大家并不陌生
    Github截图

  • 正由于他的功能强大,所以它的源码非常复杂,这导致很多人望而却步

  • 本人尝试将 Glide 的功能进行分解,并单独针对每个功能进行源码分析,从而降低Glide源码的复杂度。

接下来,我将推出一系列关于 Glide的功能源码分析,有兴趣可以继续关注

  • 今天,我将主要针对**Glide的图片缓存功能** 进行流程 & 源码分析 ,希望你们会喜欢。
  1. 由于文章较长,希望读者先收藏 & 预留足够时间进行查看
  2. 请先阅读文章:
    Android源码分析:这是一份详细的图片加载库Glide源码讲解攻略
    Android图片加载库:最全面解析Glide用法

目录

Android源码分析:手把手带你分析 Glide的缓存功能_第1张图片


1. Glide缓存机制简介

1.1 缓存的图片资源

Glide 需要缓存的 图片资源 分为两类:

  • 原始图片(Source) :即图片源的图片初始大小 & 分辨率
  • 转换后的图片(Result) :经过 尺寸缩放 和 大小压缩等处理后的图片

当使用 Glide加载图片时,Glide默认 根据 View视图对图片进行压缩 & 转换,而不显示原始图(这也是Glide加载速度高于Picasso的原因)

1.2 缓存机制设计

  • Glide的缓存功能设计成 二级缓存:内存缓存 & 硬盘缓存

并不是三级缓存,因为 从网络加载 不属于缓存

  • 缓存读取顺序:内存缓存 --> 磁盘缓存 --> 网络
  1. 内存缓存 默认开启
  2. Glide中,内存缓存 & 磁盘缓存相互不影响,独立配置
  • 二级缓存的作用不同:
    1. 内存缓存:防止应用 重复将图片数据 读取到内存当中

    只 缓存转换过后的图片

    1. 硬盘缓存:防止应用 重复从网络或其他地方重复下载和读取数据

    可缓存原始图片 & 缓存转换过后的图片,用户自行设置

Glide的缓存机制使得 Glide具备非常好的图片缓存效果,从而使得具备较高的图片加载效率。

如,在 RecyclerView 上下滑动,而RecyclerView中只要是Glide加载过的图片,都可以直接从内存中读取 & 展示,从而不需要重复从 网络或硬盘上读取,提高图片加载效率。


2. Glide 缓存功能介绍

  • Glide 的缓存功能分为:内存缓存 & 磁盘缓存
  • 具体介绍如下

2.1 内存缓存

  • 作用:防止应用 重复将图片数据 读取到内存当中

只 缓存转换过后的图片,而并非原始图片

  • 具体使用
    默认情况下,Glide自动开启 内存缓存
// 默认开启内存缓存,用户不需要作任何设置
Glide.with(this)
     .load(url)
     .into(imageView);

// 可通过 API 禁用 内存缓存功能
Glide.with(this)
     .load(url)
     .skipMemoryCache(true) // 禁用 内存缓存
     .into(imageView);
  • 实现原理
    Glide的内存缓存实现是基于:LruCache 算法(Least Recently Used) & 弱引用机制
  1. LruCache算法原理:将 最近使用的对象 用强引用的方式 存储在LinkedHashMap中 ;当缓存满时 ,将最近最少使用的对象从内存中移除
  2. 弱引用:弱引用的对象具备更短生命周期,因为 **当JVM进行垃圾回收时,一旦发现弱引用对象,都会进行回收(无论内存充足否)

2.2 磁盘缓存

  • 作用:防止应用 重复从网络或其他地方重复下载和读取数据

可缓存原始图片 & 缓存转换过后的图片,用户自行设置

  • 具体使用

Glide.with(this)
     .load(url)
     .diskCacheStrategy(DiskCacheStrategy.NONE)
     .into(imageView);

// 缓存参数说明
// DiskCacheStrategy.NONE:不缓存任何图片,即禁用磁盘缓存
// DiskCacheStrategy.ALL :缓存原始图片 & 转换后的图片
// DiskCacheStrategy.SOURCE:只缓存原始图片(原来的全分辨率的图像,即不缓存转换后的图片)
// DiskCacheStrategy.RESULT:(默认)只缓存转换后的图片(即最终的图像:降低分辨率后 / 或者转换后 ,不缓存原始图片

  • 实现原理
    使用Glide 自定义的DiskLruCache算法
  1. 该算法基于 Lru 算法中的DiskLruCache算法,具体应用在磁盘缓存的需求场景中
  2. 该算法被封装到Glide自定义的工具类中(该工具类基于Android 提供的DiskLruCache工具类

3. Glide 缓存流程 解析

  • Glide整个缓存流程 从 加载图片请求 开始,其中过程 有本文最关注的 内存缓存的读取 & 写入、磁盘缓存的读取 & 写入
  • 具体如下

Android源码分析:手把手带你分析 Glide的缓存功能_第2张图片

下面,我将根据 Glide缓存流程中的每个步骤 进行源码分析。


4. 缓存流程 源码分析

步骤1:生成缓存Key

  • Glide 实现内存 & 磁盘缓存 是根据 图片的缓存Key 进行唯一标识

即根据 图片的缓存Key 去缓存区找 对应的缓存图片

  • 生成缓存 Key 的代码发生在Engine类的 load()

该代码在上篇文章Android:这是一份详细的图片加载库Glide源码讲解攻略当中已分析过,只是当时忽略了缓存相关的内容,现在仅贴出缓存相关的代码

public class Engine implements EngineJobListener,
        MemoryCache.ResourceRemovedListener,
        EngineResource.ResourceListener {

    public  LoadStatus load(Key signature, int width, int height, DataFetcher fetcher,
            DataLoadProvider loadProvider, Transformation transformation, ResourceTranscoder transcoder,
            Priority priority, boolean isMemoryCacheable, DiskCacheStrategy diskCacheStrategy, ResourceCallback cb) {
        Util.assertMainThread();
        long startTime = LogTime.getLogTime();

        final String id = fetcher.getId();
        // 获得了一个id字符串,即需加载图片的唯一标识
        // 如,若图片的来源是网络,那么该id = 这张图片的url地址

        EngineKey key = keyFactory.buildKey(id, signature, width, height, loadProvider.getCacheDecoder(),loadProvider.getSourceDecoder(), transformation, loadProvider.getEncoder(),transcoder, loadProvider.getSourceEncoder());
        // Glide的缓存Key生成规则复杂:根据10多个参数生成
        // 将该id 和 signature、width、height等10个参数一起传入到缓存Key的工厂方法里,最终创建出一个EngineKey对象
        // 创建原理:通过重写equals() 和 hashCode(),保证只有传入EngineKey的所有参数都相同情况下才认为是同一个EngineKey对象
        // 该EngineKey 即Glide中图片的缓存Key

        ...
}

至此,Glide的图片缓存 Key 生成完毕。


步骤2:创建缓存对象 LruResourceCache

  • LruResourceCache对象是在创建 Glide 对象时创建的

  • 而 创建 Glide 对象则是在上篇文章 Android:这是一份详细的图片加载库Glide源码讲解攻略讲解 Glide 图片加载功能时 第2步load()loadGeneric() 创建 ModelLoader对象时创建的

  • 请看源码分析

<-- 第2步load()中的loadGeneric()-->
    private  DrawableTypeRequest loadGeneric(Class modelClass) {
        ...

        ModelLoader streamModelLoader = Glide.buildStreamModelLoader(modelClass, context);
        // 创建第1个ModelLoader对象;作用:加载图片
        // Glide会根据load()方法传入不同类型参数,得到不同的ModelLoader对象
        // 此处传入参数是String.class,因此得到的是StreamStringLoader对象(实现了ModelLoader接口)
        // Glide.buildStreamModelLoader()分析 ->>分析1


<--分析1:Glide.buildStreamModelLoader() -->
public class Glide {

    public static  ModelLoader buildModelLoader(Class modelClass, Class resourceClass,
            Context context) {
         if (modelClass == null) {
            if (Log.isLoggable(TAG, Log.DEBUG)) {
                Log.d(TAG, "Unable to load null model, setting placeholder only");
            }
            return null;
        }
        return Glide.get(context).getLoaderFactory().buildModelLoader(modelClass, resourceClass);
        // 创建ModelLoader对象时,调用Glide.get() 创建Glide对象-->分析2
    }

<--分析2:Glide.get() -->
// 作用:采用单例模式创建Glide对象
    public static Glide get(Context context) {

        // 实现单例功能
        if (glide == null) {
            synchronized (Glide.class) {
                if (glide == null) {
                    Context applicationContext = context.getApplicationContext();
                    List modules = new ManifestParser(applicationContext).parse();
                    GlideBuilder builder = new GlideBuilder(applicationContext);
                    for (GlideModule module : modules) {
                        module.applyOptions(applicationContext, builder);
                    }
                    glide = builder.createGlide();
                    // 通过建造者模式创建Glide对象 ->>分析3
                    for (GlideModule module : modules) {
                        module.registerComponents(applicationContext, glide);
                    }
                }
            }
        }
        return glide;
    }
}
       
<--分析3:builder.createGlide() -->
// 作用:创建Glide对象
public class GlideBuilder {
    ...

    Glide createGlide() {
        MemorySizeCalculator calculator = new MemorySizeCalculator(context);
        if (bitmapPool == null) {
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
                int size = calculator.getBitmapPoolSize();
                bitmapPool = new LruBitmapPool(size);
            } else {
                bitmapPool = new BitmapPoolAdapter();
            }
        }

        if (memoryCache == null) {
            memoryCache = new LruResourceCache(calculator.getMemoryCacheSize());
            // 创建一个LruResourceCache对象 并 赋值到memoryCache对象
            // 该LruResourceCache对象 = Glide实现内存缓存的LruCache对象

        }
        
        return new Glide(engine, memoryCache, bitmapPool, context, decodeFormat);
    }
}

至此,创建好了缓存对象LruResourceCache

步骤3:从 内存缓存 中获取缓存图片

  • Glide 在图片加载前就会从 内存缓存 中获取缓存图片
  • 读取内存缓存代码 是在Engine类的load()

即上面讲解的生成缓存 Key 的地方

  • 源码分析
public class Engine implements EngineJobListener,
        MemoryCache.ResourceRemovedListener,
        EngineResource.ResourceListener {
    ...    

    public  LoadStatus load(Key signature, int width, int height, DataFetcher fetcher,
            DataLoadProvider loadProvider, Transformation transformation, ResourceTranscoder transcoder,
            Priority priority, boolean isMemoryCacheable, DiskCacheStrategy diskCacheStrategy, ResourceCallback cb) {
        Util.assertMainThread();

        final String id = fetcher.getId();
        EngineKey key = keyFactory.buildKey(id, signature, width, height, loadProvider.getCacheDecoder(),
                loadProvider.getSourceDecoder(), transformation, loadProvider.getEncoder(),
                transcoder, loadProvider.getSourceEncoder());
         // 上面讲解的生成图片缓存Key


        EngineResource cached = loadFromCache(key, isMemoryCacheable);
        // 调用loadFromCache()获取内存缓存中的缓存图片

        if (cached != null) {
            cb.onResourceReady(cached);
        }
        // 若获取到,就直接调用cb.onResourceReady()进行回调

        EngineResource active = loadFromActiveResources(key, isMemoryCacheable);
        if (active != null) {
            cb.onResourceReady(active);
        }
        // 若没获取到,就继续调用loadFromActiveResources()获取缓存图片
        // 获取到也直接回调

        // 若上述两个方法都没有获取到缓存图片,就开启一个新的线程准备加载图片
        // 即从上文提到的 Glide最基础功能:图片加载
        EngineJob current = jobs.get(key);
            return new LoadStatus(cb, current);
        }

        EngineJob engineJob = engineJobFactory.build(key, isMemoryCacheable);
        DecodeJob decodeJob = new DecodeJob(key, width, height, fetcher, loadProvider, transformation,
                transcoder, diskCacheProvider, diskCacheStrategy, priority);
        EngineRunnable runnable = new EngineRunnable(engineJob, decodeJob, priority);
        jobs.put(key, engineJob);
        engineJob.addCallback(cb);
        engineJob.start(runnable);

        return new LoadStatus(cb, engineJob);
    }

    ...
}

即:

  • Glide 将 内存缓存 划分为两块:一块使用了LruCache算法 机制;另一块使用了弱引用 机制
  • 当 获取 内存缓存 时,会通过两个方法分别从上述两块区域进行缓存获取
  1. loadFromCache():从 使用了 LruCache算法机制的内存缓存获取 缓存
  2. loadFromActiveResources():从 使用了 弱引用机制的内存缓存获取 缓存

源码分析如下:

// 这2个方法属于  Engine 类
public class Engine implements EngineJobListener,
        MemoryCache.ResourceRemovedListener,
        EngineResource.ResourceListener {

    private final MemoryCache cache;
    private final Map>> activeResources;
    ...

<-- 方法1:loadFromCache() -->
// 原理:使用了 LruCache算法
    private EngineResource loadFromCache(Key key, boolean isMemoryCacheable) {
        if (!isMemoryCacheable) {
            return null;
        // 若isMemoryCacheable = false就返回null,即内存缓存被禁用
        // 即 内存缓存是否禁用的API skipMemoryCache() - 请回看内存缓存的具体使用
        // 若设置skipMemoryCache(true),此处的isMemoryCacheable就等于false,最终返回Null,表示内存缓存已被禁用
        }

        EngineResource cached = getEngineResourceFromCache(key);
        // 获取图片缓存 ->>分析4

        // 从分析4回来看这里:
        if (cached != null) {
            cached.acquire();
            activeResources.put(key, new ResourceWeakReference(key, cached, getReferenceQueue()));
            // 将获取到的缓存图片存储到activeResources当中
            // activeResources = 一个弱引用的HashMap:用于缓存正在使用中的图片
            // 好处:保护这些图片不会被LruCache算法回收掉。 ->>方法2

        }
        return cached;
    }

<<- 分析4:getEngineResourceFromCache() ->>
// 作用:获取图片缓存
// 具体过程:根据缓存Key 从cache中 取值 
// 注:此处的cache对象 = 在构建Glide对象时创建的LruResourceCache对象,即说明使用的是LruCache算法
    private EngineResource getEngineResourceFromCache(Key key) {
        Resource cached = cache.remove(key);
        // 当从LruResourceCache中获取到缓存图片后,会将它从缓存中移除->>回到方法1原处
        final EngineResource result;
        if (cached == null) {
            result = null;
        } else if (cached instanceof EngineResource) {
            result = (EngineResource) cached;
        } else {
            result = new EngineResource(cached, true /*isCacheable*/);
        }
        return result;
    }

<-- 方法2:loadFromActiveResources() -->
// 原理:使用了 弱引用机制
// 具体过程:当在方法1中无法获取内存缓存中的缓存图片时,就会从activeResources中取值
// activeResources = 一个弱引用的HashMap:用于缓存正在使用中的图片
    private EngineResource loadFromActiveResources(Key key, boolean isMemoryCacheable) {
        if (!isMemoryCacheable) {
            return null;
        }
        EngineResource active = null;
        WeakReference> activeRef = activeResources.get(key);
        if (activeRef != null) {
            active = activeRef.get();
            if (active != null) {
                active.acquire();
            } else {
                activeResources.remove(key);
            }
        }
        return active;
    }

    ...
}

若上述两个方法都没获取到缓存图片时(即内存缓存里没有该图片的缓存),就开启新线程加载图片。


  • 至此,获取内存缓存 的步骤讲解完毕。
  • 总结

Android源码分析:手把手带你分析 Glide的缓存功能_第3张图片


步骤4:开启 加载图片 线程

  • 若无法从 内存缓存 里 获得缓存的图片,Glide就会开启 加载图片的线程
  • 但在该线程开启后,Glide并不会马上去网络 加载图片,而是采取采用Glide的第2级缓存:磁盘缓存 去获取缓存图片

从 上篇文章Android:这是一份详细的图片加载库Glide源码讲解攻略Glide 在第3步 into()中开启图片线程 run()里的 decode()开始(上文的分析13)

private Resource decode() throws Exception {

// 在执行 加载图片 线程时(即加载图片时),分两种情况:
// 情况1:从磁盘缓存当中读取图片(默认情况下Glide会优先从缓存当中读取,没有才会去网络源读取图片)
// 情况2:不从磁盘缓存中读取图片

// 情况1:从磁盘缓存中读取缓存图片
    if (isDecodingFromCache()) {
    // 取决于在使用API时是否开启,若采用DiskCacheStrategy.NONE,即不缓存任何图片,即禁用磁盘缓存
        return decodeFromCache();
        // 读取磁盘缓存的入口就是这里,此处主要讲解 ->>直接看步骤4的分析9
    } else {

    // 情况2:不从磁盘缓存中读取图片        
    // 即上文讨论的从网络读取图片,此处不作过多描述
        return decodeFromSource();
    }
}

步骤5:从 磁盘缓存 中获取缓存图片

若无法从 内存缓存 里 获得缓存的图片,Glide就会采用第2级缓存:磁盘缓存 去获取缓存图片


<--分析9:decodeFromCache()  -->
private Resource decodeFromCache() throws Exception {
    Resource result = null;

        result = decodeJob.decodeResultFromCache();
        // 获取磁盘缓存时,会先获取 转换过后图片 的缓存
        // 即在使用磁盘缓存时设置的模式,如果设置成DiskCacheStrategy.RESULT 或DiskCacheStrategy.ALL就会有该缓存
        // 下面来分析decodeResultFromCache() ->>分析10

    }
    if (result == null) {
        result = decodeJob.decodeSourceFromCache();
        // 如果获取不到 转换过后图片 的缓存,就获取 原始图片 的缓存
        // 即在使用磁盘缓存时设置的模式,如果设置成DiskCacheStrategy.SOURCE 或DiskCacheStrategy.ALL就会有该缓存
        // 下面来分析decodeSourceFromCache() ->>分析12
    }
    return result;
}


<--分析10:decodeFromCache()  -->
public Resource decodeResultFromCache() throws Exception {
    if (!diskCacheStrategy.cacheResult()) {
        return null;
    }

    Resource transformed = loadFromCache(resultKey);
    // 1. 根据完整的缓存Key(由10个参数共同组成,包括width、height等)获取缓存图片
    // ->>分析11

    Resource result = transcode(transformed);
    return result;
    // 2. 直接将获取到的图片 数据解码 并 返回
    // 因为图片已经转换过了,所以不需要再作处理
    // 回到分析9原处
}


<--分析11:decodeFromCache()  -->
private Resource loadFromCache(Key key) throws IOException {
    File cacheFile = diskCacheProvider.getDiskCache().get(key);

    // 1. 调用getDiskCache()获取Glide自己编写的DiskLruCache工具类实例
    // 2. 调用上述实例的get() 并 传入完整的缓存Key,最终得到硬盘缓存的文件

    if (cacheFile == null) {
        return null;
        // 如果文件为空就返回null
    }
    Resource result = null;
    try {
        result = loadProvider.getCacheDecoder().decode(cacheFile, width, height);
            } finally {
        if (result == null) {
            diskCacheProvider.getDiskCache().delete(key);
        }
    }
    return result;
    // 如果文件不为空,则将它解码成Resource对象后返回
    // 回到分析10原处
}



<--分析12:decodeFromCache()  -->
public Resource decodeSourceFromCache() throws Exception {
    if (!diskCacheStrategy.cacheSource()) {
        return null;
    }

    Resource decoded = loadFromCache(resultKey.getOriginalKey());
    // 1. 根据缓存Key的OriginalKey来获取缓存图片
    // 相比完整的缓存Key,OriginalKey只使用了id和signature两个参数,而忽略了大部分的参数
    // 而signature参数大多数情况下用不到,所以基本是由id(也就是图片url)来决定的Original缓存Key
    // 关于loadFromCache()同分析11,只是传入的缓存Key不一样

    return transformEncodeAndTranscode(decoded);
    // 2. 先将图片数据 转换 再 解码,最终返回
    
}
  • 至此,硬盘缓存读取的源码分析完毕。
  • 总结

示意图


步骤6:从网络获取 图片资源

  • Glide两级缓存机制里都没有该图片缓存时,只能去源头(如网络)去加载图片了
  • 但从网络加载图片前,需要先获取该图片的网络资源
  1. 此处先忽略该过程
  2. 若有兴趣的同学请看文章:Android:这是一份详细的图片加载库Glide源码讲解攻略

步骤7:写入 磁盘缓存

  • Glide将图片写入 磁盘缓存的时机:获取图片资源后 、图片加载完成前
  • 写入磁盘缓存又分为:将原始图片 写入 / 将转换后的图片写入磁盘缓存

从 上篇文章Android:这是一份详细的图片加载库Glide源码讲解攻略中,Glide 在第3步 into()中执行图片线程 run()里的 decode()开始(上文的分析13)
此处重新贴出代码


private Resource decode() throws Exception {

// 在执行 加载图片 线程时(即加载图片时),分两种情况:
// 情况1:从磁盘缓存当中读取图片(默认情况下Glide会优先从缓存当中读取,没有才会去网络源读取图片)
// 情况2:不从磁盘缓存中读取图片

// 情况1:从磁盘缓存中读取缓存图片
    if (isDecodingFromCache()) {
        return decodeFromCache();
        // 读取磁盘缓存的入口就是这里,上面已经讲解
    } else {

    // 情况2:不从磁盘缓存中读取图片
        // 即上文讨论的从网络读取图片,不采用缓存
        // 写入磁盘缓存就是在 此处 写入的 ->>分析13
        return decodeFromSource();
    }
}


<--分析13:decodeFromSource()  -->
public Resource decodeFromSource() throws Exception {
    Resource decoded = decodeSource();
    // 解析图片
    // 写入原始图片 磁盘缓存的入口 ->>分析14

     // 从分析16回来看这里
    return transformEncodeAndTranscode(decoded);
    // 对图片进行转码
    // 写入 转换后图片 磁盘缓存的入口 ->>分析17
}


<--分析14:decodeSource()  -->
private Resource decodeSource() throws Exception {
    Resource decoded = null;
    try {

        final A data = fetcher.loadData(priority);
        // 读取图片数据
        if (isCancelled) {
            return null;
        }
        decoded = decodeFromSourceData(data);
        // 对图片进行解码 ->>分析15
    } finally {
        fetcher.cleanup();
    }
    return decoded;
}

<--分析15:decodeFromSourceData()  -->
private Resource decodeFromSourceData(A data) throws IOException {
    final Resource decoded;
    // 判断是否允许缓存原始图片
    // 即在使用 硬盘缓存API时,是否采用DiskCacheStrategy.ALL 或 DiskCacheStrategy.SOURCE
    if (diskCacheStrategy.cacheSource()) {
        decoded = cacheAndDecodeSourceData(data);
        // 若允许缓存原始图片,则调用cacheAndDecodeSourceData()进行原始图片的缓存 ->>分析16

    } else {
        long startTime = LogTime.getLogTime();
        decoded = loadProvider.getSourceDecoder().decode(data, width, height);
    }
    return decoded;
}

<--分析16:cacheAndDecodeSourceData   -->
private Resource cacheAndDecodeSourceData(A data) throws IOException {
   
    ...
    diskCacheProvider.getDiskCache().put(resultKey.getOriginalKey(), writer);
    // 1. 调用getDiskCache()获取DiskLruCache实例
    // 2. 调用put()写入硬盘缓存
    // 注:原始图片的缓存Key是用的getOriginalKey(),即只有id & signature两个参数
    // 请回到分析13

}

<--分析17:transformEncodeAndTranscode() -->
private Resource transformEncodeAndTranscode(Resource decoded) {
    
    Resource transformed = transform(decoded);
    // 1. 对图片进行转换

    writeTransformedToCache(transformed);
    // 2. 将 转换过后的图片 写入到硬盘缓存中 -->分析18

    Resource result = transcode(transformed);
    return result;
}

<-- 分析18:TransformedToCache() -->
private void writeTransformedToCache(Resource transformed) {
    if (transformed == null || !diskCacheStrategy.cacheResult()) {
        return;
    }

    diskCacheProvider.getDiskCache().put(resultKey, writer);
    // 1. 调用getDiskCache()获取DiskLruCache实例
    // 2. 调用put()写入硬盘缓存
    // 注:转换后图片的缓存Key是用的完整的resultKey,即含10多个参数
}
  • 至此,硬盘缓存的写入分析完毕。
  • 总结

Android源码分析:手把手带你分析 Glide的缓存功能_第4张图片


步骤9:写入 内存缓存

  • Glide 将图片写入 内存缓存的时机:图片加载完成后 、图片显示出来前

  • 写入 内存缓存 的具体地方:上篇文章中Android:这是一份详细的图片加载库Glide源码讲解攻略当图片加载完成后,会在EngineJob中通过Handler发送一条消息将执行逻辑切回到主线程当中,从而执行handleResultOnMainThread()

class EngineJob implements EngineRunnable.EngineRunnableManager {

    private final EngineResourceFactory engineResourceFactory;
    ...

    private void handleResultOnMainThread() {
        ...

        // 关注1:写入 弱引用缓存
        engineResource = engineResourceFactory.build(resource, isCacheable);
        listener.onEngineJobComplete(key, engineResource);

        // 关注2:写入 LruCache算法的缓存
        engineResource.acquire();

        for (ResourceCallback cb : cbs) {
            if (!isInIgnoredCallbacks(cb)) {
                engineResource.acquire();
                cb.onResourceReady(engineResource);
            }
        }
        engineResource.release();
    }

写入 内存缓存分为:写入 弱引用缓存 & LruCache算法的缓存

  1. 内存缓存分为:一块使用了 LruCache算法机制的区域 & 一块使用了 弱引用机制的缓存
  2. 内存缓存只缓存 转换后的图片

关注1:写入 弱引用缓存


class EngineJob implements EngineRunnable.EngineRunnableManager {

    private final EngineResourceFactory engineResourceFactory;
    ...

    private void handleResultOnMainThread() {
        ...

        // 写入 弱引用缓存
        engineResource = engineResourceFactory.build(resource, isCacheable);
        // 创建一个包含图片资源resource的EngineResource对象

        listener.onEngineJobComplete(key, engineResource);
        // 将上述创建的EngineResource对象传入到Engine.onEngineJobComplete() ->>分析6


        // 写入LruCache算法的缓存(先忽略)
        engineResource.acquire();

        for (ResourceCallback cb : cbs) {
            if (!isInIgnoredCallbacks(cb)) {
                engineResource.acquire();
                cb.onResourceReady(engineResource);
            }
        }
        engineResource.release();
    }


<<- 分析6:onEngineJobComplete()() ->>
public class Engine implements EngineJobListener,
        MemoryCache.ResourceRemovedListener,
        EngineResource.ResourceListener {
    ...    

    @Override
    public void onEngineJobComplete(Key key, EngineResource resource) {
        Util.assertMainThread();

        if (resource != null) {
            resource.setResourceListener(key, this);
            if (resource.isCacheable()) {
                activeResources.put(key, new ResourceWeakReference(key, resource, getReferenceQueue()));
                // 将 传进来的EngineResource对象 添加到activeResources()中
                // 即写入了弱引用 内存缓存
            }
        }
        jobs.remove(key);
    }

    ...
}

关注2:写入 LruCache算法 缓存

class EngineJob implements EngineRunnable.EngineRunnableManager {

    private final EngineResourceFactory engineResourceFactory;
    ...

    private void handleResultOnMainThread() {
        ...

        // 写入 弱引用缓存(忽略)
        engineResource = engineResourceFactory.build(resource, isCacheable);
        listener.onEngineJobComplete(key, engineResource);

        // 写入 LruCache算法的缓存
        engineResource.acquire();
        // 标记1

        for (ResourceCallback cb : cbs) {
            if (!isInIgnoredCallbacks(cb)) {
                engineResource.acquire();
                // 标记2
                cb.onResourceReady(engineResource);
            }
        }
        engineResource.release();
        // 标记3
    }

写入 LruCache算法 内存缓存的原理:包含图片资源resourceEngineResource对象的一个引用机制:

  • 用 一个 acquired 变量 记录图片被引用的次数
  • 加载图片时:调用 acquire() ,变量加1

上述代码的标记1、标记2 & 下面acquire()源码

<-- 分析7:acquire() -->
    void acquire() {
        if (isRecycled) {
            throw new IllegalStateException("Cannot acquire a recycled resource");
        }
        if (!Looper.getMainLooper().equals(Looper.myLooper())) {
            throw new IllegalThreadStateException("Must call acquire on the main thread");
        }
        ++acquired;
        // 当调用acquire()时,acquired变量 +1
    }
  • 不加载图片时,调用 release() 时,变量减1

上述代码的标记3 & 下面release()源码

<-- 分析8:release()  -->
    void release() {
        if (acquired <= 0) {
            throw new IllegalStateException("Cannot release a recycled or not yet acquired resource");
        }
        if (!Looper.getMainLooper().equals(Looper.myLooper())) {
            throw new IllegalThreadStateException("Must call release on the main thread");
        }
        if (--acquired == 0) {
            listener.onResourceReleased(key, this);
            // 当调用acquire()时,acquired变量 -1
            // 若acquired变量 = 0,即说明图片已经不再被使用
            // 调用listener.onResourceReleased()释放资源
            // 该listener = Engine对象,Engine.onResourceReleased()->>分析9
        }
    }
}

<-- 分析9:onResourceReleased()  -->

public class Engine implements EngineJobListener,
        MemoryCache.ResourceRemovedListener,
        EngineResource.ResourceListener {

    private final MemoryCache cache;
    private final Map>> activeResources;
    ...    

    @Override
    public void onResourceReleased(Key cacheKey, EngineResource resource) {
        Util.assertMainThread();
        activeResources.remove(cacheKey);
        // 步骤1:将缓存图片从activeResources弱引用缓存中移除

        if (resource.isCacheable()) {
            cache.put(cacheKey, resource);
            // 步骤2:将该图片缓存放在LruResourceCache缓存中
        } else {
            resourceRecycler.recycle(resource);
        }
    }

    ...
}

所以:

  • acquired 变量 >0 时,说明图片正在使用,即该图片缓存继续存放到activeResources弱引用缓存中
  • acquired变量 = 0,即说明图片已经不再被使用,就将该图片的缓存Key从 activeResources弱引用缓存中移除,并存放到LruResourceCache缓存中

至此,实现了:

  • 正在使用中的图片 采用 弱引用 的内存缓存
  • 不在使用中的图片 采用 LruCache算法 的内存缓存

总结

示意图


步骤10:显示图片

  • 在将图片 写入 内存缓存 & 磁盘缓存后,图片最终显示出来
  • 在下次加载时,将通过二级缓存 从而提高图片加载效率

至此,Glide 的图片缓存流程解析完毕。


5. 汇总

  • 用一张图将整个Glide 的图片缓存流程 汇总

Android源码分析:手把手带你分析 Glide的缓存功能_第5张图片

  • 关于内存缓存 的总结

    1. 读取 内存缓存 时,先从LruCache算法机制的内存缓存读取,再从弱引用机制的 内存缓存 读取
    2. 写入 内存缓存 时,先写入 弱引用机制 的内存缓存,等到图片不再被使用时,再写入到 LruCache算法机制的内存缓存
  • 关于磁盘缓存 的总结

    1. 读取 磁盘缓存 时,先读取 转换后图片 的缓存,再读取 原始图片 的缓存

是否读取 取决于 Glide使用API的设置

  1. 写入 磁盘缓存 时,先写入 原始图片 的内存缓存,再写入的内存缓存

是否写入 取决于 Glide使用API的设置


6. 额外注意:为什么你的Glide缓存功能不起作用?

a. 背景

  • Glide实现内存 & 磁盘缓存是根据 图片的缓存Key进行唯一标识
  • 开发者为了降低成本 & 安全,往往会将图片存放在云服务器上

如 七牛云 等等。

  • 为了保护 客户的图片资源,图片云服务器 会在图片Url地址的基础上再加一个token参数
http://url.com/image.jpg?token=a6cvva6b02c670b0a
  • Glide加载该图片时,会使用加了token参数的图片Url地址 作为
    id参数,从而生成 缓存Key

b. 问题

  • 作为身份认证的token参数可能会发生变化,并不是一成不变
  • token参数变了,则图片Url跟着变,则生成缓存key的所需id参数发生变化,即 缓存Key也会跟着变化
  • 这导致同一张图片,但因为token参数变化,而导致缓存Key发生变化,从而使得 Glide的缓存功能失效

缓存Key发生变化,即同一个图片的当前缓存key 和 之前写入缓存的key不相同,这意味着 在读取缓存时 无法根据当前缓存key 找到之前的缓存,从而使得失效

c. 解决方案

具体请看文章:Android 图片加载的那些事:为什么你的Glide 缓存没有起作用?


7. 总结

  • 本文主要对**Glide的图片缓存功能** 进行流程 & 源码分析
  • 下面我将继续对 Glide 的其他功能进行源码分析 ,感兴趣的同学可以继续关注carson_ho的微信公众号
    示意图
    示意图

请帮顶 / 评论点赞!因为你的鼓励是我写作的最大动力!

你可能感兴趣的:(Android源码分析:手把手带你分析 Glide的缓存功能)