热门标签 | HotTags
当前位置:  开发笔记 > 运维 > 正文

okhttp3.4.1+retrofit2.1.0实现离线缓存的示例

关于Retrofit+OkHttp的强大这里就不多说了,还没了解的同学可以自行去百度。这篇文章主要讲如何利用Retrofit+OkHttp来

关于Retrofit+OkHttp的强大这里就不多说了,还没了解的同学可以自行去百度。这篇文章主要讲如何利用Retrofit+OkHttp来实现一个较为简单的缓存策略:

即有网环境下我们请求数据时,如果没有缓存或者缓存过期了,就去服务器拿数据,并且将新缓存保存下来,如果有缓存而且没有过期,则直接使用缓存。无网环境下我们请求数据时,缓存没过期则直接使用缓存,缓存过期了则无法使用,需要重新联网获取服务器数据。

缓存处理还是很有必要的,它有效的减少服务器负荷,降低延迟提升用户体验,同时也方便用户即使在没网络的情况下也能使用APP。

之前一直有一个疑惑,既然Retrofit已经是对OkHttp的一个封装了,为什么还一直说Retrofit+OkHttp要一起搭配使用,后来才知道其实OKHttp很重要的一个作用,就是对一些网络请求的配置,例如连接超时,读取超时,以及一些缓存配置等。

一、添加依赖

compile 'com.squareup.retrofit2:retrofit:2.1.0'
 compile 'com.squareup.retrofit2:converter-gson:2.1.0'
 compile 'com.squareup.okhttp3:okhttp:3.4.1'
 compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'

二、配置OkHttpClient(设置缓存路径和缓存文件大小)

File httpCacheDirectory = new File(Environment.getExternalStorageDirectory(), "HttpCache");//这里为了方便直接把文件放在了SD卡根目录的HttpCache中,一般放在context.getCacheDir()中
int cacheSize = 10 * 1024 * 1024;//设置缓存文件大小为10M
Cache cache = new Cache(httpCacheDirectory, cacheSize);
httpClient = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)//设置连接超时
    .readTimeout(10, TimeUnit.SECONDS)//读取超时
    .writeTimeout(10, TimeUnit.SECONDS)//写入超时
    .addNetworkInterceptor(REWRITE_CACHE_CONTROL_INTERCEPTOR)//添加自定义缓存拦截器(后面讲解),注意这里需要使用.addNetworkInterceptor
    .cache(cache)//把缓存添加进来
    .build();

三、配置Retrofit

retrofit = new Retrofit.Builder()
    .baseUrl(baseUrl)
    .client(httpClient)//把OkHttpClient添加进来
    .addConverterFactory(GsonConverterFactory.create())
    .build();

四、编写拦截器

我们知道其实Retrofit+OkHttp的缓存主要通过拦截器实现,所以主要做的功夫也在拦截器里面。

 static Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
  @Override
  public Response intercept(Chain chain) throws IOException {
   Request request = chain.request();
   //网上很多示例代码都对在request请求前对其进行无网的判断,其实无需判断,无网自动访问缓存
//   if(!NetworkUtil.getInstance().isConnected()){
//    request = request.newBuilder()
//      .cacheControl(CacheControl.FORCE_CACHE)//只访问缓存
//      .build();
//   }
   Response respOnse= chain.proceed(request);
   if (NetworkUtil.getInstance().isConnected()) {
    int maxAge = 60;//缓存失效时间,单位为秒
    return response.newBuilder()
      .removeHeader("Pragma")//清除头信息,因为服务器如果不支持,会返回一些干扰信息,不清除下面无法生效
      .header("Cache-Control", "public ,max-age=" + maxAge)
      .build();
   } else {
    //这段代码设置无效
//    int maxStale = 60 * 60 * 24 * 28; // 无网络时,设置超时为4周
//    return response.newBuilder()
//      .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
//      .removeHeader("Pragma")
//      .build();
   }
   return response;
  }
 };

