Retrofit 2.0 超能实践(四),完成大文件断点下载

作者:码小白 (Tamic)
文/简书 博客
本文出自:http://www.jianshu.com/p/582e0a4a4ee9 码小白

通过前几篇系统的介绍和综合运用,忘记介绍文件下载功能了,有朋友问到,目前APP文件下载主要有断点续传,多线程并发下载,多类型下载,今天就介绍下其Retrofit下载文件功能,已结合RxJava。

Retrofit系列导读:

ApiService

编写API,执行下载接口功能。

public interface ApiService {
  @Streaming
  @GET
  Observable<ResponseBody> downloadFile(@Url String   fileUrl);
}

url由于是可变的,因此用 @URL 注解符号来进行指定,大文件官方建议用 @Streaming 来进行注解,不然会出现IO异常,小文件可以忽略不注入。如果想进行断点续传的话 可以在此加入header,但不建议直接在api中写死,每个下载的请求大小是不同的,在拦截器加入更为妥善。

DownLoadManager

实现一个下载管理者 来进行文件写入,类型判断等,如果想做完善,可以判断下http的请求头 content-length, content- type, RANGE 第一个用来判断文件大小,第二个文件类型,第三个是文件从哪儿开始下载,如果对下载来源校验可以加入referer, 不是目标来源的可以不予下载权限。

public class DownLoadManager {

  private static final String TAG = "DownLoadManager";

 private static String APK_CONTENTTYPE = "application/vnd.android.package-archive";

 private static String PNG_CONTENTTYPE = "image/png";

 private static String JPG_CONTENTTYPE = "image/jpg";

 private static String fileSuffix="";

 public static boolean  writeResponseBodyToDisk(Context context, ResponseBody body) {

    Log.d(TAG, "contentType:>>>>"+ body.contentType().toString());

    String type = body.contentType().toString();

    if (type.equals(APK_CONTENTTYPE)) {

       fileSuffix = ".apk";
    } else if (type.equals(PNG_CONTENTTYPE)) {
        fileSuffix = ".png";
    }

    // 其他类型同上 自己判断加入.....


    String path = context.getExternalFilesDir(null) + File.separator + System.currentTimeMillis() + fileSuffix;

    Log.d(TAG, "path:>>>>"+ path);

    try {
        // todo change the file location/name according to your needs
        File futureStudioIconFile = new File(path);

        InputStream inputStream = null;
        OutputStream outputStream = null;

        try {
            byte[] fileReader = new byte[4096];

            long fileSize = body.contentLength();
            long fileSizeDownloaded = 0;

            inputStream = body.byteStream();
            outputStream = new FileOutputStream(futureStudioIconFile);

            while (true) {
                int read = inputStream.read(fileReader);

                if (read == -1) {
                    break;
                }

                outputStream.write(fileReader, 0, read);

                fileSizeDownloaded += read;

                Log.d(TAG, "file download: " + fileSizeDownloaded + " of " + fileSize);
            }

            outputStream.flush();


            return true;
        } catch (IOException e) {
            return false;
        } finally {
            if (inputStream != null) {
                inputStream.close();
            }

            if (outputStream != null) {
                outputStream.close();
            }
        }
    } catch (IOException e) {
        return false;
    }
}

}
上面只是简单的对不同类型文件进行了判断,其他类型参考http协议描述类型自行加入,断点续传目前暂时没实现,基于HttpClinet下载的介绍很多,关键思想是记录一条下载产生后的RANGE 到数据库里,每条下载行对应一条数据,下载ID是区分唯一的主键, 包含filename, fileSize, fileType, downTime, downRange status基本可满足多线程下载数据要求,在Retrofit结合RXJava后 解决了线程安全问题,实现多线程下载就更so yi z, 这里我不做过多的介绍。

调用下载

 OkHttpClient okHttpClient = new OkHttpClient.Builder()
            .build();
 Retrofit retrofit = new Retrofit.Builder()
            .client(okHttpClient)
            .baseUrl(url)
            .build();
Api Service apiService = retrofit.create(ApiService.class);

