Kotlin 协程 -- 项目中使用 ③| 理解 “viewModelScope”

引言

Kotlin 协程是 Kotlin 语言的一大特色，它让异步编程变得更简单。在 Android 开发中，我们经常需要在后台线程执行耗时操作，例如网络请求或数据库查询，然后在主线程更新 UI。Kotlin 协程让我们可以用同步的方式写异步代码，使得代码更易读、更易写。

在这篇文章中，我们将通过分析源码来深入理解 Kotlin 协程中的 viewModelScope。viewModelScope 是 Android 架构组件库中 ViewModel 类的一个扩展属性，它为 ViewModel 提供了一个协程作用域。在这个作用域中启动的所有协程都会在 ViewModel 清除时自动取消，防止内存泄漏。

Kotlin 协程的核心是 suspend 关键字。它可以将一个函数标记为挂起函数。挂起函数可以在不阻塞线程的情况下挂起和恢复执行。挂起函数只能在协程或其他挂起函数中调用。

viewModelScope 简介

viewModelScope 是 Android 架构组件库中 ViewModel 类的一个扩展属性。

它为 ViewModel 提供了一个协程作用域。在这个作用域中启动的所有协程都会在 ViewModel 清除时自动取消，防止内存泄漏。

class MyViewModel : ViewModel() {
    init {
        viewModelScope.launch {
            // 在这里启动一个新的协程
        }
    }
}

在上面的例子中，我们在 MyViewModel 的 viewModelScope 中启动了一个新的协程。由于我们是在 viewModelScope 中启动的这个协程，所以当 MyViewModel 被清除时，这个协程会被自动取消。

这个特性非常有用，因为它可以自动管理协程的生命周期，防止内存泄漏。这使得我们可以在 ViewModel 中安全地启动协程，而不用担心协程的生命周期管理。

viewModelScope 的源码分析

viewModelScope 是通过 CoroutineScope 接口实现的。CoroutineScope 是 Kotlin 协程库中的一个接口，它定义了一个协程作用域。

在一个 CoroutineScope 中启动的所有协程都属于这个作用域，当这个作用域被取消时，作用域中的所有协程都会被取消。

viewModelScope 的源码如下：

val ViewModel.viewModelScope: CoroutineScope
    get() {
        val scope: CoroutineScope? = this.getTag(JOB_KEY)
        if (scope != null) {
            return scope
        }
        return setTagIfAbsent(JOB_KEY, ViewModelCoroutineScope(this))
    }

在这段源码中，viewModelScope 是通过 getTag 和 setTagIfAbsent 方法来实现的。getTag 方法用于获取 ViewModel 的 viewModelScope，如果 ViewModel 还没有 viewModelScope，那么 setTagIfAbsent 方法会创建一个新的 ViewModelCoroutineScope 并将其设置为 ViewModel 的 viewModelScope。

ViewModelCoroutineScope 是一个实现了 CoroutineScope 接口的类。它的源码如下：

class ViewModelCoroutineScope(
    private val viewModel: ViewModel
) : MainCoroutineScope() {

    private val job = SupervisorJob().apply {
        invokeOnCompletion { error ->
            if (error is CancellationException) {
                viewModel.clear()
            }
        }
    }

    override val coroutineContext: CoroutineContext
        get() = job + Dispatchers.Main
}

在这段源码中，ViewModelCoroutineScope 创建了一个 SupervisorJob，并将其设置为作用域的 job。SupervisorJob 是 Job 的一个子类，它允许其子协程独立地失败，而不会影响其他子协程。

ViewModelCoroutineScope 还重写了 CoroutineScope 的 coroutineContext 属性，将 job 和 Dispatchers.Main 添加到作用域的上下文中。这意味着在这个作用域中启动的所有协程都会在主线程中运行，并共享同一个 job。

当 job 完成时，invokeOnCompletion 方法会被调用。如果 job 是因为被取消而完成的，那么 viewModel.clear() 方法会被调用，清除 ViewModel 的所有数据。

这就是 viewModelScope 的源码实现。通过这段源码，我们可以看到 viewModelScope 是如何自动管理协程的生命周期的。当 ViewModel 被清除时，viewModelScope 中的所有协程都会被自动取消，防止内存泄漏。

