搜文章
推荐 原创 视频 Java开发 iOS开发 前端开发 JavaScript开发 Android开发 PHP开发 数据库 开发工具 Python开发 Kotlin开发 Ruby开发 .NET开发 服务器运维 开放平台 架构师 大数据 云计算 人工智能 开发语言 其它开发
Lambda在线 > 程序圈LT > okhttp 缓存实践

okhttp 缓存实践

程序圈LT 2018-06-28
点击上方"程序圈LT"关注我们

我们的态度是:每天进步一点点,理想终会被实现。

声明转载自:Othershe
原文链接:https://juejin.im/post/5afb89dcf265da0ba26727c7


OKHttp缓存实践


以下内容基于 okhttp:3.10.0 版本


在开发中,由于不同业务场景解,我们需要将接口返回的数据缓存到本地,以实现复用。例如,接口数据每间隔一定时间才会更新,在时间间隔内就没必要重复的向服务器请求数据,直接使用缓存即可;当 app 无法访问网络时,也可以使用缓存的接口数据,避免缺省页等等。所以使用缓存也是好处多多:节省流量、提高响应速度、增强用户体验......

okhttp 的缓存功能使用起来也比较简单,我们一步步来看:

1、配置缓存

配置缓存首先要指定缓存目录和缓存大小,这两个可以根据项目的需求来确定,然后使用 OkHttpClient..Builder()cache()方法来配置缓存对象。这里的OkHttpClient是一个单例,保证了只有一个缓存缓存目录的入口。配置代码如下:

public class OkHttpManager {
   private OkHttpClient client;

   private OkHttpManager() {
       // 缓存目录
       File file = new File(Environment.getExternalStorageDirectory(), "a_cache");
       // 缓存大小
       int cacheSize = 10 * 1024 * 1024;
       client = new OkHttpClient.Builder()
               .cache(new Cache(file, cacheSize)) // 配置缓存
               .build();
   }

   public static OkHttpManager getInstance() {
       return OkHttpHolder.instance;
   }

   private static class OkHttpHolder {
       private static final OkHttpManager instance = new OkHttpManager();
   }
   ......
}

到这里就完成了基本配置工作,不要忘了处理权限问题,因为缓存功能需要存储空间的读写权限。

如果客户端和服务端已经协商好了,在接口的响应包含合适的Cache-Control响应头,表示缓存的策略,例如Cache-Control:max-age=60,表示缓存的有效期为60秒。

这个响应头是实现缓存的一个重点,如果包含合适的Cache-Control响应头,在无论网络连接是否正常的情况下请求接口数据,如果在缓存有效期内则直接从缓存读取数据,超过有效期会重新请求接口数据。

列举几个常用的Cache-control响应头的可选值:

  • must-revalidate,一旦缓存过期,必须向服务器重新请求,不得使用过期内容

  • no-cache,不使用缓存

  • no-store,不缓存请求的响应

  • no-transform,不得对响应进行转换或转变

  • public,任何响应都可以被缓存,即使响应默认是不可缓存或仅私有缓存可存的

  • private,表明响应只能被单个用户缓存,不能作为共享缓存(即代理服务器不能缓存它)

  • proxy-revalidate,与must-revalidate类似,但它仅适用于共享缓存(例如代理),并被私有缓存忽略。

  • max-age,缓存的有效时间

  • s-maxage,指定响应在公共缓存中的最大存活时间,它覆盖max-age和expires字段。

所以目前的问题是,如果响应不包含合适的Cache-Control响应头,该如何处理,这也是接下来主要讨论的问题。

2、拦截器

由于客户端和服务端不是同一团队,或者客户端使用了第三方接口等原因,无法进行协商,导致接口的响应没有合适的Cache-Control响应头,或者缓存已被禁用。这种情况下要让缓存功能正常工作,就需要使用自定义拦截器了,通过拦截器给请求的响应(Response)添加合适的Cache-Control响应头即可,这样问题就得到了解决!

不了解 okhttp 拦截器的可以先看官网的文档,很详细:github.com/square/okht…

看一下拦截器如何实现:


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

       //设置响应的缓存时间为60秒,即设置Cache-Control头,并移除pragma消息头,因为pragma也是控制缓存的一个消息头属性
       originResponse = originResponse.newBuilder()
               .removeHeader("pragma")
               .header("Cache-Control", "max-age=60")
               .build();

       return originResponse;
   }


拦截请求的响应,先移除pragma,然后手动设置Cache-Control响应头。

把定义好的拦截器添加到OkHttpClient中:


client = new OkHttpClient.Builder()
               .cache(new Cache(file, cacheSize))
               .addNetworkInterceptor(new NetCacheInterceptor())
               .build();


3、测试


public class OkHttpManager {    private OkHttpClient client;
   ......    public void asyncGet(Callback callback) {
       Request request = new Request.Builder()
               .url("http://publicobject.com/helloworld.txt")
               .build();
       client.newCall(request).enqueue(callback);
   }
}


