问题：如何仿照OkHttp拦截器实现请求日志打印？

Question

在使用 OkHttp 进行网络请求时，开发者常希望通过拦截器（Interceptor）机制打印请求和响应的日志，以便调试和监控网络行为。然而，许多开发者在尝试仿照 OkHttp 拦截器实现日志打印功能时，常常不清楚拦截器的执行流程、如何获取请求和响应的具体信息，或者如何正确地将自定义拦截器添加到 OkHttpClient 中。此外，如何区分应用拦截器（Application Interceptor）与网络拦截器（Network Interceptor）的使用场景，也成为实现日志打印功能时的常见困惑点。理解这些关键点，有助于开发者更高效地实现类似 OkHttp 自带的日志拦截功能。

Answer 1

OkHttp 拦截器详解：实现日志打印功能的全流程解析

在 Android 或 Java 的网络请求开发中，OkHttp 是一个广泛使用的 HTTP 客户端库。其强大的功能之一就是通过 Interceptor（拦截器） 实现对请求和响应的拦截处理。本文将从基础概念、执行流程、实现方式到高级使用，全面解析如何利用 OkHttp 拦截器实现日志打印功能。

1. 什么是 OkHttp 拦截器？

拦截器是 OkHttp 提供的一种机制，允许开发者在请求发出之前或响应返回之后进行自定义处理。拦截器可以用于日志记录、请求重试、添加公共头信息、缓存控制等多种用途。

OkHttp 支持两种主要类型的拦截器：

• Application Interceptor（应用拦截器）
• Network Interceptor（网络拦截器）

它们的执行时机和作用范围不同，理解这些差异是正确使用拦截器的关键。

2. 拦截器的执行流程

OkHttp 的拦截器链是一个责任链模式的实现，多个拦截器按添加顺序依次执行。其执行流程如下：

1. 应用拦截器最先执行（在请求被发送之前）
2. OkHttp 内部处理重定向、缓存、连接等逻辑
3. 网络拦截器在请求真正发送到网络之前执行
4. 响应返回后，拦截器链反向执行，依次处理响应

graph TD A[Request] --> B(Application Interceptor) B --> C[Internal Processing] C --> D(Network Interceptor) D --> E[Send to Network] E --> F[Receive Response] F --> G[Network Interceptor (Response)] G --> H[Internal Processing] H --> I[Application Interceptor (Response)] I --> J[Response to App]

3. 如何创建自定义日志拦截器？

创建一个自定义日志拦截器，核心在于实现 Interceptor 接口，并重写 intercept 方法。

class LoggingInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        // 打印请求信息
        System.out.println("Request: " + request.url());
        System.out.println("Headers: " + request.headers());

        long startTime = System.nanoTime();
        Response response = chain.proceed(request);
        long endTime = System.nanoTime();

        // 打印响应信息
        System.out.println("Response: " + response.code() + " in " + (endTime - startTime) / 1e6 + "ms");
        System.out.println("Headers: " + response.headers());

        return response;
    }
}

这段代码展示了如何在拦截器中获取请求和响应的详细信息，并输出到控制台。

4. 如何将拦截器添加到 OkHttpClient？

创建拦截器后，需要将其添加到 OkHttpClient 实例中才能生效。

OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(new LoggingInterceptor()) // 应用拦截器
    .addNetworkInterceptor(new LoggingInterceptor()) // 网络拦截器
    .build();

注意：添加顺序决定了拦截器的执行顺序。

5. 应用拦截器 vs 网络拦截器：使用场景对比

特性	应用拦截器	网络拦截器
触发次数	每次请求调用都会触发（包括重定向）	每次网络请求实际发送时触发
是否可获取响应体	可以	不能获取响应体（因为可能已经被消费）
适合场景	添加公共请求头、日志记录、请求重试等	监控网络行为、获取原始响应头、网络层缓存等

6. 常见问题与解决方案

• 问题1：日志重复打印
  原因：应用拦截器和网络拦截器同时添加并打印日志。
  解决：根据需求选择其中一个拦截器。
• 问题2：无法获取响应体内容
  原因：在网络拦截器中尝试读取响应体。
  解决：在网络拦截器中不能读取响应体，应在应用拦截器中读取。
• 问题3：拦截器未生效
  原因：未正确添加到 OkHttpClient 实例。
  解决：检查添加拦截器的代码是否被执行。

7. 进阶技巧：使用日志拦截器库

OkHttp 官方提供了 logging-interceptor 库，可以方便地实现日志打印功能：

implementation 'com.squareup.okhttp3:logging-interceptor:4.9.3'

使用方式：

HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
logging.setLevel(HttpLoggingInterceptor.Level.BODY);

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

支持的打印级别包括：

• NONE：不打印
• BASIC：打印请求行和响应状态码
• HEADERS：打印请求头和响应头
• BODY：打印请求体和响应体（适用于调试）