retrofit2 and okhttp download and upload progress

okhttp瓜挽、retrofit 2未提供上傳晨抡、下載的進(jìn)度回調(diào)派昧,但是很多應(yīng)用在UI顯示方面需要加入進(jìn)度顯示特笋。實(shí)現(xiàn)方式如下:

========

下載進(jìn)度及攔截器:

public class DownloadProgressInterceptor implements Interceptor {
  private DownloadProgressListener progressListener;

  public DownloadProgressInterceptor(DownloadProgressListener progressListener) {
    this.progressListener = progressListener;
  }

  @Override public Response intercept(Chain chain) throws IOException {
    Response originalResponse = chain.proceed(chain.request());
    return originalResponse.newBuilder()
        .body(new DownloadProgressResponseBody(originalResponse.body(), progressListener))
        .build();
  }

  private static class DownloadProgressResponseBody extends ResponseBody {

    private final ResponseBody responseBody;
    private final DownloadProgressListener progressListener;
    private BufferedSource bufferedSource;

    public DownloadProgressResponseBody(ResponseBody responseBody,
        DownloadProgressListener progressListener) {
      this.responseBody = responseBody;
      this.progressListener = progressListener;
    }

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

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

    @Override public BufferedSource source() throws IOException {
      if (bufferedSource == null) {
        bufferedSource = Okio.buffer(source(responseBody.source()));
      }
      return bufferedSource;
    }

    private Source source(Source source) {
      return new ForwardingSource(source) {
        long totalBytesRead = 0L;

        @Override public long read(Buffer sink, long byteCount) throws IOException {
          long bytesRead = super.read(sink, byteCount);
          // read() returns the number of bytes read, or -1 if this source is exhausted.
          totalBytesRead += bytesRead != -1 ? bytesRead : 0;

          if (null != progressListener) {
            progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
          }
          return bytesRead;
        }
      };
    }
  }

  public interface DownloadProgressListener {
    void update(long bytesRead, long contentLength, boolean done);
  }
}

上傳進(jìn)度

/**
 * Decorates an OkHttp request body to count the number of bytes written when writing it. Can
 * decorate any request body, but is most useful for tracking the upload progress of large
 * multipart requests.
 *
 * @author Leo Nikkil?
 */
public class CountingRequestBody extends RequestBody {

  protected RequestBody delegate;
  protected Listener listener;

  protected CountingSink countingSink;

  public CountingRequestBody(RequestBody delegate, Listener listener) {
    this.delegate = delegate;
    this.listener = listener;
  }

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

  @Override public long contentLength() {
    try {
      return delegate.contentLength();
    } catch (IOException e) {
      e.printStackTrace();
    }
    return -1;
  }

  @Override public void writeTo(BufferedSink sink) throws IOException {
    BufferedSink bufferedSink;

    countingSink = new CountingSink(sink);
    bufferedSink = Okio.buffer(countingSink);

    delegate.writeTo(bufferedSink);

    bufferedSink.flush();
  }

  protected final class CountingSink extends ForwardingSink {

    private long bytesWritten = 0;

    public CountingSink(Sink delegate) {
      super(delegate);
    }

    @Override public void write(Buffer source, long byteCount) throws IOException {
      super.write(source, byteCount);

      bytesWritten += byteCount;
      listener.onRequestProgress(bytesWritten, contentLength());
    }
  }

  public static interface Listener {

    public void onRequestProgress(long bytesWritten, long contentLength);
  }
}

上傳進(jìn)度攔截器

public class UpLoadProgressInterceptor implements Interceptor {
  private CountingRequestBody.Listener progressListener;

  public UpLoadProgressInterceptor(CountingRequestBody.Listener progressListener) {
    this.progressListener = progressListener;
  }

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

    if (originalRequest.body() == null) {
      return chain.proceed(originalRequest);
    }

    Request progressRequest = originalRequest.newBuilder()
        .method(originalRequest.method(),
            new CountingRequestBody(originalRequest.body(), progressListener))
        .build();

    return chain.proceed(progressRequest);
  }
}

====

使用方式:

如果只是在okhttp中使用剃浇,上傳可以使用CountingRequestBody類巾兆,下載可以把DownloadProgressResponseBody單獨(dú)抽出來(lái)使用。使用時(shí)new出來(lái)虎囚,傳入相應(yīng)參數(shù)即可角塑。

如果是在retrofit 2中使用,可以使用攔截器的方式淘讥。類似DownloadProgressInterceptor圃伶,UpLoadProgressInterceptor,關(guān)鍵代碼如下:

OkHttpClientManager.getInstance()
    .getOkHttpClient()
    .networkInterceptors()
    .add(upLoadProgressInterceptor);

/*上傳圖片請(qǐng)求*/
  @Multipart @POST(ConstantsNetInterface.COURSE_UPLOAD_PIC) Call<UploadPicBean> uploadPic(
      @PartMap Map<String, ?> params);

RequestBody fileBody = RequestBody.create(MediaType.parse("image/*"), imgFile);
        mParams = new HashMap<>();//請(qǐng)求參數(shù)
        mParams.put("file\"; filename=\"" + imgFile.getName() + "", fileBody);

===

關(guān)于Batow提的問(wèn)題(為方便例子使用了Rxjava,不使用Rxjava則是用下面的Call來(lái)處理):

@GET("{path}") @Streaming Call<ResponseBody> download(@Path("path") String path);

@GET("{path}") @Streaming Observable<ResponseBody> downloadFile(@Path("path") String path);

