Retofit：协程的优雅支持

Android

2023-12-18 10:50:19

协程的引入

在 Android 开发中，网络请求一直是一项耗时的任务，传统的异步编程方式常常导致代码复杂、难以维护。协程的出现，为解决这一痛点提供了优雅的解决方案。

协程是一种轻量级的线程，它允许我们以同步的方式编写异步代码。通过挂起函数（suspend function），协程可以暂停当前协程的执行，等待耗时操作完成。

Retofit 对协程的支持

自 Retofit 2.6.0 版本起，协程成为其默认选择。这意味着，只需在网络请求函数前面添加 suspend 修饰语，即可轻松享受协程带来的好处。

协程支持的原理

要理解 Retofit 是如何支持协程的，我们需要深入到其源码中。在 Retofit 中，网络请求的执行过程大致分为以下几个步骤：

创建请求对象：使用 @GET、@POST 等注解定义请求接口，并使用 Retrofit.create() 方法创建请求对象。
构建请求：Retofit 内部会根据请求接口生成请求，包括 URL、请求方法、请求参数等信息。
发送请求：使用 CallAdapter 将请求发送到网络。
接收响应：网络请求完成后，Retofit 会使用 ResponseHandler 将响应解析为我们期望的数据类型。

关键组件：CoroutineCallAdapterFactory

在 Retofit 对协程的支持中，CoroutineCallAdapterFactory 扮演着关键的角色。这是一个 CallAdapter，它负责将网络请求转换为协程。

CoroutineCallAdapterFactory 通过内部类 CoroutineCallDelegate 实现协程支持。CoroutineCallDelegate 继承自 CallDelegate，重写了 adapt 方法。在 adapt 方法中，它会创建并返回一个 SuspendCall 对象。

SuspendCall

SuspendCall 是一个协程挂起函数，它封装了网络请求的执行过程。SuspendCall 内部持有一个委托的 Call 对象，负责实际的网络请求。

当 SuspendCall 被调用时，它会调用委托的 Call 对象的 enqueue() 方法。enqueue() 方法会将网络请求放入一个调度程序中执行。同时，SuspendCall 会挂起当前协程，等待网络请求完成。

当网络请求完成后，Retofit 会将响应传递回 SuspendCall。SuspendCall 会解析响应，并使用 resumeWith() 方法唤醒挂起的协程，将响应传递给协程的后续代码。

示例代码

下面是一个使用协程发送网络请求的示例代码：

import kotlinx.coroutines.Deferred
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
import retrofit2.http.GET

interface MyService {
    @GET("/users")
    fun getUsers(): Deferred<List<User>>
}

val retrofit = Retrofit.Builder()
    .baseUrl("https://api.example.com")
    .addConverterFactory(GsonConverterFactory.create())
    .build()

val service = retrofit.create(MyService::class.java)

runBlocking {
    val users = service.getUsers().await()
}