到这里,其实已经可以实现了我们开头所说的缓存效果了。

但是,上面设置的每个接口缓存时间都一样,例如我现在想让不同接口的缓存数据失效时间都不一样,甚至有些接口不缓存数据,应该怎么做呢?其实也很简单

首先我们只需要在接口前面添加@Headers参数(max-age代表缓存时间,单位为秒,示例中表示缓存失效时间为60s,想要多少时间可以自行设置),不设置@Headers参数则不进行缓存。

@Headers("Cache-Control:public ,max-age=60")
@GET("getBusiness.action")//商店信息
Call getRestaurantInfo(@Query("userId") String userId,@Query("businessId") String businessId);

同时,我们的缓存拦截器也要做下简单的修改(去掉了之前的注释代码)

 static Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
  @Override
  public Response intercept(Chain chain) throws IOException {
   Request request = chain.request();
   Response respOnse= chain.proceed(request);
   if (NetworkUtil.getInstance().isConnected()) {
    //获取头部信息
    String cacheCOntrol=request.cacheControl().toString();
    return response.newBuilder()
      .removeHeader("Pragma")//清除头信息,因为服务器如果不支持,会返回一些干扰信息,不清除下面无法生效
      .header("Cache-Control", cacheControl)
      .build();
   }
   return response;
  }
 };

*注意:

1.只能缓存Get请求的接口,不能缓存Post请求的接口

2.OkHttpClient需要用.addNetworkInterceptor添加缓存拦截器,不能使用.addInterceptor,也无需两者同时使用。

3.此方法无需服务器端任何操作,适用于服务器端没有其他缓存策略,如果服务器端有自己的缓存策略代码应该做相应的修改,以适应服务器端。

附上所有代码:

/**
 * 简单封装的Retroit初始化类
 */
public class initRetrofit {
 private static String baseUrl = "http://202.171.212.154:8080/hh/";
 private static OkHttpClient httpClient;
 private static Retrofit retrofit;
 public static Retrofit initRetrofit() {
  //缓存路径和大小
  File httpCacheDirectory = new File(Environment.getExternalStorageDirectory(), "HttpCache");
  int cacheSize = 10 * 1024 * 1024;
  Cache cache = new Cache(httpCacheDirectory, cacheSize);
  //日志拦截器
  HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
  interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
  httpClient = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)//设置连接超时
    .readTimeout(10, TimeUnit.SECONDS)//读取超时
    .writeTimeout(10, TimeUnit.SECONDS)//写入超时
    .addInterceptor(interceptor)//添加日志拦截器
    .addNetworkInterceptor(REWRITE_CACHE_CONTROL_INTERCEPTOR)//添加缓存拦截器
    .cache(cache)//把缓存添加进来
    .build();
  retrofit = new Retrofit.Builder()
    .baseUrl(baseUrl)
    .client(httpClient)
    .addConverterFactory(GsonConverterFactory.create())
    .build();
  return retrofit;
 }

 public static RetrofitAPI getService() {
  return initRetrofit().create(RetrofitAPI.class);
 }

// //缓存拦截器,不同接口不同缓存
// static Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
//  @Override
//  public Response intercept(Chain chain) throws IOException {
//
//   Request request = chain.request();
//   Response respOnse= chain.proceed(request);
//
//   if (NetworkUtil.getInstance().isConnected()) {
//    String cacheCOntrol=request.cacheControl().toString();
//    return response.newBuilder()
//      .removeHeader("Pragma")//清除头信息,因为服务器如果不支持,会返回一些干扰信息,不清除下面无法生效
//      .header("Cache-Control", cacheControl)
//      .build();
//   }
//   return response;
//  }
// };
 //缓存拦截器,统一缓存60s
 static Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
  @Override
  public Response intercept(Chain chain) throws IOException {
   Request request = chain.request();
   Response respOnse= chain.proceed(request);
   if (NetworkUtil.getInstance().isConnected()) {
    int maxAge = 60*60*24*2;//缓存失效时间,单位为秒
    return response.newBuilder()
      .removeHeader("Pragma")//清除头信息,因为服务器如果不支持,会返回一些干扰信息,不清除下面无法生效
      .header("Cache-Control", "public ,max-age=" + maxAge)
      .build();
   }
   return response;
  }
 };
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


