深入浅出Glide加载图片调试指南

2023-11-18 10:21:45

Glide是Android平台上最流行的图片加载库之一，凭借其高效的缓存策略和丰富的功能特性受到广大开发者的青睐。与其他图片加载库不同，在Glide加载图片的过程中默认是没有任何log输出的。这样使得加载失败的原因难以调试。到底是网络错误还是图片根本就不存在亦或者解码出错，我们不得而知。当然官方也给出了调试的方法，这篇文章就来介绍下如何调试Glide加载图片，内容主要是对官方wiki的翻译和实践。

Glide加载图片日志开启

Glide加载图片默认不打印任何日志，您可以通过下面的方式来开启Glide的日志打印：

在项目根目录下创建logback.xml文件，代码如下：

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
  <root level="INFO">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

在build.gradle中加入下面这段代码：

debugImplementation 'com.jakewharton.timber:timber:4.7.1'
releaseImplementation 'com.jakewharton.timber:timber-no-op:4.7.1'

在Application中初始化Timber:

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        if (BuildConfig.DEBUG) {
            Timber.plant(Timber.DebugTree())
        } else {
            Timber.plant(TimberNoOpTree())
        }
    }
}

在需要加载图片的地方加入日志打印：

Glide.with(this).load(url).into(imageView)
    .onLoadStarted(Timber::d)
    .onLoadFailed(Timber::e)
    .onLoadCleared(Timber::d)

这样一来，Glide加载图片时就会输出相关的日志信息，便于您排查问题。

常见加载失败问题

在使用Glide加载图片时，您可能会遇到各种各样的加载失败问题。下面是一些常见的加载失败问题以及对应的解决方法：

图片不存在 ：如果您尝试加载一个不存在的图片，Glide会抛出FileNotFoundException异常。您可以通过检查图片URL是否正确来解决此问题。
网络错误 ：如果您尝试加载一个网络图片，但由于网络问题导致加载失败，Glide会抛出IOException异常。您可以检查网络连接是否正常，并重试加载图片。
解码错误 ：如果您尝试加载一个损坏的图片，Glide会抛出OutOfMemoryError异常。您可以尝试使用不同的图片格式或压缩图片来解决此问题。

使用Stetho进行调试

Stetho是一个功能强大的Android调试工具，可以帮助您调试各种问题，包括Glide图片加载问题。要使用Stetho调试Glide，您需要按照以下步骤操作：

debugImplementation 'com.facebook.stetho:stetho:1.5.1'
releaseImplementation 'com.facebook.stetho:stetho-no-op:1.5.1'

在build.gradle中添加如下代码：

apply plugin: 'com.android.application'

在Application中初始化Stetho:

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        if (BuildConfig.DEBUG) {
            Stetho.initializeWithDefaults(this)
        }
    }
}

在浏览器中打开chrome://inspect，即可看到Stetho的调试界面。

在Stetho的调试界面中，您可以查看Glide加载图片的日志信息，并分析加载失败的原因。

使用网络代理进行调试

使用网络代理进行调试也是一种常用的方法。您可以通过网络代理来截取Glide加载图片的请求，并查看请求的详细信息。要使用网络代理进行调试，您需要按照以下步骤操作：

在电脑上安装Charles代理软件。
将手机连接到电脑的同一个Wi-Fi网络。
在手机上设置代理服务器，代理地址为电脑的IP地址，代理端口为Charles的端口号。
打开Charles软件，即可看到Glide加载图片的请求信息。

在Charles软件中，您可以查看Glide加载图片的请求URL、请求头、请求体、响应头、响应体等信息。这些信息可以帮助您分析加载失败的原因。

Glide加载图片内存泄漏

如果您在使用Glide加载图片时遇到内存泄漏问题，Glide提供了一种简单的方法来检测内存泄漏。要检测内存泄漏，您需要按照以下步骤操作：

在项目根目录下创建leakcanary-debug.xml文件，代码如下：

<leakcanary>
  <dumpHeapOnFatalException>true</dumpHeapOnFatalException>
  <dumpHeapOnActivityLeaked>true</dumpHeapOnActivityLeaked>
  <onHeapAnalyzedListener class="com.example.app.LeakCanaryDumpHeapListener" />
</leakcanary>

在项目根目录下创建LeakCanaryDumpHeapListener.java文件，代码如下：

package com.example.app;

import com.squareup.leakcanary.OnHeapAnalyzedListener;
import com.squareup.leakcanary.RefWatcher;

public class LeakCanaryDumpHeapListener implements OnHeapAnalyzedListener {

    @Override
    public void onHeapAnalyzed() {
        RefWatcher refWatcher = LeakCanaryHelper.getRefWatcher(LeakCanaryDumpHeapListener.this);
        refWatcher.dumpLeakSummary();
    }
}

在build.gradle中加入下面这段代码：

debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.8.1'
releaseImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:2.8.1'

在Application中初始化LeakCanary:

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        if (LeakCanary.isInAnalyzerProcess(this)) {
            return;
        }
        LeakCanary.Config config = LeakCanary.config = LeakCanary.config.copy(
            dumpHeapOnFatalException = true,
            dumpHeapOnActivityLeaked = true,
            onHeapAnalyzedListener = LeakCanaryDumpHeapListener()
        )
        LeakCanary.install(this, config)
    }
}