public static void downloadFile(final String path, final Subscriber<Boolean> subscriber) {

  RetrofitManager.getInstance()
      .createDownloadApiService(Api.class)
      .downloadFile(path)
      .map(new Func1<ResponseBody, Boolean>() {
        @Override public Boolean call(ResponseBody responseBody) {
          return writeFileToSD(path, responseBody);
        }
      })
      .subscribeOn(Schedulers.io())
      .observeOn(AndroidSchedulers.mainThread())
      .subscribe(subscriber);
}

private static boolean writeFileToSD(String pathName, ResponseBody responseBody) {
  String sdStatus = Environment.getExternalStorageState();
  if (!sdStatus.equals(Environment.MEDIA_MOUNTED)) {
    Logger.d("SD card is not avaiable/writeable right now.");
    return false;
  }
  try {

    String fileName = pathName.substring(pathName.lastIndexOf("/"));

    Logger.d("fileName-->" + fileName);

    File path = Environment.getExternalStorageDirectory();
    File file = new File(path.getPath() + fileName);

    if (!file.exists()) {
      Logger.d("Create the file:" + file.getPath());
      file.createNewFile();
    }
    FileOutputStream stream = new FileOutputStream(file);
    byte[] buf = responseBody.bytes();
    stream.write(buf);
    stream.close();

    return true;
  } catch (Exception e) {
    Logger.e("Error on writeFilToSD.");
    e.printStackTrace();
  }
  return false;
}

NetworkWrapper.downloadFile(path, new Subscriber<Boolean>() {
  @Override public void onCompleted() {
    Logger.d("onCompleted");
  }

  @Override public void onError(Throwable e) {
    Logger.d("onError:" + e);
  }

  @Override public void onNext(Boolean aBoolean) {
    Logger.d("onNext" + aBoolean);

    if (aBoolean) {
      Toast.makeText(DownloadActivity.this, "pic download finish", Toast.LENGTH_LONG)
          .show();
    }
  }
});


===

enjoy it蒲列!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末窒朋,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子蝗岖,更是在濱河造成了極大的恐慌侥猩,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,635評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件抵赢,死亡現(xiàn)場(chǎng)離奇詭異欺劳,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)瓣俯,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門杰标,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人彩匕,你說(shuō)我怎么就攤上這事腔剂。” “怎么了驼仪?”我有些...
    開(kāi)封第一講書(shū)人閱讀 168,083評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵掸犬,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我绪爸,道長(zhǎng)湾碎,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,640評(píng)論 1 296
  • 正文 為了忘掉前任奠货,我火速辦了婚禮介褥,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘递惋。我一直安慰自己柔滔,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,640評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布萍虽。 她就那樣靜靜地躺著睛廊,像睡著了一般。 火紅的嫁衣襯著肌膚如雪杉编。 梳的紋絲不亂的頭發(fā)上超全,一...
    開(kāi)封第一講書(shū)人閱讀 52,262評(píng)論 1 308
  • 那天咆霜,我揣著相機(jī)與錄音,去河邊找鬼嘶朱。 笑死蛾坯,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的疏遏。 我是一名探鬼主播偿衰,決...
    沈念sama閱讀 40,833評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼改览!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起缤言,我...
    開(kāi)封第一講書(shū)人閱讀 39,736評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤宝当,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后胆萧,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體庆揩,經(jīng)...
    沈念sama閱讀 46,280評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,369評(píng)論 3 340
  • 正文 我和宋清朗相戀三年跌穗,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了订晌。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,503評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡蚌吸,死狀恐怖锈拨,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情羹唠,我是刑警寧澤奕枢,帶...
    沈念sama閱讀 36,185評(píng)論 5 350
  • 正文 年R本政府宣布,位于F島的核電站佩微,受9級(jí)特大地震影響缝彬,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜哺眯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,870評(píng)論 3 333
  • 文/蒙蒙 一谷浅、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧奶卓,春花似錦一疯、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,340評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至瑟幕,卻和暖如春磕蒲,著一層夾襖步出監(jiān)牢的瞬間留潦,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,460評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工辣往, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留兔院,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,909評(píng)論 3 376
  • 正文 我出身青樓站削,卻偏偏與公主長(zhǎng)得像坊萝,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子许起,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,512評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,283評(píng)論 25 707
  • 今天項(xiàng)目需要將采集到List數(shù)據(jù)過(guò)濾,SoEasy!刷刷的寫(xiě)下了以下代碼: 一運(yùn)行,結(jié)果 先說(shuō)怎么解決,就是Ito...
    苗校長(zhǎng)閱讀 632評(píng)論 0 0
  • 從前我是一個(gè)負(fù)能量爆棚的人园细,心情不好或遇到不順心的事時(shí)惦积,我總要向身邊很多朋友吐槽,把心中所有的不滿都要傾倒出來(lái)猛频,似...
    經(jīng)營(yíng)生活閱讀 692評(píng)論 1 1
  • 社群經(jīng)濟(jì)狮崩,作為一種新興的變現(xiàn)形式,因?yàn)樗目焖賯鞑ズ途薮蟮挠绊懥β寡埃蝗藷崤跄啦瘛S谑牵泻坪剖幨幍娜巳河縼?lái)毡熏,又有無(wú)數(shù)人...
    小團(tuán)子?jì)寢?/span>閱讀 511評(píng)論 0 3
  • 流星劃過(guò)的天際有溫暖 在彌漫我雙手合十默默 許下心愿如夢(mèng)如花的日子已漸行漸遠(yuǎn)煙雨婆娑的記憶卻依舊 燦爛 我想起多年...
    福爾摩雞閱讀 770評(píng)論 2 2