如何确保在 Android 单元测试中调用 ViewModel#onCleared？

Question

这是我的 MWE 测试类，它依赖于 AndroidX、JUnit 4 和 MockK 1.9：

class ViewModelOnClearedTest {
    @Test
    fun `MyViewModel#onCleared calls Object#function`() = mockkObject(Object) {
        MyViewModel::class.members
            .single { it.name == "onCleared" }
            .apply { isAccessible = true }
            .call(MyViewModel())

        verify { Object.function() }
    }
}

class MyViewModel : ViewModel() {
    override fun onCleared() = Object.function()
}

object Object {
    fun function() {}
}

注意：该方法在超类ViewModel受到保护。

我想验证MyViewModel#onCleared调用Object#function 。 上面的代码通过反射实现了这一点。 我的问题是：我能否以某种方式运行或模拟 Android 系统，以便调用onCleared方法，这样我就不需要反射？

来自onCleared JavaDoc：

当这个 ViewModel 不再使用时会调用这个方法，并且会被销毁。

那么，换句话说，我如何创建这种情况，以便我知道onCleared被调用并且我可以验证它的行为？

Answer 1

在 kotlin 中，您可以使用public覆盖受保护的可见性，然后从测试中调用它。

class MyViewModel: ViewModel() {
    public override fun onCleared() {
        ///...
    }
}

Answer 2

TL; 博士

在这个答案中，Robolectric 用于让 Android 框架在您的ViewModel上调用onCleared 。 这种测试方式比使用反射慢（如问题中所示），并且取决于 Robolectric 和 Android 框架。 这种权衡取决于你。

---

查看Android的源...

...您可以看到ViewModel#onCleared仅在ViewModelStore被调用（对于您自己的ViewModels ）。 这是视图模型的存储类，由ViewModelStoreOwner类拥有，例如FragmentActivity 。 那么，什么时候ViewModelStore则启动onCleared您的ViewModel ？

它必须存储您的ViewModel ，然后必须清除存储（您ViewModel做）。

您的视图模型是由存储ViewModelProvider ，当你get你的ViewModel使用ViewModelProviders.of(FragmentActivity activity).get(Class<T> modelClass)其中T是你的视图模型类。 它将它存储在FragmentActivity的ViewModelStore中。

例如，当您的 Fragment 活动被销毁时，商店就很清楚了。 这是一堆遍布各处的连锁调用，但基本上是：

1. 有一个FragmentActivity 。
2. 使用ViewModelProviders#of获取它的ViewModelProvider 。
3. 使用ViewModelProvider#get获取您的ViewModel 。
4. 破坏你的活动。

现在，应该在您的视图模型上调用onCleared 。 让我们使用 Robolectric 4、JUnit 4、MockK 1.9 对其进行测试：

1. 将@RunWith(RobolectricTestRunner::class)添加到您的测试类。
2. 使用Robolectric.buildActivity(FragmentActivity::class.java)创建一个活动控制器
3. 使用控制器上的setup初始化活动，这允许它被销毁。
4. 使用控制器的get方法获取活动。
5. 使用上述步骤获取您的视图模型。
6. 在控制器上使用destroy销毁活动。
7. 验证onCleared的行为。

完整示例类...

...基于问题的例子：

@RunWith(RobolectricTestRunner::class)
class ViewModelOnClearedTest {
    @Test
    fun `MyViewModel#onCleared calls Object#function`() = mockkObject(Object) {
        val controller = Robolectric.buildActivity(FragmentActivity::class.java).setup()

        ViewModelProviders.of(controller.get()).get(MyViewModel::class.java)

        controller.destroy()

        verify { Object.function() }
    }
}

class MyViewModel : ViewModel() {
    override fun onCleared() = Object.function()
}

object Object {
    fun function() {}
}

Answer 3

我刚刚为 ViewModel 创建了这个扩展：

/**
 * Will create new [ViewModelStore], add view model into it using [ViewModelProvider]
 * and then call [ViewModelStore.clear], that will cause [ViewModel.onCleared] to be called
 */
fun ViewModel.callOnCleared() {
    val viewModelStore = ViewModelStore()
    val viewModelProvider = ViewModelProvider(viewModelStore, object : ViewModelProvider.Factory {

        @Suppress("UNCHECKED_CAST")
        override fun <T : ViewModel?> create(modelClass: Class<T>): T = this@callOnCleared as T
    })
    viewModelProvider.get(this@callOnCleared::class.java)

    //Run 2
    viewModelStore.clear()//To call clear() in ViewModel
}

Answer 4

对于 Java，如果在与 ViewModel 类（此处为 MyViewModel）相同的包中（在 test 目录中）创建测试类，则可以从测试类调用onCleared方法； 因为受保护的方法也是包私有的。