基于Retrofit+Okio+RxBus实现文件下载（带下载进度）

墨蓝 2022-09-23 05:53 135阅读 0赞

转载地址：http://www.tailyou.site/2016/06/22/%E5%9F%BA%E4%BA%8ERetrofit-Okio-RxBus%E5%AE%9E%E7%8E%B0%E6%96%87%E4%BB%B6%E4%B8%8B%E8%BD%BD%EF%BC%88%E5%B8%A6%E4%B8%8B%E8%BD%BD%E8%BF%9B%E5%BA%A6%EF%BC%89/\#rd?sukey=3997c0719f15152082403b18fc5108edcba8ef69abbe1891a9450ae7921f97ab7f9f472fd055d7b55360001d25a6d031

## 一、前言 ##

Retrofit是一个非常优秀、非常流行的简化HTTP请求的库，有个小的不足是下载文件时，没有提供显示文件下载进度的回调，这在下载文件时无疑会影响用户体验，本文基于Retrofit+Okio+RxBus实现了带下载进度的文件下载功能。

## 二、效果 ##

![22469670.jpg][]

## 三、实现过程 ##

### 3.1 下载文件的代码 ###

接下来我们从代码入手，分析如何使用及其实现原理。假如现在要下载　[http://hengdawb-app.oss-cn-hangzhou.aliyuncs.com/app-debug.apk][http_hengdawb-app.oss-cn-hangzhou.aliyuncs.com_app-debug.apk]　对应的APK文件，对应代码如下：

*  baseUrl：是网络请求基地址，必须以　/　结束；
 *  fileName：是文件名，与baseUrl组成完整的下载地址；
 *  fileStoreDir：是文件下载后在本地的存储目录；
 *  fileStoreName：是文件在本地的存储名称。

### 3.2 FileCallback ###

下载文件的代码非常简单，从上面的代码中可以看到一个叫FileCallback的类，其中有三个方法需要我们自己实现或重写，分别是onSuccess()，onFailure()，progress()，progress()方法有两个参数，progress和total,分别表示文件已下载的大小和总大小，我们只需要将这两个参数不断更新到UI上即可。FileCallback的代码如下：

<table style=""> 
 <tbody style=""> 
 <tr style=""> 
 <td style=""> <pre style="">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 </pre> </td> 
 <td style=""> <pre style="">package com.hengda.tailyou.retrofitfiledownload.fileload; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import okhttp3.ResponseBody; import retrofit2.Call; import retrofit2.Callback; import retrofit2.Response; import rx.android.schedulers.AndroidSchedulers; import rx.functions.Action1; import rx.schedulers.Schedulers; import rx.subscriptions.CompositeSubscription; /** * 作者：Tailyou （祝文飞） * 时间：2016/4/5 08:52 * 邮箱：tailyou@163.com * 描述：Retrofit 文件下载回调 */ public abstract class FileCallback implements Callback&lt;ResponseBody&gt; {
 /** * 订阅下载进度 */ private CompositeSubscription rxSubscriptions = new CompositeSubscription(); /** * 目标文件存储的文件夹路径 */ private String destFileDir; /** * 目标文件存储的文件名 */ private String destFileName; public FileCallback(String destFileDir, String destFileName) {
 this.destFileDir = destFileDir; this.destFileName = destFileName; subscribeLoadProgress(); } public void onSuccess(File file) {
 unsubscribe(); } public abstract void progress(long progress, long total); @Override public void onResponse(Call&lt;ResponseBody&gt; call, Response&lt;ResponseBody&gt; response) {
 try {
 saveFile(response); } catch (IOException e) {
 e.printStackTrace(); } } /** * 保存 * * @param response * @return * @throws IOException */ public File saveFile(Response&lt;ResponseBody&gt; response) throws IOException {
 InputStream is = null; byte[] buf = new byte[2048]; int len; FileOutputStream fos = null; try {
 is = response.body().byteStream(); File dir = new File(destFileDir); if (!dir.exists()) {
 dir.mkdirs(); } File file = new File(dir, destFileName); fos = new FileOutputStream(file); while ((len = is.read(buf)) != -1) {
 fos.write(buf, 0, len); } fos.flush(); onSuccess(file); return file; } finally {
 try {
 if (is != null) is.close(); } catch (IOException e) {
 } try {
 if (fos != null) fos.close(); } catch (IOException e) {
 } } } /** * 订阅文件下载进度 */ private void subscribeLoadProgress() {
 rxSubscriptions.add(RxBus.getDefault() .toObservable(FileLoadEvent.class) .onBackpressureBuffer() .subscribeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribe(new Action1&lt;FileLoadEvent&gt;() {
 @Override public void call(FileLoadEvent fileLoadEvent) {
 progress(fileLoadEvent.getProgress(), fileLoadEvent.getTotal()); } })); } /** * 取消订阅，防止内存泄漏 */ private void unsubscribe() {
 if (!rxSubscriptions.isUnsubscribed()) {
 rxSubscriptions.unsubscribe(); } } } </pre> </td> 
 </tr> 
 </tbody> 
</table>

代码比较多，跟下载进度相关的其实非常少，可以看到咱们实现的progress()方法在是在RxBus收到FileLoadEvent后才调用的，熟悉RxBus的人肯定可以想到，下载进度的实时更新是通过以下几步实现的：

*  1）RxBus发送FileLoadEvent对象；
 *  2）FileLoadEvent中包含当前下载进度和文件总大小；
 *  3）FileCallback订阅RxBus发送的FileLoadEvent；
 *  4）根据接收到的FileLoadEvent更新下载Dialog的UI。

### 3.3 何时何处发送的FileLoadEvent？ ###

使用Retrofit进行网络操作时，通常都与OKHttpClient结合使用；我们可以用OKHttpClient来设置连接超时，请求超时，网络拦截器等。这里我们也需要使用自己的OKHttpClient，在网络拦截器中使用我们自定义的ResponseBody。代码如下：

FileResponseBody重写了source()方法，在Okio.buffer中处理下载进度相关的逻辑，也是在这个时候发送的FileLoadEvent的，到这里整个过程就差不多全了。

## 总结 ##

其实整个过程并不复杂，总结起来就一下几点：

*  1）使用自定义的OKHttpClient，在自定义的FileResponseBody中发送文件下载进度；
 *  2）在FileCallback中订阅FileLoadEvent；
 *  3）根据FileLoadEvent中的参数，调用progress()，刷新下载UI。

源码已上传Github，[RetrofitFileDownload][]

[22469670.jpg]: http://o7o5gmjol.bkt.clouddn.com/16-6-22/22469670.jpg
[http_hengdawb-app.oss-cn-hangzhou.aliyuncs.com_app-debug.apk]: http://hengdawb-app.oss-cn-hangzhou.aliyuncs.com/app-debug.apk
[RetrofitFileDownload]: https://github.com/Tailyou/RetrofitFileDownload