retrofit2 and okhttp download and upload progress

okhttp、retrofit 2未提供上传、下载的进度回调,但是很多应用在UI显示方面需要加入进度显示。实现方式如下:

========

下载进度及拦截器:

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);
  }
}

上传进度

/**
 * 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);
  }
}

上传进度拦截器

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单独抽出来使用。使用时new出来,传入相应参数即可。

如果是在retrofit 2中使用,可以使用拦截器的方式。类似DownloadProgressInterceptor,UpLoadProgressInterceptor,关键代码如下:

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

/*上传图片请求*/
  @Multipart @POST(ConstantsNetInterface.COURSE_UPLOAD_PIC) Call<UploadPicBean> uploadPic(
      @PartMap Map<String, ?> params);

RequestBody fileBody = RequestBody.create(MediaType.parse("image/*"), imgFile);
        mParams = new HashMap<>();//请求参数
        mParams.put("file\"; filename=\"" + imgFile.getName() + "", fileBody);

===

关于Batow提的问题(为方便例子使用了Rxjava,不使用Rxjava则是用下面的Call来处理):

@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!

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,800评论 25 707
  • 今天项目需要将采集到List数据过滤,SoEasy!刷刷的写下了以下代码: 一运行,结果 先说怎么解决,就是Ito...
    苗校长阅读 626评论 0 0
  • 从前我是一个负能量爆棚的人,心情不好或遇到不顺心的事时,我总要向身边很多朋友吐槽,把心中所有的不满都要倾倒出来,似...
    经营生活阅读 686评论 1 1
  • 社群经济,作为一种新兴的变现形式,因为它的快速传播和巨大的影响力,被人热捧。于是,有浩浩荡荡的人群涌来,又有无数人...
    小团子妈妈阅读 501评论 0 3
  • 流星划过的天际有温暖 在弥漫我双手合十默默 许下心愿如梦如花的日子已渐行渐远烟雨婆娑的记忆却依旧 灿烂 我想起多年...
    福尔摩鸡阅读 766评论 2 2