关于Glide与OkHttp结合使用的问题

背景

最近使用Glide的过程中发现了一些内存泄漏的问题，经过反复查找，终于大致锁定原因：app跑起来的时候，存在三个OkHttpClient对象实例。

before

总感觉哪里不对，应该只有两个才合理。

一个是普通接口请求使用的OkHttpClient，需要带上各种参数给服务器；

另一个是项目最近使用Webp格式图片，试用期需要做A/B测试，需要在图片请求里增加cookie发给服务器，所以需要单独的OkHttpClient。

而现在出现了三个。

排查过程

经过反复排查，找到了app目录下的build.gradle文件里的这一段

implementation("com.github.bumptech.glide:okhttp3-integration:" + $glideVersion) {
    exclude group: "com.android.support"
}

然后找到我的AppGlideModule类中注册组件方法，有这么 一段：

@Override
public void registerComponents(@NonNull Context context, @NonNull Glide glide, @NonNull Registry registry) {
    ImageCookieJar imageCookieJar = new ImageCookieJar(context);
    mHeaderUaValue = "mValue"
    OkHttpClient client = new OkHttpClient.Builder()
        .cookieJar(imageCookieJar)
        .connectTimeout(TIME_OUT, TimeUnit.MILLISECONDS)
        .writeTimeout(TIME_OUT, TimeUnit.MILLISECONDS)
        .readTimeout(TIME_OUT, TimeUnit.MILLISECONDS)
        .addInterceptor(new Interceptor() {
            @Override
            public Response intercept(@NonNull Chain chain) throws IOException {
                Request request = chain.request().newBuilder()
                    .addHeader(INTERCEPT_HEADER_KEY, INTERCEPT_HEADER_VALUE)
                    .header(HEADER_UA_KEY, mHeaderUaValue)
                    .build();
                return chain.proceed(request);
            }
        }).build();

    OkHttpUrlLoader.Factory factory = new OkHttpUrlLoader.Factory(client);
    registry.replace(GlideUrl.class, InputStream.class, factory);
}

这里创建了一个OkHttpClient实例，用来处理图片请求的。然后我们点进这个OkHttpUrlLoader.Factory类看，发现有个getInternalClient()方法里也会创建一个OkHttpClient实例：

private static Call.Factory getInternalClient() {
  if (internalClient == null) {
    synchronized (Factory.class) {
      if (internalClient == null) {
        internalClient = new OkHttpClient();
      }
    }
  }
  return internalClient;
}

这个方法会在OkHttpUrlLoader.Factory的无参数构造方法中被调用：

/**
 * Constructor for a new Factory that runs requests using a static singleton client.
 */
public Factory() {
  this(getInternalClient());
}

在这个依赖包的目录下，还有一个OkHttpLibraryGlideModule类。

structure

在OkHttpLibraryGlideModule里面的注册组件方法中会调用到这个OkHttpUrlLoader.Factory的默认构造方法，从而创建这个OkHttpClient实例：

@GlideModule
public final class OkHttpLibraryGlideModule extends LibraryGlideModule {
  @Override
  public void registerComponents(@NonNull Context context, @NonNull Glide glide,
      @NonNull Registry registry) {
    registry.replace(GlideUrl.class, InputStream.class, new OkHttpUrlLoader.Factory());
  }
}

细看一下这方法，发现有个@GlideModule注解。

这个@GlideModule注解，就是我们实现Glide的配置类所用的。

也就是说，这类会自动被实例会，自动调用这个类的注册组件方法。这里就产生了一个OkHttpClient实例。

解决方案

那么现在需要把这个不需要的OkHttpClient实例干掉，保留普通接口的OkHttpClient实例和项目需要的OkHttpClient实例就够了。

code

最粗暴的做法就是，把依赖包里OkHttpStreamFetcher和OkHttpUrlLoader类的代码复制出来，作为自己的代码，然后去掉这个依赖。

after

再次打开Android Profiler观察，可以看到就剩两个了。

关于

本文为日常工作记录，技术有限，编写若有错漏，请不吝指出。

我的GitHub：https://github.com/EKwongChum