在下一部分中，我们将进一步探讨 viewModelScope 的使用方法和最佳实践。

viewModelScope 的使用方法和最佳实践

在 ViewModel 中使用 viewModelScope 是非常简单的。我们只需要在 viewModelScope 中启动我们的协程，然后 viewModelScope 会自动管理协程的生命周期。

class MyViewModel : ViewModel() {
    fun fetchData() {
        viewModelScope.launch {
            // 在这里启动一个新的协程
        }
    }
}

使用 viewModelScope 的一个最佳实践是在 ViewModel 的方法中启动协程，而不是在 ViewModel 的构造函数或 init 块中启动协程。这是因为 ViewModel 的构造函数和 init 块会在 ViewModel 创建时立即执行，而这个时候 ViewModel 可能还没有完全初始化，可能会导致问题。

例如，如果我们在 ViewModel 的 init 块中启动一个协程来更新 LiveData，那么这个 LiveData 可能还没有观察者，更新操作可能会被忽略。

因此，我们建议在 ViewModel 的方法中启动协程，这样我们可以在需要时启动协程，而不是在 ViewModel 创建时就启动协程。

在接下来的部分中，我们将通过一个例子来展示如何在实际的 Android 开发中使用 viewModelScope。

viewModelScope 的实际应用

让我们来看一个例子，展示如何在实际的 Android 开发中使用 viewModelScope。

假设我们正在开发一个天气应用，这个应用有一个 WeatherViewModel，它负责从网络获取天气数据，并更新 UI。

class WeatherViewModel(private val weatherRepository: WeatherRepository) : ViewModel() {
    val weatherLiveData = MutableLiveData<Weather>()

    fun fetchWeather(city: String) {
        viewModelScope.launch {
            val weather = weatherRepository.fetchWeather(city)
            weatherLiveData.value = weather
        }
    }
}

在这个例子中，我们在 fetchWeather 方法中启动了一个新的协程。这个协程会在 WeatherViewModel 被清除时自动取消，防止内存泄漏。

这就是 viewModelScope 的实际应用。通过使用 viewModelScope，我们可以在 ViewModel 中安全地启动协程，而不用担心协程的生命周期管理。

在接下来的部分中，我们将总结 viewModelScope 的主要特点和优点。

viewModelScope 的总结

viewModelScope 是 Android 架构组件库中 ViewModel 类的一个扩展属性。

它为 ViewModel 提供了一个协程作用域。在这个作用域中启动的所有协程都会在 ViewModel 清除时自动取消，防止内存泄漏。

viewModelScope 的主要特点和优点包括：

• 自动管理协程的生命周期：在 viewModelScope 中启动的所有协程都会在 ViewModel 清除时自动取消，防止内存泄漏。
• 简化异步编程：Kotlin 协程让我们可以用同步的方式写异步代码，使得代码更易读、更易写。
• 安全地在主线程中执行耗时操作：Kotlin 协程可以让我们在不阻塞线程的情况下挂起和恢复函数的执行，这意味着我们可以在主线程中执行耗时操作，而不会阻塞 UI。

使用 viewModelScope 的一个最佳实践是在 ViewModel 的方法中启动协程，而不是在 ViewModel 的构造函数或 init 块中启动协程。这是因为 ViewModel 的构造函数和 init 块会在 ViewModel 创建时立即执行，而这个时候 ViewModel 可能还没有完全初始化，可能会导致问题。

结论

通过分析 viewModelScope 的源码，我们可以看到 viewModelScope 是如何自动管理协程的生命周期的。当 ViewModel 被清除时，viewModelScope 中的所有协程都会被自动取消，防止内存泄漏。

Kotlin 协程和 viewModelScope 是 Kotlin 语言和 Android 架构组件库的强大特性，它们可以大大简化我们的异步编程工作，使我们的代码更易读、更易写。

我们希望这篇文章能帮助你更深入地理解 Kotlin 协程和 viewModelScope，并在你的 Android 开发工作中得到应用。

结束。

下一篇： Kotlin 协程 -- Flow 异步流 ①-CSDN博客