Glide 源码分析解读-基于最新版Glide 4.9.0

96
张可_
2.7 2019.03.20 22:52* 字数 5607

项目编译


项目基于最新版 Glide 4.9.0 源码分析,通过如下方式获取并编译代码:

git clone https://github.com/bumptech/glide.git
cd glide
./gradlew jar

代码量(使用 cloc 统计):

代码量

这么多的代码,直接看肯定让人头疼,理不清头绪,但好在 Glide 分包结构明确,我们可以先根据不同的模块来逐个击破。

我在分析 Glide 源码前将 Glide 的项目 clone 到了本地,阅读时添加了很多注释以及自己的理解等等,现在已经推到了 Github 上,有兴趣的同学可以看看:
https://github.com/0xZhangKe/Glide-note

总览


有一点需要说明的是,Glide 源码很复杂, 涉及到的东西也很多,这里不能面面俱到,只是把我认为重要的东西介绍了一下,可能还有一些疏漏。

首先我将 Glide 分成了几个模块,让大家有个整体的印象,自顶向下的分析源码,从而实现降维打击。

按照逻辑功能划分,可以把 Glide 框架大概的分成如下几个部分:


模块划分

Glide 大体上可以分为如上几个模块。

下面通过一个常用案例来分析整个流程。
一般来说,我们使用如下代码加载一张网络图片:

Glide.with(this)
        .load(url)
        .into(imgView);

假设这是我们的 APP 第一次使用 Glide 加载一张图片,那么流程如下:


加载流程

上面的流程是简化版,省去了一部分东西,可以通过这张图更直观的了解到 Glide 的加载流程以及机制。
看到上面这个流程图大家先别慌,下面我来慢慢介绍。

模块介绍


根据模块学习事半功倍,先看看 Glide 的分包结构:

包结构

我在分析 Glide 源码前将 Glide 的项目 clone 到了本地,阅读时添加了很多注释以及自己的理解等等,现在已经推到了 Github 上,有兴趣的同学可以看看:
https://github.com/0xZhangKe/Glide-note

先看看最外层的几个类。

Glide


Glide 是单例类,通过 Glide#get(Context) 方法可以获取到实例。

