快捷導(dǎo)航

使用Retrofit下載文件并實(shí)現(xiàn)進(jìn)度監(jiān)聽的示例

更新時(shí)間：2018年08月02日 09:59:16 作者：四月葡萄

這篇文章主要介紹了使用Retrofit下載文件并實(shí)現(xiàn)進(jìn)度監(jiān)聽的示例，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

1.前言

最近要做一個(gè)帶進(jìn)度條下載文件的功能，網(wǎng)上看了一圈，發(fā)現(xiàn)好多都是基于 OkHttpClient 添加攔截器來實(shí)現(xiàn)的，個(gè)人覺得略顯復(fù)雜，所以還是采用最簡(jiǎn)單的方法來實(shí)現(xiàn)：基于文件寫入來進(jìn)行進(jìn)度的監(jiān)聽。

2.實(shí)現(xiàn)步驟

2.1 設(shè)計(jì)監(jiān)聽接口

根據(jù)需求設(shè)計(jì)一下接口：

public interface DownloadListener {
  void onStart();//下載開始

  void onProgress(int progress);//下載進(jìn)度

  void onFinish(String path);//下載完成

  void onFail(String errorInfo);//下載失敗
}

如果還需下載速度等等，可以自行設(shè)計(jì)接口和參數(shù)。

2.2 編寫網(wǎng)絡(luò)接口Service

public interface DownloadService {

  @Streaming
  @GET
  Call<ResponseBody> download(@Url String url);
}

跟正常接口寫法基本一致，需要注意的是要添加 @Streaming 注解。

默認(rèn)情況下， Retrofit 在處理結(jié)果前會(huì)將服務(wù)器端的 Response 全部讀進(jìn)內(nèi)存。如果服務(wù)器端返回的是一個(gè)非常大的文件，則容易發(fā)生oom。使用 @Streaming 的主要作用就是把實(shí)時(shí)下載的字節(jié)就立馬寫入磁盤，而不用把整個(gè)文件讀入內(nèi)存。

2.3 開始網(wǎng)絡(luò)請(qǐng)求

public class DownloadUtil {

  public static void download(String url, final String path, final DownloadListener downloadListener) {

    Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://www.xxx.com")
        //通過線程池獲取一個(gè)線程，指定callback在子線程中運(yùn)行。
        .callbackExecutor(Executors.newSingleThreadExecutor())
        .build();

    DownloadService service = retrofit.create(DownloadService.class);

    Call<ResponseBody> call = service.download(url);
    call.enqueue(new Callback<ResponseBody>() {
      @Override
      public void onResponse(@NonNull Call<ResponseBody> call, @NonNull final Response<ResponseBody> response) {
        //將Response寫入到從磁盤中，詳見下面分析
        //注意，這個(gè)方法是運(yùn)行在子線程中的
        writeResponseToDisk(path, response, downloadListener);
      }

      @Override
      public void onFailure(@NonNull Call<ResponseBody> call, @NonNull Throwable throwable) {
        downloadListener.onFail("網(wǎng)絡(luò)錯(cuò)誤～");
      }
    });
  }
}

在 Retrofit 中， Callback 默認(rèn)運(yùn)行在主線程中，如果我們直接將 Response 寫到磁盤這一操作直接運(yùn)行在主線程中，會(huì)報(bào) NetworkOnMainThreadException 異常。所以必須放在子線程中去運(yùn)行。

目前為止，都還是一個(gè)很正常的網(wǎng)絡(luò)請(qǐng)求。所以，還是很簡(jiǎn)單的。下面重頭戲來了。

2.4 監(jiān)聽下載進(jìn)度

private static void writeResponseToDisk(String path, Response<ResponseBody> response, DownloadListener downloadListener) {
    //從response獲取輸入流以及總大小
    writeFileFromIS(new File(path), response.body().byteStream(), response.body().contentLength(), downloadListener);
  }

  private static int sBufferSize = 8192;

  //將輸入流寫入文件
  private static void writeFileFromIS(File file, InputStream is, long totalLength, DownloadListener downloadListener) {
    //開始下載
    downloadListener.onStart();

    //創(chuàng)建文件
    if (!file.exists()) {
      if (!file.getParentFile().exists())
        file.getParentFile().mkdir();
      try {
        file.createNewFile();
      } catch (IOException e) {
        e.printStackTrace();
        downloadListener.onFail("createNewFile IOException");
      }
    }

    OutputStream os = null;
    long currentLength = 0;
    try {
      os = new BufferedOutputStream(new FileOutputStream(file));
      byte data[] = new byte[sBufferSize];
      int len;
      while ((len = is.read(data, 0, sBufferSize)) != -1) {
        os.write(data, 0, len);
        currentLength += len;
        //計(jì)算當(dāng)前下載進(jìn)度
        downloadListener.onProgress((int) (100 * currentLength / totalLength));
      }
      //下載完成，并返回保存的文件路徑
      downloadListener.onFinish(file.getAbsolutePath());
    } catch (IOException e) {
      e.printStackTrace();
      downloadListener.onFail("IOException");
    } finally {
      try {
        is.close();
      } catch (IOException e) {
        e.printStackTrace();
      }
      try {
        if (os != null) {
          os.close();
        }
      } catch (IOException e) {
        e.printStackTrace();
      }
    }
  }

所以，實(shí)際就是通過監(jiān)聽文件的寫入來實(shí)現(xiàn)進(jìn)度的監(jiān)聽。

2.5 使用例子

String url = "";
      String path = "";
      DownloadUtil.download(url, path, new DownloadListener() {
        @Override
        public void onStart() {
          //運(yùn)行在子線程
        }

        @Override
        public void onProgress(int progress) {
          //運(yùn)行在子線程
        }

        @Override
        public void onFinish(String path) {
          //運(yùn)行在子線程
        }

        @Override
        public void onFail(String errorInfo) {
          //運(yùn)行在子線程
        }
      });

注意，上面的回調(diào)都是運(yùn)行在子線程中。如果需要更新UI等操作，可以使用Handler等來進(jìn)行更新。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: