okhttp拦截器Interceptor详解

前言

今天来给大家讲讲okhttp的拦截器（Interceptor）的原理和用法

本文档基于okhttp3.10
gradle引用

implementation 'com.squareup.okio:okio:2.1.0'
implementation 'com.squareup.okhttp3:okhttp:3.10.0'

Interceptor介绍

okhttp的拦截器就是将整个请求网络的过程的每一步都封装在不同的Interceptor里，这样说可能有点绕，简单点说就是把一个List里的Interceptor都顺序执行一遍，那么整个网络请求过程就完成了
先看一下正常的一个okhttp网络请求都走了哪些拦截器(图片来源于网络)

20180323202208681.jpg

• RetryAndFollowUpInterceptor拦截器
  RetryAndFollowUpInterceptor此拦截器顾名思义就是主要负责失败重连工作，但是并不是所有的网络请求都会进行失败重连的,在此拦截器内部会进行网络请求的异常检测和响应码的判断,如果都在限制范围内,那么就可以进行失败重连
• CacheInterceptor拦截器
  如果当前未使用网络，并且缓存不可以使用，通过构建者模式创建一个Response响应,抛出504错误
  。如果有缓存 但是不能使用网络 ，直接返回缓存结果。这是在进行网络请求之前所做的事情，当网络请求完成，得到下一个拦截器返回的response之后，判断response的响应码是否是HTTP_NOT_MODIFIED = 304，（未改变）是则从缓存中读取数据

其他的几个Interceptor就不在这里一一介绍了，下面通过自定义一个拦截器来看一下拦截器是如何运行的

实例

比如我们现在有这样一个需求，为了保护用户远离甫田系，要将所有请求某竞价排名公司(baidu)的接口地址都直接替换成 www.soso.com

• 拦截器代码如下：

import android.util.Log;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;

public class KeepAwayBaiduInterceptor implements Interceptor {
    private static final String TAG = "KeepAwayBaiduInterceptor";

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        Log.i(TAG, "intercept host: " + request.url().host());
        if (request.url().host().equals("www.baidu.com")) {
            //如果发现host属于该公司地址，就基于原来的request生成一个新的request，并使用新的url地址，这样之前request里的信息就都保留了
            Request newRequest = request.newBuilder().url("http://www.soso.com").build();
            return chain.proceed(newRequest);
        } else {
            return chain.proceed(request);
        }
    }
}

我们再看一下如何okhttp请求里使用这个自定义的Interceptor

• okhttp发起请求代码

public void doRequest(){
    //创建okHttpClient对象
    OkHttpClient mOkHttpClient = new OkHttpClient.Builder()
            .addInterceptor(new KeepAwayBaiduInterceptor())//在此处添加我们的拦截器
            .build();
    //创建一个该竞价排名公司的Request
    final Request request = new Request.Builder()
            .url("http://www.baidu.com")
            .build();

    Call call = mOkHttpClient.newCall(request);
    //请求加入调度
    call.enqueue(new Callback()
    {
        @Override
        public void onFailure(@NonNull Call call, @NonNull final IOException e) {
        }

        @Override
        public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException
        {
            final String htmlStr =  response.body().string();
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    textView.setText("response:"+htmlStr);

                }
            });
        }
    });
}

看一下返回结果

QQ20190316-161120@2x.png

我们看到返回的已经是soso的信息了，说明替换url成功！

总结

okhttp的拦截器就是在intercept(Chain chain)的回调中对Request和Response进行修改，然后通过chain.proceed(request)调起下一个拦截器。在okhttp中，网络连接也是一个拦截器（CallServerInterceptor），他是最后一个被调用的，负责将request写入网络流中，并从网络流中读取服务器返回的信息写入Response中返回给客户端