推荐阅读
  • 本文探讨了一个Web工程项目的需求,即允许用户随时添加定时任务,并通过Quartz框架实现这些任务的自动化调度。文章将介绍如何设计任务表以存储任务信息和执行周期,以及如何通过一个定期扫描机制自动识别并加载新任务到调度系统中。 ... [详细]
  • Git版本控制基础解析
    本文探讨了Git作为版本控制工具的基本概念及其重要性,不仅限于代码管理,还包括文件的历史记录与版本切换功能。通过对比Git与SVN,进一步阐述了分布式版本控制系统的独特优势。 ... [详细]
  • 使用jQuery与百度地图API实现地址转经纬度功能
    本文详细介绍了如何利用jQuery和百度地图API将地址转换为经纬度,包括申请API密钥、页面构建及核心代码实现。 ... [详细]
  • STM32代码编写STM32端不需要写关于连接MQTT服务器的代码,连接的工作交给ESP8266来做,STM32只需要通过串口接收和发送数据,间接的与服务器交互。串口三配置串口一已 ... [详细]
  • 本文介绍了一个基本的同步Socket程序,演示了如何实现客户端与服务器之间的简单消息传递。此外,文章还概述了Socket的基本工作流程,并计划在未来探讨同步与异步Socket的区别。 ... [详细]
  • RabbitMQ 核心组件解析
    本文详细介绍了RabbitMQ的核心概念,包括其基本原理、应用场景及关键组件,如消息、生产者、消费者、信道、交换机、路由键和虚拟主机等。 ... [详细]
  • 最新进展:作为最接近官方声明的信息源,本文吸引了大量关注。若需获取最新动态,请访问:lkhill.com/ccie-version-5-update ... [详细]
  • System Center Operations Manager 2007(简称SCOM 2007)作为MOM 2005的升级版,不仅整合了监控与管理功能,还显著简化了操作流程,提供了更加全面和精准的服务管理。 ... [详细]
  • 利用Cookie实现用户登录状态的持久化
    本文探讨了如何使用Cookie技术在Web应用中实现用户登录状态的持久化,包括Cookie的基本概念、优势及主要操作方法,并通过一个简单的Java Web项目示例展示了具体实现过程。 ... [详细]
  • 本文探讨了在SharePoint环境中使用BDC(Business Data Catalog)时遇到的问题及其解决策略,包括XML文件导入SSP后的不可见性问题以及与远程SQL Server 2005连接的难题。 ... [详细]
  • 本文详细介绍了跨站脚本攻击(XSS)的基本概念、工作原理,并通过实际案例演示如何构建XSS漏洞的测试环境,以及探讨了XSS攻击的不同形式和防御策略。 ... [详细]
  • 探索OpenWrt中的LuCI框架
    本文深入探讨了OpenWrt系统中轻量级HTTP服务器uhttpd的工作原理及其配置,重点介绍了LuCI界面的实现机制。 ... [详细]
  • Hadoop集群搭建:实现SSH无密码登录
    本文介绍了如何在CentOS 7 64位操作系统环境下配置Hadoop集群中的SSH无密码登录,包括环境准备、用户创建、密钥生成及配置等步骤。 ... [详细]
  • 本文探讨了在使用 MyBatis 进行批量数据处理时遇到的参数绑定异常问题,并提供了详细的解决方案。 ... [详细]
  • 利用Docker部署JupyterHub以支持Python协同开发
    本文介绍了如何通过Docker容器化技术安装和配置JupyterHub,以实现多用户的Python开发环境,特别适合团队协作场景。 ... [详细]
author-avatar
孙倩倩猫小窝W_199
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有