Glide 初始化

一、Glide

Glide 系列文章基于 V4.9.0 源码。

//在gradle中添加依赖
api "com.github.bumptech.glide:glide:4.9.0"
annotationProcessor "com.github.bumptech.glide:compiler:4.9.0"
//glide内部利用okhttp3
api 'com.github.bumptech.glide:okhttp3-integration:4.9.0'

Glide 核心关联类

二、自定义配置

用户自定义配置类，继承 AppGlideModule，配置 GlideBuilder，注册 Registry。

@GlideModule
public class GlideModuleConfig extends AppGlideModule {
    @Override
    public void applyOptions(Context context, GlideBuilder builder) {
    }
    @Override
    public void registerComponents(Context context, Glide glide, Registry registry) {
        super.registerComponents(context, glide, registry);
    }
    @Override
    public boolean isManifestParsingEnabled() {
        return false;
    }
}

注解 @GlideModule，编译时，注解处理器 (APT) 自动生成 Java 类文件。

Glide 自动生成的类文件

GeneratedAppGlideModuleImpl 类，装饰者模式，框架创造了一套 Wrap 装饰者，包装用户实现的类，即自定义的 AppGlideModule。

实现方法

private final GlideModuleConfig appGlideModule;

GeneratedAppGlideModuleImpl() {
    appGlideModule = new GlideModuleConfig();
}

@Override
public void applyOptions(@NonNull Context context, @NonNull GlideBuilder builder) {
    //自定义配置
    appGlideModule.applyOptions(context, builder);
}

@Override
public void registerComponents(@NonNull Context context, @NonNull Glide glide,
      @NonNull Registry registry) {
    new OkHttpLibraryGlideModule().registerComponents(context, glide, registry);
    appGlideModule.registerComponents(context, glide, registry);
}

OkHttpLibraryGlideModule 替代已 @Deprecated 的 OkHttpGlideModule 类，放弃在 Manifest 清单配置。

AppGlideModule 类关系图

向用户开放
Glide 配置接口，GlideBuilder 配置。
注册接口，Registry 注册。

二、初始化流程

基本流程图

Glide 初始化流程

1，Glide 是单例对象，(可配置)，首次 get() 时，完成初始化，创建单例。

Glide类内部静态私有对象
private static volatile Glide glide

@NonNull
public static Glide get(@NonNull Context context) {
    if (glide == null) {
        synchronized (Glide.class) {
            if (glide == null) {
                //Context是当前使用Glide单例的组件的上下文
                checkAndInitializeGlide(context);//只初始化一次，创建glide对象
            }
        }
    }
    return glide;
}

//checkAndInitializeGlide()方法，调用initializeGlide()方法。

private static void initializeGlide(@NonNull Context context) {
    initializeGlide(context, new GlideBuilder());
}

2，创建一个 GlideBuilder 建造者对象，向用户开放，添加配置。
3，初始化 initializeGlide() 方法。

private static void initializeGlide(@NonNull Context context, @NonNull GlideBuilder builder) {
    //获取全局Context。
    Context applicationContext = context.getApplicationContext();
    //创建GeneratedAppGlideModuleImpl对象。
    GeneratedAppGlideModule annotationGeneratedModule = getAnnotationGeneratedGlideModules();
    List<com.bumptech.glide.module.GlideModule> manifestModules = Collections.emptyList();
    //解析清单开启，来自内部自定义GlideModuleConfig方法。
    if (annotationGeneratedModule == null || annotationGeneratedModule.isManifestParsingEnabled()) {
        manifestModules = new ManifestParser(applicationContext).parse();
    }
    if (annotationGeneratedModule != null
            && !annotationGeneratedModule.getExcludedModuleClasses().isEmpty()) {
        Set<Class<?>> excludedModuleClasses =
                annotationGeneratedModule.getExcludedModuleClasses();
        Iterator<com.bumptech.glide.module.GlideModule> iterator = manifestModules.iterator();
        //过滤掉列表中排除掉的，即excludedModuleClasses中的。
        while (iterator.hasNext()) {
            com.bumptech.glide.module.GlideModule current = iterator.next();
            if (!excludedModuleClasses.contains(current.getClass())) {
                continue;
            }
            iterator.remove();
        }
    }
    //获取RequestManagerFactory工厂。
    RequestManagerRetriever.RequestManagerFactory factory =
            annotationGeneratedModule != null
                    ? annotationGeneratedModule.getRequestManagerFactory() : null;
    builder.setRequestManagerFactory(factory);
    for (com.bumptech.glide.module.GlideModule module : manifestModules) {
        module.applyOptions(applicationContext, builder);
    }
    //用户初始化builder模块，在AppGlideModule的继承类applyOptions方法中实现。
    if (annotationGeneratedModule != null) {
        annotationGeneratedModule.applyOptions(applicationContext, builder);
    }
    //建造者方法创建Glide对象
    Glide glide = builder.build(applicationContext);
    for (com.bumptech.glide.module.GlideModule module : manifestModules) {
        module.registerComponents(applicationContext, glide, glide.registry);
    }
    //用户实现方法
    if (annotationGeneratedModule != null) {
        annotationGeneratedModule.registerComponents(applicationContext, glide, glide.registry);
    }
    applicationContext.registerComponentCallbacks(glide);
    Glide.glide = glide;
}

4，利用反射，创建 GeneratedAppGlideModuleImpl 类实例，固定类全限定名。

Class<GeneratedAppGlideModule> clazz =
          (Class<GeneratedAppGlideModule>)
              Class.forName("com.bumptech.glide.GeneratedAppGlideModuleImpl");

5，创建工厂，GeneratedAppGlideModuleImpl 类的方法。

@Override
@NonNull
GeneratedRequestManagerFactory getRequestManagerFactory() {
    return new GeneratedRequestManagerFactory();
}

6，applyOptions() 方法，将 GlideBuilder 开放给用户，设置自定义配置项。
7，建造者模式，创建 Glide 对象，初始化未设置的对象，构造方法，注册 append() 方法。
8，自定义注册 registerComponents() 方法，可以替代系统注册。向用用户开放Registry，
9，全局 ApplicationContext 注册 ComponentCallbacks，Glide 类实现该接口。

10，isManifestParsingEnabled() 方法在自定义配置类，是否支持解析 Manifest 清单。
创建一个 GlideModule 类列表，实现 RegistersComponents 和 AppliesOptions 接口，GlideModule 类已 @Deprecated。

public List<GlideModule> parse() {
    List<GlideModule> modules = new ArrayList<>();
    try {
        ApplicationInfo appInfo = context.getPackageManager()
                .getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
        for (String key : appInfo.metaData.keySet()) {
            if (GLIDE_MODULE_VALUE.equals(appInfo.metaData.get(key))) {
                modules.add(parseModule(key));
            }
        }
    } catch (PackageManager.NameNotFoundException e) {
    }
    return modules;
}

来自 ManifestParser 对象的解析，从 ApplicationInfo 类的 metaData ( Bundle 类型)中，根据 key 全限定名字符串，反射创建 GlideModule。
默认一项 key 是 OkHttpGlideModule，在 okhttp3-integration 库，Glide 默认使用 okhttp3 的网络请求。

<application>
    <meta-data
        android:name="com.bumptech.glide.integration.okhttp3.OkHttpGlideModule"
        android:value="GlideModule"/>
</application>

Glide 源码 integration 目录 okhttp3 的 AndroidManifest 文件定义 meta-data。

OkHttpGlideModule 类已 @Deprecated，OkHttpLibraryGlideModule 替代，正常流程下，通过 GeneratedAppGlideModuleImpl 类注册。

任重而道远