以下是发起请求、以及回调的代码:


OkHttpManager.getInstance().asyncGet(new Callback() {
               @Override
               public void onFailure(Call call, IOException e)
{
                   Log.e("failure", e.toString());
               }

               @Override
               public void onResponse(Call call, Response response) throws IOException
{
                   if (response.isSuccessful()) {
                       if (response.networkResponse() != null) {
                           Log.e("network", response.body().string().length() + "");
                       } else if (response.cacheResponse() != null) {
                           if (Utils.isNetworkAvailable(context)) {
                               Log.e("cache", response.body().string().length() + "");
                           } else {
                               Log.e("cache(no network)", response.body().string().length() + "");
                           }
                       }
                   }
               }
           });


如果响应是从网络请求得到的,那么response.networkResponse()不为空,如果是从缓存中得到的response.cacheResponse()不为空,以此来打印不同 log 观察缓存功能是否能正常工作,这里打印了响应的 boay 长度。

下边是在60秒内发起了若干次请求,即便断开网络连接也能正常的从缓存读取数据,超过60秒会重新请求数据,这也验证了我们的缓存功能可以正常工作了:



缓存功能的具体实现是通过 DiskLruCache 完成的,在之前配置的缓存目录可以找到对应的缓存文件:


okhttp 缓存实践


4、okhttp 缓存策略

CacheControl类提供了如下两个默认的缓存策略:

  • CacheControl.FORCE_NETWORK,即强制使用网络请求

  • CacheControl.FORCE_CACHE,即强制使用本地缓存,如果无可用缓存则返回一个code为504的响应

根据默认缓存策略的实现方式,我们可以通过CacheControl.Builder()定制自己的缓存策略,可选的设置方法如下:

  • noCache(),不使用缓存,使用网络请求

  • noStore(),不使用缓存也不存储缓存数据

  • maxAge(),缓存的有效时间,超过该时间会重新请求数据

  • maxStale(),超过缓存有效时间后,可继续使用旧缓存的时间,之后需要重新请求数据

  • minFresh(),增加额外的缓存的有效时间,之后需要重新请求数据

  • onlyIfCached(),使用缓存,不使用网络请求

  • noTransform(),不接受经过转码的响应

  • immutable(),缓存有效时间内,响应不会变化,避免服务器处理304响应

了解了这些配置方法后,修改之前的asyncGet()方法,创建一个CacheControl,并添加到Request


public void asyncGet(Callback callback) {
       CacheControl cacheControl = new CacheControl.Builder()
               .maxStale(10, TimeUnit.SECONDS)
               .maxAge(10, TimeUnit.SECONDS)
               .build();

       Request request = new Request.Builder()
               .url("http://publicobject.com/helloworld.txt")
               .cacheControl(cacheControl)
               .build();

       client.newCall(request).enqueue(callback);
   }


Request添加CacheControl配置,就相当于给给Request添加了对应的Cache-Control请求头!!!

我们设置maxAge为10秒、maxStale为10秒,此时拦截器中设置的Cache-Control响应头还是60秒,测试下效果:


okhttp 缓存实践

可以看出,当时间间隔大于20秒会重新请求数据,即超过maxAge时间+maxStale时间



我们修改maxAge为100秒再测试下效果:


okhttp 缓存实践

可以看出,当时间间隔大于70秒会重新请求数据,即Cache-Control响应头时间+maxStale时间



所以当通过CacheControl类设置的缓存时间大于Cache-Control响应头时间,缓存有效时间为Cache-Control响应头时间,否则为CacheControl类设置的缓存时间。

所以我们可以给有需要的接口请求通过CacheControl类设置缓存策略,然后在拦截器中判断请求是否包含Cache-Control请求头,如果有就把Cache-Control请求头添加到响应中去,这样问题就解决了,修改后的拦截器如下:


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

       if (!TextUtils.isEmpty(request.header("Cache-Control"))){
           originResponse = originResponse.newBuilder()
                   .removeHeader("pragma")
                   .header("Cache-Control", request.header("Cache-Control"))
                   .build();
       }

       return originResponse;
   }
}


内容就这些了,不合理的地方还望指出。


推荐阅读:









温馨提示:

回复“学习资源” ,获取学习视频。


文章不易,如果觉得写得好,扫码关注一下点个赞,是我最大的动力。

关注我,一定会有意想不到的东西等你:


每天专注分享Android干货

备注:程序圈LT

版权声明:本站内容全部来自于腾讯微信公众号,属第三方自助推荐收录。《okhttp 缓存实践》的版权归原作者「程序圈LT」所有,文章言论观点不代表Lambda在线的观点, Lambda在线不承担任何法律责任。如需删除可联系QQ:516101458

文章来源: 阅读原文

相关阅读

关注程序圈LT微信公众号

程序圈LT微信公众号:androidCode

程序圈LT

手机扫描上方二维码即可关注程序圈LT微信公众号

程序圈LT最新文章

精品公众号随机推荐

上一篇 >>

Grammar Tales Bundle