OkHttp 源码剖析：深入 Kotlin 版的网络通信库

Android

2023-10-26 12:24:01

OkHttp：Android 移动应用网络通信的基石

在快节奏的现代世界中，网络连接已成为移动应用的命脉。OkHttp 作为 Android 平台上的首选网络库，以其效率、可靠性和易用性而闻名。对于希望创建健壮、响应迅速的移动应用的开发者来说，深入了解 OkHttp 至关重要。

OkHttp 的模块化架构

OkHttp 采用模块化架构，简化了网络通信流程。其核心组件包括：

OkHttpClient： 客户端配置对象，用于管理连接池和设置拦截器。
Request： 表示 HTTP 请求的对象，包含 URL、方法和可选的请求正文。
Response： 表示 HTTP 响应的对象，包含状态代码、响应头和响应正文。
Call： 执行网络请求并管理请求生命周期的对象。

构建和执行请求

使用 OkHttp 构造请求非常简单。只需指定请求方法、URL 和可选的请求正文：

val request = Request.Builder()
    .url("https://example.com/api/v1/users")
    .get()
    .build()

要执行请求，可以使用 execute() 或 enqueue() 方法：

execute()： 同步执行请求，在主线程上阻塞并返回响应。
enqueue()： 异步执行请求，在后台线程上执行并通过回调函数接收响应。

处理响应

Response 对象提供了丰富的方法来访问响应数据：

code： HTTP 状态代码。
headers： HTTP 响应头。
body： 响应正文，可以作为字符串、字节数组或输入流读取。

深入源码

为了更深入地了解 OkHttp，让我们探索其核心组件的源码：

OkHttpClient 源码

class OkHttpClient internal constructor(builder: Builder) {
    private val dispatcher: Dispatcher = builder.dispatcher
    private val connectionPool: ConnectionPool = builder.connectionPool
    private val interceptors: List<Interceptor> = builder.interceptors
    private val networkInterceptors: List<Interceptor> = builder.networkInterceptors
}

Request 源码

class Request internal constructor(
    val url: HttpUrl,
    val method: String,
    val headers: Headers,
    val body: RequestBody?,
    val tag: Any?,
    val cacheControl: CacheControl?,
    internal val timeout: Timeout
) {
    companion object {
        @JvmStatic
        fun Builder(): Request.Builder = Request.Builder()
    }
}

Response 源码

class Response internal constructor(
    val request: Request,
    val protocol: Protocol,
    val code: Int,
    val message: String,
    val headers: Headers,
    val body: ResponseBody?,
    val networkResponse: NetworkResponse?,
    val cacheResponse: CacheResponse?,
    val priorResponse: Response?,
    internal val handshake: Handshake?
) {
    companion object {
        @JvmStatic
        fun Builder(): Response.Builder = Response.Builder()
    }
}

Call 源码

class Call internal constructor(
    val client: OkHttpClient,
    val request: Request
) {
    private var executed: Boolean = false

    fun execute(): Response {
        synchronized(this) {
            if (executed) throw IllegalStateException("Already Executed")
            executed = true
        }
        val interceptorChain = InterceptorChain.create(this, 0, null, request)
        val response = interceptorChain.proceed(request)
        if (response == null) throw NullPointerException("interceptorChain.proceed returned null")
        return response
    }
}