Glide 类算是个全局的配置类,Encoder、Decoder、ModelLoader、Pool 等等都在这里设置,此外还提供了创建 RequestManager 的接口(Glide#with() 方法)。

使用 Glide 时会最先调用 Glide#with() 方法创建 RequestManager,Glide 中的 with() 方法有五个重载:

RequestManager with(Context context)
RequestManager with(android.app.Activity)
RequestManager with(android.app.Fragment)
RequestManager with(android.support.v4.app.Fragment)
RequestManager with(android.support.v4.app.FragmentActivity)

Glide#with() 方法会将 RequestManager 的创建委托给 RequestManagerRetriever,RequestManagerRetriever 为单例类,调用 get(Context) 创建 RequestManager。

GlideBuilder


GlideBuilder 是用来创建 Glide 实例的类,其中包含了很多个 get/set 方法,例如设置 BitmapPool、MemoryCache、ArrayPool 等等,最终通过这些设置调用 build 方法构建 Glide,可以截取 build 方法中的一段代码来看一下:

if (bitmapPool == null) {
    //创建 Bitmap 池
    int size = memorySizeCalculator.getBitmapPoolSize();
    if (size > 0) {
        bitmapPool = new LruBitmapPool(size);
    } else {
        bitmapPool = new BitmapPoolAdapter();
    }
}
​
//创建数组池
if (arrayPool == null) {
    arrayPool = new LruArrayPool(memorySizeCalculator.getArrayPoolSizeInBytes());
}
​
//创建内存缓存
if (memoryCache == null) {
    memoryCache = new LruResourceCache(memorySizeCalculator.getMemoryCacheSize());
}
​
//创建磁盘缓存
if (diskCacheFactory == null) {
    diskCacheFactory = new InternalCacheDiskCacheFactory(context);
}

上面截取的几行代码很具有代表性,这些数组池、缓存实现等等最终都会当做 Glide 构造器的参数创建 Glide 实例。

RequestManagerRetriever


上面说的 5 个重载的 Glide#with() 方法对应 RequestManagerRetriever 中的 5 个重载的 get() 方法。
由于这个比较重要,而且跟我们使用息息相关,所以仔细的说一下~

创建 RequestManager 逻辑如下:

  1. 如果 with 方法的参数为 Activity 或者 Fragment ,则最终调用 RequestManagerRetriever 中的 fragmentGet(Context, android.app.FragmentManager) 方法创建 RequestManager;
  2. 如果 with 方法的参数为 android.support.v4.app.Fragment 或者android.support.v4.app.FragmentActivity,则最终调用 supportFragmentGet(Context, android.support.v4.app.FragmentManager) 方法创建 RequestManager;
  3. 如果 with 方法的参数为 Context,则会判断其来源是否属于 FragmentActivity 及 Activity,是则按照上面的逻辑进行处理,否则最终调用 getApplicationManager(Context) 方法创建 RequestManager。

上面说的情况有个条件都是在主线程调用 Glide#with() 方法, 如果子线程调用 Glide#with() 或者系统版本小于 17,则最终会调用 getApplicationManager(Context) 方法创建 RequestManager 。

也就是说,无论使用什么参数,最终都会进入如下三个方法创建 RequestManager:

RequestManager fragmentGet(Context context, android.app.FragmentManager fm);
RequestManager supportFragmentGet(Context context, android.support.v4.app.FragmentManager fm);
RequestManager getApplicationManager(Context context);

可以看到这三个方法作用都是用来创建 RequestManager,前两个方法主要是用来兼容 support 包中的 FragmentActivity、Fragment。

至于为什么需要传入一个 FragmentManager 参数留在后面说。

此外还有一种情况,即在子线程调用 Glide#with() 方法或传入 Context 对象为 ApplicationContext,此时会创建一个全局唯一的 RequestManager,生命周期与 APP 周期保持一致。

根据上述规则可以得出以下几个结论:

  1. 同一个 Activity 对应一个 FragmentManager,一个 FragmentManager 对应一个 RequestManagerFragment,一个 RequestManagerFragment 对应一个 RequestManager,所以一个 Activity 对应 一个 RequestManager
  2. 同一个 Fragment 同样可得出上述结论;
  3. 但如果 Fragment 属于 Activity,或者 Fragment 属于 Fragment,在 Activity、Framgnent 中分别创建 Glide 请求是并不会只创建一个 RequestManager;
  4. 子线程发起 Glide 请求或传入对象为 ApplicationContext,则使用全局单例的 RequestManager。

RequestManager


RequestManager 主要由两个作用:

  1. 创建 RequestBuilder ;
  2. 通过生命周期管理请求的启动结束等。

我们都知道使用 Glide 加载图片时,如果当前页面被销毁或者不可见时会停止加载图片,但我们使用 Glide 加载图片时并没有显示的去设置 Glide 与当前页面的生命周期关联起来,只是传了个 Context 对象,那么 Glide 是如何通过一个上下文对象就能获取到页面生命周期的呢?

通过上面 RequestManagerRetriever 章节的介绍我们知道创建 RequestManager 时需要一个 FragmentManager 参数(全局 RequestManager 除外),那么再创建 RequestManager 时会先创建一个不可见的 Fragment ,通过 FM 加入到当前页面,用这个不可见的 Fragment 即可检测页面的生命周期。代码中保证了每个 Activity/Fragment 中只包含一个 RequestManagerFragment 与 一个 RequestManager。

创建 RequestBuilder 的 load 方法有很多:

RequestBuilder<Drawable> load(@Nullable Bitmap bitmap);
RequestBuilder<Drawable> load(@Nullable Drawable drawable);
RequestBuilder<Drawable> load(@Nullable String string);
RequestBuilder<Drawable> load(@Nullable Uri uri);
RequestBuilder<Drawable> load(@Nullable File file);
RequestBuilder<Drawable> load(@RawRes @DrawableRes @Nullable Integer resourceId);
RequestBuilder<Drawable> load(@Nullable URL url);
RequestBuilder<Drawable> load(@Nullable byte[] model);
RequestBuilder<Drawable> load(@Nullable Object model);

看看有这么多重载方法,没一个都代表不同的加载源。
除此之外还有两个特殊的方法:

RequestBuilder<File> downloadOnly();
RequestBuilder<File> download(@Nullable Object model);

这两个听名字就知道是用来下载图片的。

RequestBuilder


RequestBuilder 用来构建请求,例如设置 RequestOption、缩略图、加载失败占位图等等。
上面说到的 RequestManager 中诸多的 load 重载方法,同样也对应 RequestBuilder 中的重载 load 方法,一般来说 load 方法之后就是调用 into 方法设置 ImageView 或者 Target,into 方法中最后会创建 Request,并启动,这个后面会详细介绍。

Request


顾名思义, request 包下面的是封装的请求,里面有一个 Request 接口,估计所有的请求都是基于这个接口的,看一下:


Request

接口定义了对请求的开始、结束、状态获取、回收等操作,所以请求中不仅包含基本的信息,还负责管理请求。
Request 主要的实现类有三个:

  1. SingleRequest
  2. ThumbnailRequestCoordinator
  3. ErrorRequestCoordinator

一个个看。

SingleRequest


这个类负责执行请求并将结果反映到 Target 上。
当我们使用 Glide 加载图片时,会先根据 Target 类型创建不同的 Target,然后 RequestBuilder 将这个 target 当做参数创建 Request 对象,Request 与 Target 就是这样关联起来的。

这里就会先创建一个包含 Target 的 SingleRequest 对象。考虑到性能问题,可能会连续创建很多个 SingleRequest 对象,所以使用了对象池来做缓存。
再来说说 SingleRequest 的请求发起流程。

我们经常在 Activity#onCreate 方法中直接使用 Glide 方法,但此时的图片大小还未确定,所以调用 Request#begin 时并不会直接发起请求,而是等待 ImageView 初始化完成,对于 ViewTarget 以及其子类来说,会注册View 的 OnPreDrawListener 事件,等待 View 初始化完成后就调用 SingleRequest#onSizeReady 方法,这个方法里就会开始加载图片了。

onSizeReady 方法并不会去直接加载图片,而是调用了 Engine#load 方法加载,这个方法差不多有二十个参数,所以 onSizeReady 方法算是用来构建参数列表并且调用 Engine#load 方法的。

clear 方法用于停止并清除请求,主要就是从 Engine 中移除掉这个任务以及回调接口。
另外,SingleRequest 实现了 ResourceCallback 接口,这个接口就连个方法:

void onResourceReady(Resource<?> resource, DataSource dataSource);
void onLoadFailed(GlideException e);

即资源加载完成和加载失败的两个回调方法,刚刚说的 Engine#load 方法中有差不多二十个参数,其中有一个参数就是这个接口。那再来说这两个方法在 SingleRequest 中的实现。
其实很简单,重点就是调用 Target#onResourceReady 方法以及构建图片加载完成的动画,另外还要通知 ThumbnailRequestCoordinator 图片加载完成。
onLoadFailed 方法流程大体上也类似 onResourceReady。
那 SingleRequest 就差不多这样了。

ThumbnailRequestCoordinator


这个类是用来协调两个请求,因为有的请求需要同时加载原图和缩略图,比如启动这两个请求、原图加载完成后缩略图其实就不需要加载了等等,这些控制都由这个类来操作。
RequestBuilder 中会将缩略图和原图的两个 SingleRequest 都交给它,后面再对其操作时都由这个类来同一控制。
所以这个类其实没什么太多的功能,就是对两个对象的一个统一个管理协调包装。

ErrorRequestCoordinator


RequestBuilder 的父类 BaseRequestOptions 中有几个 error 的重载方法:

T error(@Nullable Drawable drawable);
T error(@DrawableRes int resourceId);

一般地,我们会使用这个方法设置一个加载失败时的填充图,大部分情况下都是一个通过 resource 资源文件中获取到的图片 ID 或者 Drawable。
但 RequestBuilder 中还提供了另一个 error 方法:

RequestBuilder<TranscodeType> error(@Nullable RequestBuilder<TranscodeType> errorBuilder);

考虑这样的一个场景,当我们加载失败时我可能希望继续去通过网络或者别的什么加载另一张图片,例如:

Glide.with(context)
    .load((Object) null)
    .error(
        Glide.with(context)
            .load(errorModel)
            .listener(requestListener))
    .submit();

当我们这样使用 error 时最终就会创建一个 ErrorRequestCoordinator 对象,这个类的功能类似 ThumbnailRequestCoordinator,其中也没多少代码,主要用来协调 ThumbnailRequestCoordinator 以及 error 中的 Request。

通过上面的介绍就已经对 Request 的作用以及子类有一定的了解了,上面多次提到过 Target 是另一个很重要的概念,下面接着看一下这个类。

Target


Target 代表一个可被 Glide 加载并且具有生命周期的资源
当我们调用 RequestBuilder#into 方法时会根据传入参数创建对应类型的 Target 实现类。

那么 Target 在 Glide 的整个加载流程中到底扮演者什么样的角色呢?Target 的中文意思为:目标,实际上就是指加载完成后的图片应该放在哪, Target 默认提供了很多很有用的实现类,当然我们也可以自定义 Target。

Glide 默认提供了用于放在 ImageView 上的 ImageViewTarget(以及其各种子类)、放在 AppWidget 上的 AppWidgetTarget、用于同步加载图片的 FutureTarget(只有一个实现类:RequestFutureTarget)等等,下面分别来看一下。

CustomViewTarget


这个是抽象类,负责加载 Bitmap、Drawable 并且放到 View 上。

上文提到过,如果在 View 还未初始化完成时就调用了 Glide 加载图片会等待加载完成再去执行 onSizeReady 方法,那如何监听 View 初始化完成呢?
CustomViewTarget 就针对这个问题给出了解决方案,其中会调用 View#addOnAttachStateChangeListener 方法添加一个监听器,这个监听器可以监听到 View 被添加到 Widow 以及移除 Window 时的事件,从而更好的管理 Request 生命周期。

另外,构建好的 Request 会通过 View#setTag 方法存入 View 中,后面再通过 View#getTag 方法获取。

但这个抽象类并没有实现类,也没有被使用过,View 相关的 Target 都是继承 ViewTarget 抽象基类,但这个类已经被标记为过期类了,推荐将 ViewTarget 替换成 CustomViewTarget 使用。

ViewTarget


这个类又继承了抽象类 BaseTarget,这个基类里只是实现了 Target 接口的 setRequest 以及 getRequest 方法。
ViewTarget 基本上类似 CustomViewTarget ,只是具体的实现上有点不同。

ImageViewTarget


听名字就知道,这是加载到 ImageView 上的 Target,继承了 ViewTarget,同样也是个抽象类

构造器中限定了必须传入 ImageView 或者其子类,图片数据加载完成后会回调其中的 onResourceReady 方法,第一步是将图片设置给 ImageView,第二部是判断是否需要使用动画,需要的话就执行动画。

ImageViewTarget 的实现类比较多,总共有 5 个,但内容都很简单,主要用于区分加载的资源时 Bitmap 类型还是 Drawable 类型,这个在构建请求时确定,默认的加载请求最终都是 Drawable 类型,但如果构建请求时调用了 asBitmap 方法那就资源就会被转成 Bitmap 类型,另外一个就是资源使用缩略图展示。

RequestFutureTarget


这是用来同步加载图片的 Target,调用 RequestBuilder#submit 将会返回一个 FutureTarget,调用 get 方法即可获取到加载的资源对象。

AppWidgetTarget


用于将下载的 Bitmap 设置到 RemoteView 上。

NotificationTarget


与 AppWidgetTarget 类似,不同的是这是用来将 Bitmap 设置到 Notification 中的 RemoteView 上。

module


module 包下面的 GlideModel 比较重要,需要详细说一下。

这是用来延迟设置 Glide 相关参数的,我们可以通过这个接口使 Glide 在初始化时应用我们的设置,因为 Glide 是单例类,通过这个设置可以保证在 Glide 单例类初始时,所有请求发起之前应用到 Glide。

GlideModel 是个接口,所以代码很简单:

@Deprecated
public interface GlideModule extends RegistersComponents, AppliesOptions { }

可以看到该接口被标识已过期,Glide 推荐使用 AppGlideModule 替代,不用管他。

GlideModel 接口本身没有代码内容,但其继承了 RegistersComponents 与 AppliesOptions 接口,先分别看一下这两个接口。

RegistersComponents


这是用来注册 Glide 中一些组件的,这个接口只有一个方法:

void registerComponents(@NonNull Context context, @NonNull Glide glide,
      @NonNull Registry registry);

这个方法中提供了一个 Registry 对象,这是用来管理注册 ModelLoader、Encoder、Decoder 等等,具体可以看看 Registry 提供的公开方法。

例如我们可以在这里注册自己的 ModelLoader,比如我们的网络请求使用的 OkHttp,Glide 默认使用的是HttpURLConnection,我们想改成 OkHttp 就可以在这里设置,具体的使用方式点此查看使用案例。

AppliesOptions


这是用来管理一些 Glide 的参数设置项,同样只有一个方法。

void applyOptions(@NonNull Context context, @NonNull GlideBuilder builder);

这个方法提供了一个 GlideBuilder 参数,这是用来构建 Glide 的,我们可以使用 GlideBuilder 对象提供的公开方法做一些设置,例如设置线程池、设置 BitmapPool/ArrayPoll 等等。

那么说完这两个接口,在回过头来看看 GlideModel ,通过上面的描述已经明白 GlideModel 中两个方法的作用了,再来看看如何使用。

Glide 在实例化时会解析 manifest 文件并从中获取 value 为 GlideModule 的 meta-data 配置信息,我们定义好自己的 GlideModule 之后需要在 manifest 文件中进行配置,配置方式如下:

<meta-data
        android:name="com.zhangke.glide.samples.OkHttpGlideModule"
        android:value="GlideModule"/>

其中 OkHttpGlideModule 必须实现 GlideModel 接口。
具体的配置方式点此查看

此外,Glide 默认提供了很多 ModelLoader,基本上可以满足所有场景的使用。
ModelLoader 的具体作用与机制后面会详细介绍。

load


load

load 包下面是加载资源的核心,里面的东西很多,也很复杂,所以我先把其中两个比较重要的接口介绍完了在介绍别的。

ModelLoader


类路径:

com.bumptech.glide.load.model.ModelLoader

工厂接口,用于将任意复杂的数据模型转换为可由 DataFetcher 用于获取模型所代表的资源的数据的具体数据类型。叫他加载器比较合适,用来加载资源的。

除此之外,还允许将图片按照 ImageView 大小按需加载。防止浪费内存。

Glide 初始化时会注册很多个 ModelLoader ,除了Glide 默认提供的之外还会注册用户在 manifest 中配置的 ModelLoader,也就是上面 GlideModel 章节介绍的内容。

ModelLoader 中有两个方法以及一个内部类:LoadData,下来看看这两个方法:

@Nullable
LoadData<Data> buildLoadData(@NonNull Model model, int width, int height,
                                 @NonNull Options options);
boolean handles(@NonNull Model model);

buildLoadData 方法除了包含 Model 之外还有宽高以及 Option,所以光看参数列表应该能猜到,加载图片时可以根据需要的宽高以及其他设置做到按需加载。
返回的是 LoadData 实例,这个类待会再说。所以这个方法的意义就是通过参数构建一个 LoadData 实例。

handles 方法比较简单,就是用来判断给定模型是不是此加载器可能加载的已识别类型。

至于内部类 LoadData 呢,主要作用就是装了三个东西:

  1. 用于识别资源唯一性的 Key;
  2. 缓存相关的备用 Key 列表
  3. DataFetcher

其中 DataFetcher最重要,为什么说它是最重要的呢,因为加载资源的根源就在这里(找了半天终于找到了),例如发起网络请求等等,都在这个里面。
那既然说到了 DataFetcher 就在说说它。

DataFetcher


类路径:

com.bumptech.glide.load.data.DataFetcher

DataFetcher 也是个接口,其中最重要的一个方法就是 loadData,听名字就很重要是吧:加载数据

内部实现就是通过 HttpUrlConnect 发起网络请求,或者打开一个文件,或者使用 AssetManager 打开一个资源等等。。。

加载完成后通过 DataFetcher$DataCallback 接口回调。

DataCallback 中包含两个方法:

void onDataReady(@Nullable T data);
void onLoadFailed(@NonNull Exception e);

分别代表数据加载成功或者加载失败回调。

Encoder


Encoder 是个接口,在 Glide 中也是个很重要的概念,用来将给定的数据写入持久性存储介质中(文件)。

其中只有一个方法:

public interface Encoder<T> {
  /**
   * Writes the given data to the given output stream and returns True if the write completed
   * successfully and should be committed.
   *
   * @param data The data to write.
   * @param file The File to write the data to.
   * @param options The put of options to apply when encoding.
   */
  boolean encode(@NonNull T data, 
                 @NonNull File file, 
                 @NonNull Options options);
}

比较简单,注释写的很清楚了,就是把 data 存入文件中。

数据加载完成之后会先使用 Encoder 将数据存入本地磁盘缓存文件中。
同样,Encoder 对应的实现类都是在 Glide 初始化时注册进去的。

ResourceDecoder


与 Encoder 对应,数据解码器,用来将原始数据解码成相应的数据类型,针对不同的请求实现类都不同,例如通过网络请求最终获取到的是一个 InputStream,经过 ByteBufferBitmapDecoder 解码后再生成一个 Bitmap。

需要指出的是,这里解码时会根绝 option 以及图片大小(如果有的话)按需加载 Bitmap,防止内存的浪费。

与 Encoder 一样,Glide 初始化时会注册很多个类型的 ResourceDecoder 实现类,图片数据获取到之后会根据不同的类型使用对应的解码器对其解码。

Engine


上面的 Request 中也讲到了 Engine 这个类,可理解为执行引擎,算是整个 Glide 的核心发动机。

Engine 负责管理请求以及活动资源、缓存等。主要关注 load 方法,这个方法主要做了如下几件事:

  1. 通过请求构建 Key;
  2. 从活动资源中获取资源(详见缓存章节),获取到则返回;
  3. 从缓存中获取资源,获取到则直接返回;
  4. 判断当前请求是否正在执行,是则直接返回;
  5. 构建 EngineJob 与 DecodeJob 并执行。

关于缓存相关的都在缓存章节。下面说说 EngineJob 与 DecodeJob。

EngineJob


这个主要用来执行 DecodeJob 以及管理加载完成的回调,各种监听器,没有太多其他的东西。

DecodeJob


负责从缓存或数据源中加载原始数据并通过解码器转换为相应的资源类型(Resource)。DecodeJob 实现了 Runnable 接口,由 EngineJob 将其运行在指定线程池中。

首次加载一张图片资源时,资源加载完成后会先存入到本地缓存文件中,然后再从文件中获取。

上面已经说过,图片的加载最终是通过 DataFetcher 来实现,但是此处并没有直接这么调用,考虑到缓存文件,这里面使用的是 DataFetcherGenerator,其有三个实现类,对应不同的加载方式,这里就不多做介绍了,只需要知道它会根据资源类型去 Glide 中获取已注册的 DataFetcher ,然后通过 DataFetcher#loadData 方法获取原始数据,获取完成后使用 Encoder 将数据存入磁盘缓存文件中,同时使用对应的解码器将原始数据转换为相应的资源文件,这样整个流程就差不多结束了。

结语


至此,Glide 源码分析就结束了,对于像 Glide 这种优秀的源码看一遍能学到很多东西,受益匪浅,而且源码是越看越熟,看得多了,再去看别的框架就很简单,俗话说,阅读一个优秀的框架源码,就好比再跟一个伟大的人谈话。后面我还会继续出一篇关于阅读源码技巧的博客。
另外,缓存模块比较重要复杂,所以又单独写了篇文章,可以看我下一篇博客

如果觉得还不错的话,欢迎关注我的公众号,我会不定期发一些干货~

公众号

也可以加我微信:

个人微信
日记本