收藏。Dropbox 是如何解决 Android App 的内存泄漏问题的？

LeakCanary 和集成测试

另一种提高自动化的方法是将 LeakCanary 与 CI 测试连接起来。同样，我们有一个代码配方。以下内容来自官方文件：

LeakCanary 提供了一个专门用于在 UI 测试中检测漏洞的构件，它提供了一个运行侦听器，后者会等待测试结束，如果测试成功，它将查找留存的对象，在需要时触发堆转储并执行分析。

注意，LeakCanary 会降低测试速度，因为它每次都会在其侦听的测试结束后转储堆。在我们的例子中，由于我们的选择性测试和分片设置，额外增加的时间可以忽略不计。

最终，就像 CI 上的任何其他构建或测试失败一样，内存泄漏也会被暴露出来，并且漏洞跟踪信息也被记录了下来。

在 CI 上运行 LeakCanary 帮助我们学到了更好的编码模式，特别是涉及到新的库时，在任何代码进入生产环境前。例如，当我们使用 MvRx 测试时，它发现了这个漏洞：

Test failed because application memory leaks were detected: ==================================== HEAP ANALYSIS RESULT ==================================== 4 APPLICATION LEAKS References underlined with “~~~” are likely causes. Learn more at https://squ.re/leaks. 198449 bytes retained by leaking objects Signature: 6bf2ba80511dcb6ab9697257143e3071fca4 ┬───

│ GC Root: System class

│ ├─ com.airbnb.mvrx.mocking.MockableMavericks class

│ Leaking: NO (a class is never leaking)

│ ↓ static MockableMavericks.mockStateHolder

│ ~~~~~~~~~~~~~~~

├─ com.airbnb.mvrx.mocking.MockStateHolder instance

│ Leaking: UNKNOWN

│ ↓ MockStateHolder.delegateInfoMap

│ ~~~~~~~~~~~~~~~

├─ java.util.LinkedHashMap instance

│ Leaking: UNKNOWN

│ ↓ LinkedHashMap.header

│ ~~~~~~

├─ java.util.LinkedHashMap$LinkedEntry instance

│ Leaking: UNKNOWN

│ ↓ LinkedHashMap$LinkedEntry.prv

│ ~~~

├─ java.util.LinkedHashMap$LinkedEntry instance

│ Leaking: UNKNOWN

│ ↓ LinkedHashMap$LinkedEntry.key

│ ~~~

╰→ com.dropbox.product.android.dbapp.photos.ui.view.PhotosFragment instance

