网络访问组件六- 让 okhttp 支持 post缓存

参考:

  1. http://www.jianshu.com/p/2710ed1e6b48

整体代码与示例,请参考:

https://github.com/zhaoyubetter/basenet
至此网络模块的封装告一段落;

为什么需要POST缓存

大环境所致,在servlet中,有2个方法,分别是 doGet, doPost,要么在 doGet中,转发到了doPost,要么反之,springMVC,已记不清了。
所以这就造成了,有时候,我们真的需要 为 post添加缓存;

为post请求添加缓存原理

参考图片:
在 application 级别拦截请求,因为:应用拦截器允许短路而不调用 Chain.proceed(),即中止调用
判断如果是 post,如果缓存有效,直接返回response,让后续的拦截器无法执行;
其他缓存的内容,几乎都是 Cache.java那套;少量修改;


图片来自网络

具体实现:

  1. 为 OkhttpClient添加应用拦截器:

     final OkHttpClient.Builder builder = new OkHttpClient.Builder();
     builder.connectTimeout(NetConfig.getInstance().getTimeOut(), TimeUnit.MILLISECONDS);
     builder.readTimeout(NetConfig.getInstance().getTimeOut(), TimeUnit.MILLISECONDS);
     builder.writeTimeout(NetConfig.getInstance().getTimeOut(), TimeUnit.MILLISECONDS);
    
     /* ==设置拦截器== */
     // 设置缓存
     File cacheDir = new File(NetConfig.getInstance().getCacheDir());
     // GET 形式缓存设置
     Cache cache = new Cache(cacheDir, NetConfig.getInstance().getCacheSize());
     builder.cache(cache).addNetworkInterceptor(new NetCacheInterceptor());        // 设置缓存拦截器
     // 日志拦截
     if (NetConfig.getInstance().isDebug()) {
         builder.addInterceptor(new LoggerInterceptor());
     }
     // 是否允许POST 形式缓存设置
     if (NetConfig.getInstance().isEnablePostCache()) {
         builder.addInterceptor(new PostCacheInterceptor());
     }
    
  2. 新增类 NetPostCache.java, 此类,就是 copy 了 Cache类,然后修改
    其put方法,让其支持post,与 获取key方法,如下:

public static String key(Request request) {
        String cUrl = request.url().toString();
        if (request.body() != null) {
            Buffer buffer = new Buffer();
            try {
                // 避免post重复,这里采用value来凭借,因key不好获取
                // 如果有上传下载文件,此处为 ProgressRequestBody
                if (request.body() instanceof MultipartBody) {
                    final List<MultipartBody.Part> parts = ((MultipartBody) request.body()).parts();
                    /**
                     * 接受字符串格式的参数,其他忽略
                     * @see lib.basenet.okhttp.OkHttpRequest#getRequestBody mParams
                     */
                    for (MultipartBody.Part p : parts) {
                        if (null == p.body().contentType()) {
                            p.body().writeTo(buffer);
                        }
                    }
                }
                String params = buffer.readString(Charset.forName("UTF-8")); //获取请求参数
                cUrl += params;
            } catch (IOException e) {
                e.printStackTrace();
            } finally {
                Util.closeQuietly(buffer);
            }

        }
        return ByteString.encodeUtf8(cUrl).md5().hex();
    }
  1. 应用级拦截器:PostCacheInterceptor.java 代码片段
/**
 * post缓存,从应用拦截器层,拦截
 * Created by zhaoyu on 2017/4/26.
 */
public class PostCacheInterceptor implements Interceptor {

    /**
     * 缓存Post请求
     */
    final NetPostCache mPostCache;

    public PostCacheInterceptor() {
        File cacheDir = new File(NetConfig.getInstance().getCacheDir() + "/post");
        mPostCache = new NetPostCache(cacheDir, NetConfig.getInstance().getCacheSize());
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        final Request request = chain.request();

        // 如果是post请求,并且设置了缓存,则在这里进行拦截,如果缓存有效,后续的拦截器将不执行
        if ("POST".equalsIgnoreCase(request.method()) && (null != request.cacheControl() && !request.cacheControl().noStore())) {
            // 强制刷新,删除旧有post缓存
            checkForceRefresh(request);

            // 以下代码逻辑来家:okhttp3 源码中的 CacheInterceptor.java,模拟其运行
            Response cacheCandidate = mPostCache != null ? mPostCache.get(request) : null;
            long now = System.currentTimeMillis();
            CacheStrategy strategy = new CacheStrategy.Factory(now, chain.request(), cacheCandidate).get();
            Request networkRequest = strategy.networkRequest;
            Response cacheResponse = strategy.cacheResponse;

            if (mPostCache != null) {
                mPostCache.trackResponse(strategy);
            }

            if (cacheCandidate != null && cacheResponse == null) {
                closeQuietly(cacheCandidate.body()); // The mPostCache candidate wasn't applicable. Close it.
            }

            // 有则从缓存中返回,直接跳过后面的拦截器,不访问网络了
            // If we don't need the network, we're done.
            if (networkRequest == null) {
                return cacheResponse.newBuilder()
                        .cacheResponse(stripBody(cacheResponse))
                        .build();
            }

            Response networkResponse = null;
            try {
                // 执行网络请求,并包装一下
                networkResponse = chain.proceed(request);
            } finally {
                // If we're crashing on I/O or otherwise, don't leak the mPostCache body.
                if (networkResponse == null && cacheCandidate != null) {
                    closeQuietly(cacheCandidate.body());
                }
            }

            if (HttpHeaders.hasBody(networkResponse)) {
                CacheRequest cacheRequest = mPostCache.put(networkResponse);
                networkResponse = cacheWritingResponse(cacheRequest, networkResponse);
            }

            // 当 onSuccess调用时,会写入缓存
            return networkResponse;
        }

        return chain.proceed(request);
    }

注意事项:

post 缓存时,因 唯一key,不好定位,只支持 请求参数为 键值对(key-value)form 表单形式,对于上传文件,下载文件形式的post,请求,一律无效;

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,577评论 18 399
  • 一. Java基础部分.................................................
    wy_sure阅读 3,789评论 0 11
  • 缓存分类 http请求有服务端和客户端之分。因此缓存也可以分为两个类型服务端侧和客户端侧。 缓存——服务端常见的服...
    安仔夏天勤奋阅读 587评论 1 0
  • 东南赛区 顺着美国东海岸的海岸线往南走,伴随着美丽的沙滩,我们来到拥有着美国最温暖湿润空气,也最适宜居住的地方,N...
    纸鸢江南阅读 356评论 0 0