2018年4月17日更新
在看okthttp3源码的时候发现,这边文章最底下的总结内容中的第一点:
无网络请求下,okhttp不会走入拦截器中,所以在这里面编写无网络代码逻辑是无效的;
是错误的结论,因为拦截器是链式执行的,所以每个拦截器中的chain.proceed(request);
方法其实是在调用执行下一个拦截器的intercept()
方法,于是拦截器中返回的response就是从最底层拦截器开始一层一层的进行封装,然后原路返回到最上一层拦截器中。所以没有网络的情况下还是会执行拦截器,只是说,我打印日志的位置因为在chain.proceed(request);
方法后所以没有任何打印结果,因为执行这里的时候,没有网络就已经报了网络异常。
在此,如给大家造成了误解,见谅见谅!
最近实在太忙,所以影响了更新速度…
添加Interceptor
在上一篇中我们已经知道了okhttp的基本使用,其中在介绍OkHttpClient初始化的时候,介绍了两种方式,第二种方式就可以对这个OkHttpClient对象设置拦截器,如下所示:
// 配置一些信息进入OkHttpClient
mOkHttpClient = new OkHttpClient().newBuilder()
.connectTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.readTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.writeTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.addInterceptor(new LoggerInterceptor())
.build();
如上代码,很简单,只要利用addInterceptor方法就可以添加拦截器,而自定义的拦截器只需要实现Interceptor
接口就行了,如下所示:
public class LoggerInterceptor implements Interceptor {
...
}
应用场景
日志打印
可以使用拦截器方便的打印网络请求时,需要查看的日志。如下所示:
public class LoggerInterceptor implements Interceptor {
@Override
public Response intercept(@NonNull Chain chain) throws IOException {
// 拦截请求,获取到该次请求的request
Request request = chain.request();
// 执行本次网络请求操作,返回response信息
Response response = chain.proceed(request);
if (Configuration.DEBUG) {
for (String key : request.headers().toMultimap().keySet()) {
LogUtil.e("zp_test", "header: {" + key + " : " + request.headers().toMultimap().get(key) + "}");
}
LogUtil.e("zp_test", "url: " + request.url().uri().toString());
ResponseBody responseBody = response.body();
if (HttpHeaders.hasBody(response) && responseBody != null) {
BufferedReader bufferedReader = new BufferedReader(new
InputStreamReader(responseBody.byteStream(), "utf-8"));
String result;
while ((result = bufferedReader.readLine()) != null) {
LogUtil.e("zp_test", "response: " + result);
}
// 测试代码
responseBody.string();
}
}
// 注意,这样写,等于重新创建Request,获取新的Response,避免在执行以上代码时,
// 调用了responseBody.string()而不能在返回体中再次调用。
return response.newBuilder().build();
}
}
做了一个打印验证:通过分别打印拦截器与返回体的时间和线程名字,可以知道这两者处于同一线程中,增加拦截器,请求执行的时间也会增加,所以猜测,其实就是线性的在执行不同拦截器中的代码,根据需求返回一个相同的或者新的response。
缓存
想要实现缓存,先在创建okhttpclint的时候多加一行代码.cache()
,通过它来设置缓存目录,当然需要服务器支持缓存功能。
mOkHttpClient = new OkHttpClient().newBuilder()
.cache(new Cache(FileUtils.getCacheDirectory(AppApplication
.getApplication(), ""), 1024 * 1024))
.connectTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.readTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.writeTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.addNetworkInterceptor(new LoggerInterceptor())
.build();
如果服务器端支持缓存的话,则请求所返回的Response会带有这样的头信息header:cache-control, max-age=xxx,这样设置。这时可以直接使用缓存功能。其中,max-age设置的缓存时间,过了这个时间,就算有缓存也不会进行使用。
像我公司服务器返回的头信息中与缓存相关的字段如下:
header: {cache-control : [no-store, private]}
header: {pragma : [no-cache]}
这就说明,服务器默认是不支持缓存的,okhttp就不会对此次请求进行缓存。为了让okhttp缓存此次响应,就必须重新设置response的请求头信息。
接下来再看拦截器中如何设置缓存请求头信息。
public class LoggerInterceptor implements Interceptor {
@Override
public Response intercept(@NonNull Chain chain) throws IOException {
// 拦截请求,获取到该次请求的request
Request request = chain.request();
// 执行本次网络请求操作,返回response信息
Response response = chain.proceed(request);
if (Configuration.DEBUG) {
for (String key : request.headers().toMultimap().keySet()) {
LogUtil.e("zp_test", "header: {" + key + " : " + request.headers().toMultimap().get(key) + "}");
}
LogUtil.e("zp_test", "url: " + request.url().uri().toString());
ResponseBody responseBody = response.body();
}
return response.newBuilder()
// 增加一个缓存头信息,缓存时间为60s
.header("cache-control", "public, max-age=60")
// 移除pragma头信息
.removeHeader("pragma")
.build();
}
}
这样设置,就等于是在60s内强制设置使用缓存。
注意点:
切记,最开始,我一直在犯一个错误,okhttp3不能缓存post接口
拦截器可以理解为,给请求的request和response重新一次封装的机会,使得你可以在特定条件下,给一些特定的接口或者满足特定条件的接口一些特殊的操作。
比如有一种场景,有网络时,进行请求,无网络时,拿缓存数据。先看网上的一种方法。
if (NetUtils.isNetAvailable(AppApplication.getApplication())) {
response.newBuilder()
.header("Cache-Control", "public, max-age=" + 0)
.removeHeader("Pragma")
.build();
} else {
int maxStale = 60 * 60 * 24; // 无网络时,设置超时为1天
response.newBuilder()
.header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
.removeHeader("Pragma")
.build();
}
return response;
max-stale:在max-age指定的失效时间外,额外增加一段指定的时间可以使用失效的response。
网上有很多是上面这种做法,但是,我在拦截器中试了一下,当没有网络时,压根就不会走入拦截器。(我使用的是网络拦截器,如果有是别的什么原因,欢迎指出错误)
最终解决方案是在初始化request(如果初始化不熟悉可以参考我的上一篇文章OKHttp3的基本使用)的时候进行的判断操作,当有网络时初始化正常的request,当没有网络时初始化强制使用缓存的request:
Request request;
if (NetUtils.isNetAvailable(AppApplication.getApplication())) {
request = addHeaderInfo().url(requestUrl).build();
} else {
request = addHeaderInfo().url(requestUrl).cacheControl(CacheControl.FORCE_CACHE).build();
}
拦截器还是使用上面的那种形式,只是将有效时间变成了0,主要是为了在有网络情况下每次都请求最新的数据。
response.newBuilder()
.header("Cache-Control", "public, max-age=" + 0)
.removeHeader("Pragma")
.build();
这样就可以在有网络的情况下使用最新的数据,在无网络的情况下使用缓存数据。
总结
第一点,无网络请求下,okhttp不会走入拦截器中,所以在这里面编写无网络代码逻辑是无效的;
第二点,无网络情况下,通过给request设置一个强制缓存标志:CacheControl.FORCE_CACHE来告诉okhttp本次请求走缓存,并且还得在之前的网络请求中已经缓存了数据到本地。如果此时没有命中缓存文件,则会报504;
第三点,有网络情况下,咱们可以利用拦截器和服务器的缓存策略进行动态配合。
最后欢迎大家提问一起讨论,也欢迎指出文中错误,谢谢!