首先我们需要了解什么事拦截器。打个比方,镖局押着一箱元宝在行走在一个山间小路上,突然从山上下来一群山贼拦住了镖局的去路,将镖局身上值钱的东西搜刮干净后将其放行。其中山贼相当于拦截器,镖局相当于一个正在执行任务的网络请求,请求中的参数就是镖局携带的元宝。拦截器可以将网络请求携带的参数进行修改验证,然后放行。这里面其实设计了AOP编程的思想(面向切面编程)。
- 拦截器的作用和好处。
1、拦截器可以一次性对所有的请求和返回值进行修改。
2、拦截器可以一次性对请求的参数和返回的结果进行编码,比如统一设置为UTF-8.
3、拦截器可以对所有的请求做统一的日志记录,不需要在每个请求开始或者结束的位置都添加一个日志操作。
4、其他需要对请求和返回进行统一处理的需求….
- OkHttp中拦截器分类
![](http://www.androidxx.cn/data/attachment/forum/201604/26/171749i64dt825ytyhxh82.png)
一、Application Interceptor是在请求执行刚开始,还没有执行OkHttp的核心代码前进行拦截,Application拦截器的作用:
1、不需要担心是否影响OKHttp的请求策略和请求速度。
2、即使是从缓存中取数据,也会执行Application拦截器。
3、允许重试,即Chain.proceed()可以执行多次。(当然请不要盲目执行多次,需要加入你的逻辑判断)
二、Network Interception是在连接网络之前(如图,看图一目了然)
1、可以修改OkHttp框架自动添加的一些属性(当然最好不要修改)。
2、可以观察最终完整的请求参数(也就是最终服务器接收到的请求数据和熟悉)
- 实例化一个拦截器
- Interceptor appInterceptor = new Interceptor() {
- @Override
- public Response intercept(Chain chain) throws IOException {
- Request request = chain.request();
- //———请求之前————
- Response response = chain.proceed(request1);
- //———请求之后————
- return response;
- }
- };
复制代码
- 配置拦截器
- okHttpClient = new OkHttpClient
- .Builder()
- .addInterceptor(appInterceptor)//Application拦截器
- .addNetworkInterceptor(networkInterceptor)//Network拦截器
- .build();
复制代码
其中通过addInterceptor添加应用拦截器,addNetworkInterceptor添加网络拦截器。
- 示例代码
- public class InterceptorActivity extends AppCompatActivity {
- public static final String TAG = “androidxx”;
- OkHttpClient okHttpClient;
- /**
- * 应用拦截器
- */
- Interceptor appInterceptor = new Interceptor() {
- @Override
- public Response intercept(Chain chain) throws IOException {
- Request request = chain.request();
- HttpUrl url = request.url();
- String s = url.url().toString();
- //———请求之前—–
- Log.d(TAG,”app interceptor:begin”);
- Response response = chain.proceed(request);
- Log.d(TAG,”app interceptor:end”);
- //———请求之后————
- return response;
- }
- };
- /**
- * 网络拦截器
- */
- Interceptor networkInterceptor = new Interceptor() {
- @Override
- public Response intercept(Chain chain) throws IOException {
- Request request = chain.request();
- //———请求之前—–
- Log.d(TAG,”network interceptor:begin”);
- Response response = chain.proceed(request);
- Log.d(TAG,”network interceptor:end”);
- return response;
- }
- };
- @Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(R.layout.activity_interceptor);
- okHttpClient = new OkHttpClient
- .Builder()
- .addInterceptor(appInterceptor)//Application拦截器
- .addNetworkInterceptor(networkInterceptor)//Network拦截器
- .build();
- }
- public void click(View view) {
- Request request = new Request.Builder().url(“http://www.androidxx.cn”).build();
- okHttpClient.newCall(request).enqueue(new Callback() {
- @Override
- public void onFailure(Call call, IOException e) {
- e.printStackTrace();
- }
- @Override
- public void onResponse(Call call, Response response) throws IOException {
- Log.d(TAG,”–” + response.networkResponse());
- }
- });
- }
- }
复制代码
执行结果如下:
![](http://www.androidxx.cn/data/attachment/forum/201604/26/174617ejjqzuaijjicdz8i.png)
可以看到,从App Interceptor开始,然后执行Network Interceptor,最后又回到App Interceptor.
- 建议
如果对拦截器不是很熟的同学,开发过程中,建议使用Application Interception。这样避免对OkHttp请求策略的破坏。
- 实际开发中的用途
1、对请求参数进行统一加密处理。
2、拦截不符合规则的URL。
3、对请求或者返回参数设置统一的编码方式
4、其它…。
比如对URL进行验证(如果Url中没有包含androidxx关键字,则修改请求链接为http://www.androidxx.cn),代码如下:
- Interceptor appInterceptor = new Interceptor() {
- @Override
- public Response intercept(Chain chain) throws IOException {
- Request request = chain.request();
- HttpUrl url = request.url();
- String s = url.url().toString();
- Response response = null;
- //如果Url中没有包含androidxx关键字,则修改请求链接为http://www.androidxx.cn
- if (s.contains(“androidxx”)) {
- request = request.newBuilder().url(“http://www.androidxx.cn”).build();
- }
- response = chain.proceed(request);
- return response;
- }
- };
复制代码
- 注意
OkHttp的拦截器是在OkHttp2.2之后才可以使用,并且拦截器不能与Retrofit ≤ 1.8和Picasso ≤ 2.4框架同时使用。