[老实李] Retrofit2+OKHttp3实现缓存

首先需要注意的是:使用OKHttp特有的方法只能对GET请求进行缓存。(我自己就在这个坑爬了很久,因为我们公司的所有接口全部是POST请求)。如果想要对POST请求进行缓存的话还需要进一步的处理。这一点从OKHttp的源码中也可以找到答案。(Cache类中的put方法,当请求方法不是GET的时候直接返回一个null)

private CacheRequest put(Response response) throws IOException {
  String requestMethod = response.request().method();

  if (HttpMethod.invalidatesCache(response.request().method())) {
    try {
      remove(response.request());
    } catch (IOException ignored) {
      // The cache cannot be written.
    }
    return null;
  }
  if (!requestMethod.equals("GET")) {
    // Don't cache non-GET responses. We're technically allowed to cache
    // HEAD requests and some POST requests, but the complexity of doing
    // so is high and the benefit is low.
    return null;
  }

  if (OkHeaders.hasVaryAll(response)) {
    return null;
  }

  Entry entry = new Entry(response);
  DiskLruCache.Editor editor = null;
  try {
    editor = cache.edit(urlToKey(response.request()));
    if (editor == null) {
      return null;
    }
    entry.writeTo(editor);
    return new CacheRequestImpl(editor);
  } catch (IOException e) {
    abortQuietly(editor);
    return null;
  }
}

好,下面我们就分别来看在GET和POST方法中缓存的实现。

一、GET缓存

1、首先定义两个Interceptor,分别作为有网络时的拦截器和无网络时的拦截器。关于拦截器的自定义,网上到处都是,我这里就写了两个最简单的。

public class NoNetInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {

    Request request = chain.request();
    boolean connected = HttpNetUtil.isNetConnected(ETApplication.getInstance());
    if (!connected) {
        request = request.newBuilder()
                .cacheControl(CacheControl.FORCE_CACHE)
                .build();
        Log.e("etNet", "have not network and to read local cache");
        Response response = chain.proceed(request);
        return response.newBuilder()
                .header("Cache-Control", "public, only-if-cached, max-stale=3600")
                .removeHeader("Pragma")
                .build();
    }
    return chain.proceed(request);

}

}

public class NetInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
boolean connected = HttpNetUtil.isNetConnected(ETApplication.getInstance());
if(connected){
//if have network will cache 90s
Log.e("etNet","online cache 90s");
Response response = chain.proceed(request);
int maxTime = 90;
return response.newBuilder()
.removeHeader("Pragma")
.header("Cache-Control", "public, max-age=" + maxTime)
.build();
}
//if have not network will immediate return
return chain.proceed(request);
}

}

2、在Retrofit中使用

public class RetrofitUtil {
    private static Retrofit retrofit;
    //over time
    private static final long DUFAULT_TIME_OUT = 5;
    /**
    * @return retrofit instance
    */
    public static Retrofit getRetrofitInstance() {
        if (retrofit == null) {
            File file = new File(ETApplication.getInstance().getApplicationContext().getCacheDir(), "rxCache");
            //cache size 10M
            int cacheSize = 10 * 1024 * 1024;
            Cache cache = new Cache(file, cacheSize);
            OkHttpClient client = new OkHttpClient.Builder()
                    .cache(cache)
                    .addInterceptor(new NoNetInterceptor())
                    .addNetworkInterceptor(new NetInterceptor())
                    .connectTimeout(DUFAULT_TIME_OUT, TimeUnit.SECONDS) //连接超时
                    .writeTimeout(DUFAULT_TIME_OUT, TimeUnit.SECONDS)  //写入超时
                    .readTimeout(DUFAULT_TIME_OUT, TimeUnit.SECONDS)  //读取超时
                    .build();
            retrofit = new Retrofit.Builder()
                    .client(client)
                    .baseUrl(Urls.severURL)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();

        }
        return retrofit;
    }

    /**
    * @return interface instance
    *
    */
    public static APIRetrofit getAPIRetrofitInstance() {
        return getRetrofitInstance().create(APIRetrofit.class);
    }

}

二、POST请求缓存

我的做法是用GreenDao来进行缓存。
拦截器参考:http://blog.csdn.net/u010429311/article/details/59116706
GreenDao参考:http://www.jianshu.com/p/4986100eff90

public class RewriteCacheControlInterceptor implements Interceptor {

    private EtCacheDao mEtCacheDao;

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        String url = request.toString();
        Log.e("OkHttp","url:"+url);
        Buffer buffer = new Buffer();
        request.body().writeTo(buffer);
        String params = buffer.readString(Charset.forName("UTF-8"));
        Log.e("OkHttp","params:"+params);
        mEtCacheDao = ETApplication.getInstance().getDaoSession().getEtCacheDao();
        Response response;
        if (HttpNetUtil.isNetConnected(ETApplication.getInstance())) {
            int maxAge = 60 * 60*24;
            Response originalResponse = chain.proceed(request);
            MediaType type = originalResponse.body().contentType();
            byte[] bs = originalResponse.body().bytes();
            response = originalResponse.newBuilder()
                    .removeHeader("Pragma")
                    .removeHeader("Cache-Control")
                    .header("Cache-Control", "public, max-age=" + maxAge)
                    .body(ResponseBody.create(type, bs))
                    .build();
            Log.e("OKHttp","response:"+new String(bs,"UTF-8"));
            EtCache etCache = new EtCache(url+params, new String(bs, "UTF-8"));
            List<EtCache> list = mEtCacheDao.queryBuilder()
                    .where(EtCacheDao.Properties.UrlAndParams.eq(url+params))
                    .list();
            if (list==null||list.size()==0) {
                mEtCacheDao.insert(etCache);
            }

        } else {
            String b =  "";
            List<EtCache> list = mEtCacheDao.queryBuilder()
                    .where(EtCacheDao.Properties.UrlAndParams.eq(url+params))
                    .list();
            if (list != null && list.size() > 0) {
                b = list.get(0).getResponse();
            }

            Log.e("OkHttp", "request:" + url);
            Log.e("OkHttp", "request method:" + request.method());
            Log.e("OkHttp", "response body:" + b);
            int maxStale = 60 * 60 * 24 * 28;
            response = new Response.Builder()
                    .removeHeader("Pragma")
                    .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                    .body(ResponseBody.create(MediaType.parse("application/json"), b.getBytes()))
                    .request(request)
                    .protocol(Protocol.HTTP_1_1)
                    .code(200)
                    .build();
        }
        return response;
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • 缓存的一般思路 下面是我理解的网络请求框架的缓存基本实现。大致的过程是有缓存用缓存的数据,没缓存发起http请求取...
    原件阅读 2,794评论 3 12
  • 本文包括:1、Filter简介2、Filter是如何实现拦截的?3、Filter开发入门4、Filter的生命周期...
    廖少少阅读 7,239评论 3 56
  • 前一篇文章(也是我在简书上的第一篇技术文章.)讲了Android三剑客的基础用法和简单封装,有一些封装只是一笔带过...
    小枫阅读 14,214评论 9 82
  • 告诉你一个秘密: 一开始,我根本没有意识到“输出”的重要性,但是,当我践行了之后,同时思考了之后,发现它是必不可少...
    丁昆朋阅读 507评论 3 4