Leaking: YES (ObjectWatcher was watching this because com.dropbox.product.android.dbapp.photos.ui.view.PhotosFragment received Fragment#onDestroy() callback and Fragment#mFragmentManager is null)

key = 391c9051-ad2c-4282-9279-d7df13d205c3

watchDurationMillis = 7304

retainedDurationMillis = 2304 198427 bytes retained by leaking objects

Signature: d1c9f9707034dd15604d8f2e63ff3bf3ecb61f8

事实证明，在编写测试时，我们没有正确地清理测试。添加几行代码可以避免泄漏：

@After

fun teardown() {

scenario.close()

val holder = MockableMavericks.mockStateHolder

holder.clearAllMocks()

}

你可能会想：既然这种内存泄漏只发生在测试中，那么修复它真的那么重要吗？好吧，那就看你了！与代码检查一样，泄漏检测可以告诉你什么时候出现了代码气味或糟糕的编码模式。

它可以帮助工程师编写更健壮的代码——在本例中，我们知道了clearAllMocks()。泄漏的严重程度，以及是否必须修复，都是工程师可以做出的决定。

对于我们不想运行泄漏检测的测试，我们编写了一个简单的注解：

@Retention(RetentionPolicy.RUNTIME)

@Target({ElementType.METHOD, ElementType.TYPE})

public @interface SkipLeakDetection {

/**

• The reason why the test should skip leak detection.

*/

String value();

}

我们的类重写了 LeakCanary 的FailOnLeakRunListener()：

override fun skipLeakDetectionReason(description: Description): String? {

return when {

description.getAnnotation(SkipLeakDetection::class.java) != null ->

“is annotated with @SkipLeakDetection”

description.testClass.isAnnotationPresent(SkipLeakDetection::class.java) ->

“class is annotated with @SkipLeakDetection”

else -> null

}

}

单个测试或整个测试类可以使用这个注解跳过泄漏检测。

修复内存泄漏

现在，我们讨论了各种查找和暴露内存泄漏的方法。下面，我们讨论一下如何真正理解和修复它们。

LeakCanary 提供的泄漏跟踪是诊断泄漏最有用的工具。本质上讲，泄漏跟踪打印出与泄漏对象关联的引用链，并解释为什么将其视为泄漏。

关于如何阅读和使用泄漏跟踪，LeakCanary 有了很好的 文档，这里无需重复。取而代之，让我们回顾一下我自己经常要处理的两类内存泄漏。

视图

我们经常看到视图被声明为类级变量：private TextView myTextView；或者，现在有更多的 Android 代码正在用 Kotlin 编写：private lateinit var myTextView: textview——非常常见，我们没有意识到这些都可以导致内存泄漏。

除非在 Fragment 的onDestroyView中消除对这些字段的引用，（对于lateinit变量不能这么做），否则对这些视图的引用在 Fragment 的整个生命周期内都会存在，而不是像它们应该的那样在 Fragment 视图的生命周期内存在。

导致内存泄漏的一个最简单场景是：我们在 FragmentA 上。我们导航到 FragmentB，现在 FragmentA 在栈里。FragmentA 没有被销毁，但是 FragmentA 的视图被销毁了。任何绑定到 FragmentA 生命周期的视图现在已经不需要了，但都还保留在内存中。

在大多数情况下，这些泄漏很小，不会导致任何性能问题或崩溃。但是对于保存对象和数据、图像、视图 / 数据绑定等的视图，我们更有可能遇到麻烦。

所以，如果可能的话，避免在类级变量中存储视图，或者确保在onDestroyView中正确地清理它们。

说到视图 / 数据绑定，Android 的视图绑定文档 明确地告诉我们：字段必须被清除以防止泄漏。他们提供的代码片段建议我们做以下工作：

private var _binding: ResultProfileBinding? = null

// This property is only valid between onCreateView and

// onDestroyView.

private val binding get() = _binding!!

override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?

): View? {

_binding = ResultProfileBinding.inflate(inflater, container, false)

val view = binding.root

return view

}

override fun onDestroyView() {

super.onDestroyView()

_binding = null

}

每个 Fragment 中都有很多样板代码（另外，避免使用 !!，因为如果变量为空，这会抛出KotlinNullPointerException。使用显式空处理来代替。）我们解决这个问题的方法是创建一个ViewBindingHolder（和DataBindingHolder），Fragment 可以实现为下面这样：

interface ViewBindingHolder {

var binding: B?

// Only valid between onCreateView and onDestroyView.

fun requireBinding() = checkNotNull(binding)

fun requireBinding(lambda: (B) -> Unit) {

binding?.let {

lambda(it)

}}

/**

• Make sure to use this with Fragment.viewLifecycleOwner

*/

fun registerBinding(binding: B, lifecycleOwner: LifecycleOwner) {

this.binding = binding

lifecycleOwner.lifecycle.addObserver(object : DefaultLifecycleObserver {

override fun onDestroy(owner: LifecycleOwner) {

owner.lifecycle.removeObserver(this)

this@ViewBindingHolder.binding = null

}

})

}

}

interface DataBindingHolder : ViewBindingHolder

这为 Fragment 提供了一种简单而干净的方式：

• 确保在需要绑定时提供绑定

最后

如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

欢迎大家一起交流讨论啊~
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
ataBinding> : ViewBindingHolder

这为 Fragment 提供了一种简单而干净的方式：

• 确保在需要绑定时提供绑定

最后

如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

[外链图片转存中…(img-BaMIkUGw-1715138570358)]

欢迎大家一起交流讨论啊~
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！