apiService..download(url1,
                    new Subscriber<ResponseBody>() {
                        @Override
                        public void onCompleted() {

                        }

                        @Override
                        public void onError(Throwable e) {

                        }

                        @Override
                        public void onNext(ResponseBody responseBody) {

                            if (DownLoadManager.writeResponseBodyToDisk(MainActivity.this, responseBody)) {
                                Toast.makeText(MainActivity.this, "Download is sucess", Toast.LENGTH_LONG).show();
                            }

                        }
                    });
        }
    });

然我们可以在header中加入上次下载的进度大小,就可以实现基本的断点下载了,多线程下载目前业内主要由下面思想实现,我们可以请求到文件总长度的时候,均分三段大小区间,来开启三个新线程去下载,下载完后再以唯一的文件ID,将三段文件以此追加到一个文件就可以了,当然在retrofit结合RxJava,你无需开启新线程,只需订阅一下 Subscriber到IO线程即可,这里注意的是你需要判断最后的文件大小和HashCode来进行验证文件完整性,不然视频文件丢包没多大影响,最多会卡帧,但是apk却无法解析安装了。

断点下载

apiServiece

@GET
@Streaming
Observable<Response<ResponseBody>> download(@Header("Range") String range, @Url String url);

API

DownLoadInfos里面包含name,length, url等,这里不再贴了。

DownloadType 里面记录要有statslastModifydownloadedsavepath等, 直接看API

 public Observable<DownloadInfos> download(@NonNull final String url, @NonNull final String saveName,
   @Nullable final String savePath) {
return downloadDispatcher(url, saveName, savePath);
}





private Observable<DownloadStatus> downloadDispatcher(final String url, final String saveName, final String savePath) {
    return getDownloadType(url)
            .flatMap(new Func1<DownloadType, Observable<DownloadStatus>>() {
                @Override
                public Observable<DownloadInfos> call(DownloadType type) {
                    try {
                        type.prepare();
                    } catch (IOException | ParseException e) {
                        return Observable.error(e);
                    }
                    try {
                        return type.start();
                    } catch (IOException e) {
                        return Observable.error(e);
                    }
                }
            })
            .doOnCompleted(new Action0() {
                @Override
                public void call() {
                    mDownloadManager.delete(url);
                }
            })
            .doOnError(new Action1<Throwable>() {
                @Override
                public void call(Throwable throwable) {
                   
                    mDownloadManager.delete(url);
                }
            })
            .doOnUnsubscribe(new Action0() {
                @Override
                public void call() {
                    mDownloadManager.delete(url)
            });
}

开始下载:

    @Override
    Observable<DownloadInfos> start() {
        Log.i(TAG, "Normal download start!!");
        return mDownloadHelper.getDownloadApi().download(null, mUrl)
                .subscribeOn(Schedulers.io())
                .flatMap(new Func1<Response<ResponseBody>, Observable<DownloadStatus>>() {
                    @Override
                    public Observable<DownloadStatus> call(final Response<ResponseBody> response) {
                        return normalSave(response);
                    }
                }).onBackpressureLatest().retry(new Func2<Integer, Throwable, Boolean>() {
                    @Override
                    public Boolean call(Integer integer, Throwable throwable) {
                        return mDownloadHelper.retry(integer, throwable);
                    }
                });
    }

调用

 DownloadAgenti.getInstance(mContext)
                .observeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Subscriber<DownloadInfos>() {
                    @Override
                    public void onCompleted() {
                        // todo
                    }

                    @Override
                    public void onError(Throwable e) {
                       todo
                    }

                    @Override
                    public void onNext(final DownloadStatus status) {
                       todo
                    }
                }); 

总结

步骤:

请求文件总大小

根据机型高低,分配多个线程下载

记录下载进度,大小,类型等到数据库

同时更新UI和通知栏,提示用户

下载结束后更新数据库下载数据,追加组合文件

判断文件大小,检验文件大小

下载功能是每个应用必须的功能,因此下载还是比较重要的一个模块,好的下载架构 会考虑到设备的CPU大小,网络状态,以及外部sdcard的大小,动态进行性能,流量分配,方便用户更好的体验和使用你的APP.
具体可以阅读 - 基于Retrofit2.0 封装的超好用的RetrofitClient工具类 中的写法

项目github:https://github.com/Tamicer/FastDownloader

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

推荐阅读更多精彩内容