OkHttp 3.x 从零到一彻底读懂 Interceptor 拦截器

2024-01-26 23:40:59

OkHttp 是 Android 平台上使用最为广泛的网络请求框架，它是一款非常高效的 HTTP 客户端。Interceptor 是 OkHttp 中一个非常重要的特性，它允许我们在网络请求发送之前和响应返回之后对请求和响应进行拦截和处理。通过使用 Interceptor，我们可以实现很多有用的功能，比如添加请求头、重定向请求、缓存响应等等。

在这篇文章中，我们将从零开始学习 OkHttp 的 Interceptor，包括它的原理、使用方法以及一些常见的应用场景。

Interceptor 的原理

Interceptor 的原理很简单，它就是在网络请求发送之前和响应返回之后对请求和响应进行拦截和处理。Interceptor 的具体实现是一个接口，它定义了两个方法：

intercept 方法：该方法会在网络请求发送之前和响应返回之后被调用。在该方法中，我们可以对请求和响应进行拦截和处理。
call 方法：该方法会将请求发送到服务器并获取响应。

Interceptor 的使用方法

要使用 Interceptor，我们需要创建一个实现了 Interceptor 接口的类，然后将其添加到 OkHttp 的 OkHttpClient 对象中。可以通过如下方式添加 Interceptor：

OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(new MyInterceptor())
    .build();

在上面的代码中，我们创建了一个新的 OkHttpClient 对象，并使用 addInterceptor 方法添加了我们的 Interceptor。这样，当我们使用这个 OkHttpClient 对象发送网络请求时，我们的 Interceptor 就会被调用。

Interceptor 的常见应用场景

Interceptor 有很多常见的应用场景，比如：

添加请求头：我们可以使用 Interceptor 来添加请求头。比如，我们可以使用 Interceptor 来添加 Authorization 请求头，以便对请求进行身份验证。
重定向请求：我们可以使用 Interceptor 来重定向请求。比如，我们可以使用 Interceptor 来将请求重定向到另一个服务器。
缓存响应：我们可以使用 Interceptor 来缓存响应。比如，我们可以使用 Interceptor 来将响应缓存到磁盘或内存中，以便在下次请求时直接从缓存中获取响应。
日志记录：我们可以使用 Interceptor 来记录网络请求和响应的日志。比如，我们可以使用 Interceptor 来记录请求的 URL、方法、请求体和响应的代码、消息体等信息。