第三方开源库 OKHttp - 上传进度监听和自定义缓存

最近这段时间的确有点忙,要处理的事情比较多,发现好久没有更新文章了,以后尽量一周更新一篇,这周要视频的人也特多,希望我们看了要多花点时间消化,最好我们自己能写一下总结,千万别又还给我了。那位替我打广告的哥们,虽然我不知道你是谁,但是打心底里说声谢谢。

OkHttp 我们总共花了四次去分析源码,花那么多时间去看源码到底是为了啥?其实每个人想的都不一样,有人觉得会用就很不错了,对于我来说我就是喜欢琢磨琢磨而已。但是开发过程中分析源码,对于我们其实会有很多好处,比如现在我想要监听文件上传的进度,又或者是我想要自定义缓存,又或者说我想要断点下载等等。当然这些网上都有,大家也都基本一个模板,但关键我们是否明白为什么要这么写?是否能够看得懂人家的代码?而这一切的一切在分析源码之后,我们不光能看懂别人为什么这么写,还能从源码的角度自己去分析扩展。

这里分析开发中最常见的几个扩展:

  1. 文件上传进度监听
  2. 自定义缓存(要求:有网 30s 内请求读缓存,无网直接读缓存)
  3. 多线程断点下载

1.文件上传进度监听


我们先看下 OkHttp 上传文件是怎么写的,至于 OkHttp 怎么使用?这里不做过多的介绍,而且对于文件上传我们之前自己动手写过,直接贴代码:

        File file = new File(Environment.getExternalStorageDirectory(), "test.png");

        OkHttpClient httpClient = new OkHttpClient();
        // 构建请求 Body , 这个我们之前自己动手写过
        MultipartBody.Builder builder = new MultipartBody.Builder()
                .setType(MultipartBody.FORM);
        builder.addFormDataPart("platform", "android");
        builder.addFormDataPart("file", file.getName(),
                RequestBody.create(MediaType.parse(guessMimeType(file.getAbsolutePath())), file));
        // 构建一个请求
        final Request request = new Request.Builder()
                .url("https://www.easyjoke.com/xxxxx")
                .post(builder.build()).build();
        // new RealCall 发起请求
        Call call = httpClient.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                e.printStackTrace();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                Log.e("TAG", response.body().string());
            }
        });

怎么去添加进度?这个时候尽可能运用所有的脑细胞。先跑到源码中 CallServerInterceptor 这个拦截器,之前分析源码的时候说过,所有的读写操作都在这里,有这么一行向服务器写数据的代码:

BufferedSink bufferedRequestBody = Okio.buffer(requestBodyOut);
// 调用 RequestBody的writeTo方法向服务器去写数据
request.body().writeTo(bufferedRequestBody);

看到上面这行代码,我们能够分析出,最终肯定会来到 MultipartBody 中的 writeTo 的方法。那么我们在这个方法里面去做处理不就行了,我们自己扩展一个 ExRequestBody 去继承 MultipartBody 然后复写 writeTo 方法做处理,但是发现 MultipartBody 是一个 final 类,不能继承这个时候怎么办?嗨,醒醒,不能继承怎么办?还好之前学了设计模式,设计模式学了就是要用的,用 静态代理 不就刚好能解决这个问题?

/**
 * description: RequestBody代理
 * author: Darren on 2017/11/24 10:16
 * email: 240336124@qq.com
 * version: 1.0
 */
public class ExRequestBody extends RequestBody {
    // 被代理的对象
    private RequestBody mOriginalBody;
    // 总的长度
    private long mTotalLength = -1;
    // 当前上传的长度
    private long mCurrentLength = -1;

    public ExRequestBody(RequestBody requestBody) {
        this.mOriginalBody = requestBody;
    }

    @Nullable
    @Override
    public MediaType contentType() {
        return mOriginalBody.contentType();
    }

    @Override
    public long contentLength() throws IOException {
        return mOriginalBody.contentLength();
    }

    @Override
    public void writeTo(BufferedSink sink) throws IOException {
        // Log.e("TAG", "进来了");
        // 获取总的长度
        mTotalLength = contentLength();

        // 这里又是一个代理模式
        ForwardingSink forwardingSink = new ForwardingSink(sink) {
            @Override
            public void write(Buffer source, long byteCount) throws IOException {
                super.write(source, byteCount);
                // 写了多少数据叠加起来
                mCurrentLength += byteCount;
                // 我们要自己写一个接口回调出去
                // Log.e("TAG", "-> " + mCurrentLength + " -> " + mContentLength);
            }
        };
        sink = Okio.buffer(forwardingSink);
        // 最终调用者还是被代理对象的方法
        mOriginalBody.writeTo(sink);
        // 一定要刷新,之前说过的连接池,复用等等
        sink.flush();
    }
}

2. 自定义缓存(要求:有网 30s 内请求读缓存,无网直接读缓存)


关于缓存的处理,我们需要了解我们之前所讲的缓存策略,熟读 CacheInterceptor 这个拦截器的源码就可以了,网上我看了很多例子,虽说效果都达到了,但准确的说应该分为两个部分去处理:
CacheRequestInterceptor

public class CacheRequestInterceptor implements Interceptor {
    private Context context;

    public CacheRequestInterceptor(Context context) {
        this.context = context;
    }

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

        if(!NetworkUtil.isNetworkAvailable(context)){
            // 直接读缓存
            request = request.newBuilder()
                    .cacheControl(CacheControl.FORCE_CACHE)
                    .build();
        }

        Response response = chain.proceed(request);
        return response;
    }
}

CacheResponseInterceptor

public class CacheResponseInterceptor implements Interceptor {

    @Override
    public Response intercept(Chain chain) throws IOException {
        // 有网的情况下 30s 之内访问同一接口,会直接读缓存,不会重复访问
        Request request = chain.request();
        Response response = chain.proceed(request);
        
        int maxAge = 30;
        return response.newBuilder()
                .removeHeader("Pragma")
                .removeHeader("Cache-Control")
                // max-age 是一种特例,既包含缓存策略又包含缓存过期时间
                .header("Cache-Control", "max-age=" + maxAge)
                .build();
    }
}

使用

.cache(cache)//开启缓存
// 一个添加在前
.addInterceptor(new CacheRequestInterceptor(MainActivity.this))
// 一个添加在后
.addNetworkInterceptor(new CacheResponseInterceptor())

OkHttp 自带的这种缓存的扩展还是会有一些坑的,比如不支持 post 数据缓存,某些特定接口也不应该这样去处理,所以我们还得会自己管理缓存,当然如果你对源码已经足够了解,什么事干不出来?

所有分享大纲:Android进阶之旅 - 系统架构篇

视频讲解地址:http://pan.baidu.com/s/1gfmzfYN

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