Android上的协程：简介

2024-04-09 18:40:05 阅读数 6825

协程是一种并发设计模式，在 Android 平台上可以使用它来简化异步执行的代码。

特点

轻量：因为协程支持挂起，不会使正在运行协程的线程发生阻塞。挂起比阻塞节省内存，且支持多个并行操作
内存泄漏更少：使用结构化并发(Structured concurrency)机制在一个作用域内执行多项操作
内置取消支持：取消操作会自动在运行中的整个协程层次结构内传播
Jetpack集成：许多Jetpack库都包含提供全面协程支持的扩展，某些库还提供自己的协程操作域，可供开发者用于结构化并发

依赖库

如需在Android项目中使用协程，需将以下依赖项添加到对应module的build.gradle文件中：

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:<version>'
}

执行后台线程

如下示例代码我们在主线程上发起网络请求，主线程会处于等待或阻塞状态，直到收到网络响应。

sealed class Result<out R> {
    data class Success<out T>(val data: T) : Result<T>()
    data class Error(val exception: Exception) : Result<Nothing>()
}

class LoginRepository(private val responseParser: LoginResponseParser) {
    private const val loginUrl = "https://example.com/login"

    // Function that makes the network request, blocking the current thread
    fun makeLoginRequest(
        jsonBody: String
    ): Result<LoginResponse> {
        val url = URL(loginUrl)
        (url.openConnection() as? HttpURLConnection)?.run {
            requestMethod = "POST"
            setRequestProperty("Content-Type", "application/json; utf-8")
            setRequestProperty("Accept", "application/json")
            doOutput = true
            outputStream.write(jsonBody.toByteArray())
            return Result.Success(responseParser.parse(inputStream))
        }
        return Result.Error(Exception("Cannot open HttpURLConnection"))
    }
}

makeLoginRequest 是同步的，并且会阻塞发起调用的线程。为了对网络请求的响应建模，我们创建了自己的 Result 类。ViewModel 会在用户点击（例如，点击按钮）时触发网络请求：

class LoginViewModel(
    private val loginRepository: LoginRepository
): ViewModel() {

    fun login(username: String, token: String) {
        val jsonBody = "{ username: \"$username\", token: \"$token\"}"
        loginRepository.makeLoginRequest(jsonBody)
    }
}

由于此时主线程处于阻塞状态，但Android系统需要更新UI时将无法调用onDraw()，这时将会导致应用卡顿，并有可能产生应用无响应(ANR)对话框。为了更好的用户体验，我们就需要将网络请求的操作放在后台线程上去执行。最简单的方法就是创建一个新的协程，然后在I/O线程上执行网络请求：

class LoginViewModel(
    private val loginRepository: LoginRepository
): ViewModel() {

    fun login(username: String, token: String) {
        // Create a new coroutine to move the execution off the UI thread
        viewModelScope.launch(Dispatchers.IO) {
            val jsonBody = "{ username: \"$username\", token: \"$token\"}"
            loginRepository.makeLoginRequest(jsonBody)
        }
    }
}

下面我们仔细分析一下login函数中的协程代码：

viewModelScope是预定义的CorutineScop，包含在ViewModel KTX扩展中。请注意，所有协程都必须在一个作用域内运行。一个CoroutineScope管理一个或多个相关的协程。
launch是一个函数，用于创建协程并将其函数主体的执行分派给相应的调试程序。
Dispatchers.IO指示协程应在为I/O操作预留的线程上执行。

login函数按以下方式执行：

应用从主线程上的View层调用login函数。
launch会创建一个新的协程，并且网络请求在为I/O操作预留的线程上独立发出。
在该协程运行时，login函数会继续执行，并可能在网络请求完成前返回。为模型简单起见，我们暂时忽略网络响应。

由于些协程是通过viewModelScope启动的，因此些协程的所有操作都在ViewModel的作用域内执行。如果ViewModel被销毁，则viewModelScop也会被自动取消，且所有的协程也会被取消。

以上示例还存在一个问题，就是怎样保证makeLoginRequest的所有调用都是在子线程中执行，从而确保主线程安全呢？

使用线程确保主线程安全

如果函数操作不会阻塞主线程更新UI，我们即将其视为主线程安全。这里makeLoginRequest函数就不是主线程安全，因为在主线程调用makeLoginRequest会阻塞UI。可以使用协程库中的witContext()函数将协程的操作移至其他线程：

class LoginRepository(...) {
    ...
    suspend fun makeLoginRequest(
        jsonBody: String
    ): Result<LoginResponse> {

        // Move the execution of the coroutine to the I/O dispatcher
        return withContext(Dispatchers.IO) {
            // Blocking network request code
        }
    }
}

withContext(Dispatchers.IO)将协程的执行操作移至一个I/O线程，从而保证主线程安全。suspend关键字强制标记此函数在协程内调用

由于makeLoginRequest已将执行操作移出主线程，由login函数中的协程可以在主线程中执行：

class LoginViewModel(
    private val loginRepository: LoginRepository
): ViewModel() {

    fun login(username: String, token: String) {

        // Create a new coroutine on the UI thread
        viewModelScope.launch {
            val jsonBody = "{ username: \"$username\", token: \"$token\"}"

            // Make the network call and suspend execution until it finishes
            val result = loginRepository.makeLoginRequest(jsonBody)

            // Display result of the network request to the user
            when (result) {
                is Result.Success<LoginResponse> -> // Happy path
                else -> // Show error in UI
            }
        }
    }
}

⚠请注意，此处仍需要协程，因为 makeLoginRequest 是一个 suspend 函数，而所有 suspend 函数都必须在协程中执行。

最后修改的的区别之处：

launch没有Dispatchers.IO参数。如果launch没有Dispatcher参数，则从viewModelScope启动的所有协程都会在主线程中执行。
返回网络请求的处理结果到当前主线程，成功或者失败

login函数的执行流程：

应用从主线程的view层调用login()``函数。
launch创建一个新的协程，在
主线程上发出网络请求，然后该协程开始执行。
在协程内，调用 loginRepository.makeLoginRequest() 现在会挂起协程的进一步执行操作，直至 makeLoginRequest() 中的 withContext 块结束运行。
withContext 块结束运行后，login() 中的协程在主线程上恢复执行操作，并返回网络请求的结果。