Android OKHttp 可能你从来没用过的拦截器 【实用推荐】

在你的全局OkHttp中添加 Interceptor

new OkHttpClient.Builder()
.addInterceptor(new CaptureInfoInterceptor())
.build();

原理及涉及知识详解

作为Android开发，说到OKHttp的Interceptor，肯定熟悉不过了。那么你对 Interceptor 又了解多少呢？你都使用过那些OKHttp的 Interceptor呢？

我们先来看一下最近滴滴很火的哆啦A梦

DoraemonKit

长下面这个样子

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-koiaHRco-1637198610675)(https://user-gold-cdn.xitu.io/2019/12/2/16ec585b7e6cc9c8?imageView2/0/w/1280/h/960/ignore-error/1)]

其中关于网络模块OK Http的监听如下

OkHttpClient client = new OkHttpClient().newBuilder()
//用于模拟弱网的拦截器
.addNetworkInterceptor(new DoraemonWeakNetworkInterceptor())
//网络请求监控的拦截器 ，用于网络流量监听等
.addInterceptor(new DoraemonInterceptor()).build();

这里举例说一下弱网模拟

弱网模拟

看一下他的实现代码

public class DoraemonWeakNetworkInterceptor implements Interceptor {

@Override
public Response intercept(Chain chain) throws IOException {
if (!WeakNetworkManager.get().isActive()) {
Request request = chain.request();
return chain.proceed(request);
}
final int type = WeakNetworkManage

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

开源分享完整内容戳这里

r.get().getType();
switch (type) {
case WeakNetworkManager.TYPE_TIMEOUT:
//超时
final HttpUrl url = chain.request().url();
throw WeakNetworkManager.get().simulateTimeOut(url.host(), url.port());
case WeakNetworkManager.TYPE_SPEED_LIMIT:
//限速
return WeakNetworkManager.get().simulateSpeedLimit(chain);
default:
//断网
throw WeakNetworkManager.get().simulateOffNetwork(chain.request().url().host());
}
}
}

实现一个OkHttp的Intercepter，根据不同的状态来进行延迟，例如如下的模拟超时

/**

• 模拟超时
• @param host
• @param port
  */
  public SocketTimeoutException simulateTimeOut(String host, int port) {
  SystemClock.sleep(mTimeOutMillis);
  return new SocketTimeoutException(String.format(“failed to connect to %s (port %d) after %dms”, host, port, mTimeOutMillis));
  }

根据Interceptor 可以干很多事情，那么Interceptor到底是什么样的原理呢？

Interceptor原理

先看一下Interceptor的原型

public interface Interceptor {
Response intercept(Chain chain) throws IOException;
}

再看一下OkHttp源码，可以知道，我们的请求最终都会被调用到RealCall中，并执行到如下代码

@Override protected void execute() {
boolean signalledCallback = false;
try {
Response response = getResponseWithInterceptorChain();
}
…
}

Response getResponseWithInterceptorChain() throws IOException {
// Build a full stack of interceptors.
List 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));
if (!forWebSocket) {
interceptors.addAll(client.networkInterceptors());
}
interceptors.add(new CallServerInterceptor(forWebSocket));

Interceptor.Chain chain = new RealInterceptorChain(
interceptors, null, null, null, 0, originalRequest);
return chain.proceed(originalRequest);
}

在getResponseWithInterceptorChain 添加了很多OkHttp自定义的拦截器，其中有重定向，Cache，连接请求，发起请求到服务端等。我们来看一下最后几行 代码,RealInterceptorChain是一个Interceptor.Chain类型，并执行chain.proceed，接着看一下proceed方法

//RealInterceptorChain
public Response proceed(Request request, StreamAllocation streamAllocation, HttpCodec httpCodec,
RealConnection connection) throws IOException {
…
if (index >= interceptors.size()) throw new AssertionError();
calls++;
// Call the next interceptor in the chain.
RealInterceptorChain next = new RealInterceptorChain(
interceptors, streamAllocation, httpCodec, connection, index + 1, request);
Interceptor interceptor = interceptors.get(index);
Response response = interceptor.intercept(next);
…
return response;
}

重点看一下Call the next interceptor in the chain 下面几行代码，他把当前的interceptor.intercept()时，传入的是下一个interceptor的包装类，RealInterceptorChain 这样就实现了，链式递归调用了，直到最后一个response返回，才会依次返回到第一个interceptor。

可以用如下图大致描述

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-S5xzpYSr-1637198610703)(https://user-gold-cdn.xitu.io/2019/12/2/16ec5a3d813edd9b?imageView2/0/w/1280/h/960/ignore-error/1)]

讲了那么多相关的知识点，我们来回到正题，上述推荐小工具的实现步骤介绍

抓包工具实现主要步骤介绍

添加一个抓包入口

在Manifest中注册即可，如下

暴露Interceptor

public final class CaptureInfoInterceptor implements Interceptor{
@Override public Response intercept(Chain chain) throws IOException {
//获取request 所有信息
…
//获取response 所有信息
…

//存储抓包数据
CacheUtils.getInstance().saveCapture(request.url().toString(),captureEntity);
}
}

这里其中有两种方式，添加到OkHttp的Interceptor，一种硬编码，如下

new OkHttpClient.Builder()
.addInterceptor(new CaptureInfoInterceptor())
.build();

另一种方式 采用字节码注入的形式，关于字节码注入，可以简单参考我的另一篇Gradle学习笔记，自定义 Transform部分。

存储和读取抓包数据 效率问题

存储时，为了不影响到主APP的网络请求效率，需要在单独的线程中执行IO操作，这里使用了单线程池

public class DiskIOThreadExecutor implements Executor {
private final Executor mDiskIO;
public DiskIOThreadExecutor() {
mDiskIO = Executors.newSingleThreadExecutor();
}
@Override
public void execute(@NonNull Runnable command) {
mDiskIO.execute(command);
}
}

存储

public void saveCapture(final String url, final CaptureEntity value) {
Runnable runnable = new Runnable() {
@Override
public void run() {
String saveUrl = url;
if (url.contains("?")) {
saveUrl = saveUrl.substring(0, saveUrl.indexOf("?"));
}
String key = urlMd5(saveUrl);
sp.edit().putString(key, saveUrl).apply();
checkOrCreateFilePath(key);
File file = new File(captureFilePath + “/” + key + “/” + getCurrentTime() + “.txt”);
BufferedSink bufferedSink = null;
try {
file.createNewFile();
bufferedSink = Okio.buffer(Okio.sink(file));
bufferedSink.writeString(JSON.toJSONString(value), StandardCharsets.UTF_8);
bufferedSink.flush();
} catch (Exception e) {
e() + “.txt”);
BufferedSink bufferedSink = null;
try {
file.createNewFile();
bufferedSink = Okio.buffer(Okio.sink(file));
bufferedSink.writeString(JSON.toJSONString(value), StandardCharsets.UTF_8);
bufferedSink.flush();
} catch (Exception e) {