当涉及到Android应用程序中的网络请求处理时，OkHttp是一个非常强大和流行的工具。其中一个关键的功能是拦截器（Interceptors），它们允许您在请求和响应传输到 服务器 和应用程序之间执行各种操作。在本文中，我们将深入研究OkHttp拦截器，了解其工作原理以及如何使用它们来优化您的Android应用程序。
OkHttp拦截器是一种机制，允许您在网络请求和响应的传输过程中执行自定义操作。它们通常用于记录请求日志、修改请求头、缓存响应或进行 身份验证 等操作。拦截器可以按照添加它们的顺序依次执行，从而形成一个拦截器链。
拦截器链是一个由多个拦截器组成的链条，每个拦截器在请求和响应的传输过程中都有机会进行操作。这些拦截器按照它们添加的顺序执行，因此顺序很重要。以下是一个拦截器链的示意图：
Request 1 -> Interceptor 1 -> Interceptor 2 -> ... -> Interceptor N -> Server
<- <- ... <- <-
Response 1 <- Interceptor 1 <- Interceptor 2 <- ... <- Interceptor N <- Server
OkHttp的核心组件是
Interceptor
接口和
RealCall
类。
Interceptor
接口定义了
intercept()
方法，它接收一个
Chain
对象作为参数，该对象用于执行拦截器链上的操作。
RealCall
类用于实际执行网络请求并管理拦截器链的执行。
首先，您需要创建一个
OkHttpClient
实例，该实例用于发起网络请求，并配置拦截器链。
OkHttpClient client = new OkHttpClient.Builder()
.addInterceptor(new CustomInterceptor())
.build();
当您调用
client.newCall(request)
来创建一个新的网络请求时，OkHttp会创建一个
RealCall
对象，该对象代表了实际的网络请求。接下来，
RealCall
会执行拦截器链上的操作。
Request request = new Request.Builder()
.url("https://example.com/api")
.build();
Call call = client.newCall(request);
Response response = call.execute();
拦截器链的执行是在
RealCall
类中完成的，它遍历拦截器列表并按照添加顺序依次执行。以下是相关源码示例：
public Response getResponseWithInterceptorChain() throws IOException {
// 创建一个初始的Interceptor.Chain
List<Interceptor> interceptors = new ArrayList<>();
interceptors.addAll(client.interceptors());
interceptors.add(retryAndFollowUpInterceptor);
interceptors.add(new BridgeInterceptor(client.cookieJar()));
interceptors.add(new CacheInterceptor(client.internalCache()));
interceptors.add(new ConnectInterceptor(client));
interceptors.add(new CallServerInterceptor(false));
Interceptor.Chain chain = new RealInterceptorChain(interceptors, null, null, 0, originalRequest, this, callStackTrace);
// 依次执行拦截器
return chain.proceed(originalRequest);
}
RealInterceptorChain
类实现了
Interceptor.Chain
接口，它包含了当前请求的信息，并负责执行拦截器链上的操作。在
proceed()
方法中，它依次调用拦截器的
intercept()
方法，将请求传递给下一个拦截器，并最终返回响应。
public Response proceed(Request request) throws IOException {
// 执行下一个拦截器或者发起网络请求
if (index >= interceptors.size()) throw new AssertionError();
calls++;
if (chain == null) throw new IllegalStateException("Check failed.");
if (eventListener != null) {
eventListener.callStart(this);
}
// 获取当前拦截器
Interceptor interceptor = interceptors.get(index++);
// 调用拦截器的intercept方法，将请求传递给下一个拦截器或者执行网络请求
Response response = interceptor.intercept(this);
if (eventListener != null) {
eventListener.callEnd(this);
}
return response;
}
要编写自定义拦截器，首先需要实现
Interceptor
接口，并实现
intercept()
方法。这个方法接收一个
Chain
对象作为参数，允许您访问和操作请求和响应。
public class CustomInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
// 在请求前执行的代码
Request originalRequest = chain.request();
// 可以修改请求
Request modifiedRequest = originalRequest.newBuilder()
.addHeader("Authorization", "Bearer YourAccessToken")
.build();
// 执行请求
Response response = chain.proceed(modifiedRequest);
// 在响应后执行的代码
// 可以修改响应
return response;
}
}
以下是一些实际运用示例，展示了如何使用OkHttp拦截器来实现不同的功能
这个拦截器用于记录请求和响应的详细信息，有助于调试和排查问题。
public class LoggingInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
long startTime = System.nanoTime();
Log.d("OkHttp", String.format("Sending request %s on %s%n%s",
request.url(), chain.connection(), request.headers()));
Response response = chain.proceed(request);
long endTime = System.nanoTime();
Log.d("OkHttp", String.format("Received response for %s in %.1fms%n%s",
response.request().url(), (endTime - startTime) / 1e6d, response.headers()));
return response;
}
}
这个拦截器用于在每个请求中添加身份验证标头，以确保请求是经过身份验证的。
public class AuthInterceptor implements Interceptor {
private final String authToken;
public AuthInterceptor(String authToken) {
this.authToken = authToken;
}
@Override
public Response intercept(Chain chain) throws IOException {
Request originalRequest = chain.request();
// 添加身份验证标头
Request authenticatedRequest = originalRequest.newBuilder()
.header("Authorization", "Bearer " + authToken)
.build();
return chain.proceed(authenticatedRequest);
}
}
这个拦截器用于实现响应缓存，以减少对服务器的请求。
public class CacheInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
// 在这里检查是否有缓存可用，如果有，返回缓存的响应
Response response = chain.proceed(request);
// 在这里将响应缓存起来
return response;
}
}
这个拦截器用于处理请求失败时的重试逻辑。
public class RetryInterceptor implements Interceptor {
private final int maxRetryCount;
public RetryInterceptor(int maxRetryCount) {
this.maxRetryCount = maxRetryCount;
}
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response response = null;
IOException lastException = null;
for (int retryCount = 0; retryCount < maxRetryCount; retryCount++) {
try {
response = chain.proceed(request);
if (response.isSuccessful()) {
return response;
}
} catch (IOException e) {
lastException = e;
}
}
// 如果达到最大重试次数仍然失败，抛出异常
throw lastException;
}
}
这个拦截器用于在接收到响应后执行自定义的响应处理逻辑。
public class ResponseProcessingInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response response = chain.proceed(request);
// 在这里对响应进行自定义处理
return response;
}
}
这个拦截器用于处理一些常见的错误情况
public class ErrorHandlingInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
try {
Response response = chain.proceed(request);
// 检查响应是否成功
if (!response.isSuccessful()) {
// 在这里处理错误，可以抛出自定义异常
throw new MyHttpException(response.code(), response.message());
}
return response;
} catch (IOException e) {
// 在这里处理网络连接错误
throw new MyNetworkException(e.getMessage(), e);
}
}
}
这个拦截器用于自定义重定向行为
public class RedirectInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response response = chain.proceed(request);
// 检查是否是重定向响应
if (response.isRedirect()) {
String newUrl = response.header("Location");
if (newUrl != null) {
// 构建新的请求并继续
Request newRequest = request.newBuilder()
.url(newUrl)
.build();
response = chain.proceed(newRequest);
}
}
return response;
}
}
OkHttp拦截器是Android应用程序中处理网络请求的有力工具。通过创建自定义拦截器，您可以在请求和响应的传输过程中执行各种操作，以优化您的应用程序。无论是日志记录、身份验证、缓存还是其他操作，拦截器都可以帮助您更好地控制和定制网络请求流程。
最后大家分享一份全套的Android学习资料，给那些想学习 Android 的小伙伴们一点帮助！
- 任何想学习Android开发但不知道从哪里开始的人
- 也适用于已经开始进行Android开发但想要变得更好的任何人
为了成为更好的 Android 开发者，这里为大家提供了总的路线图。它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。如果下面这个学习路线能帮助大家成为一个更好的 Android 开发者，那么我的使命也就完成了：
包括：Android应用开发、系统开发、音视频开发、Flutter开发、小程序开发、UI界面、车载系统开发等等
工欲善其事必先利其器。学习Android常用的Android Studio视频教程和Android Studio最新的安装包都在这里了，给大家节省了很多时间。
我们在学习的时候，往往书籍源码难以理解，阅读困难，这时候视频教程教程是就很适合了，生动形象加上案例实战，科学有趣才能更方便的学习下去。
光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。
阅读Android经典书籍可以帮助读者提高技术水平，开拓视野，掌握核心技术，提高解决问题的能力，同时也可以借鉴他人的经验。对于想要深入学习Android开发的读者来说，阅读Android经典书籍是非常有必要的。
我们学习Android必然是为了找到高薪的工作，下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料，并且有阿里大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。
保证100%免费
】
