綜述
在Retrofit2.0使用詳解這篇文章中詳細介紹了retrofit的用法。并且在retrofit中我們可以通過ResponseBody進行對文件的下載。但是在retrofit中并沒有為我們提供顯示下載進度的接口。在項目中，若是用戶下載一個文件，無法實時給用戶顯示下載進度，這樣用戶的體驗也是非常差的。那么下面就介紹一下在retrofit用于文件的下載如何實時跟蹤下載進度。
演示
Retrofit文件下載進度更新的實現
在retrofit2.0中他依賴于Okhttp，所以如果我們需要解決這個問題還需要從這個OKhttp來入手。在Okhttp中有一個依賴包Okio。Okio也是有square公司所開發，它是java.io和java.nio的補充，使用它更容易訪問、存儲和處理數據。在這里需要使用Okio中的Source類。在這里Source可以看做InputStream。對于Okio的詳細使用在這里就不在介紹。下面來看一下具體實現。
在這里我們首先寫一個接口，用于監聽下載的進度。對于文件的下載，我們需要知道下載的進度，文件的總大小，以及是否操作完成。于是有了下面這樣一個接口。
package com.ljd.retrofit.progress;/** * Created by ljd on 3/29/16. */public interface ProgressListener { /** * @param progress 已經下載或上傳字節數 * @param total 總字節數 * @param done 是否完成 */ void onProgress(long progress, long total, boolean done);}對于文件的下載我們需要重寫ResponseBody類中的一些方法。
package com.ljd.retrofit.progress;import java.io.IOException;import okhttp3.MediaType;import okhttp3.ResponseBody;import okio.Buffer;import okio.BufferedSource;import okio.ForwardingSource;import okio.Okio;import okio.Source;/** * Created by ljd on 3/29/16. */public class ProgressResponseBody extends ResponseBody { private final ResponseBody responseBody; private final ProgressListener progressListener; private BufferedSource bufferedSource; public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) { this.responseBody = responseBody; this.progressListener = progressListener; } @Override public MediaType contentType() { return responseBody.contentType(); } @Override public long contentLength() { return responseBody.contentLength(); } @Override public BufferedSource source() { 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); totalBytesRead += bytesRead != -1 ? bytesRead : 0; progressListener.onProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1); return bytesRead; } }; }} 在上面ProgressResponseBody類中，我們計算已經讀取文件的字節數，并且調用了ProgressListener接口。所以這個ProgressListener接口是在子線程中運行的。
下面就來看一下是如何使用這個ProgressResponseBody。
package com.ljd.retrofit.progress;import android.util.Log;import java.io.IOException;import okhttp3.Interceptor;import okhttp3.OkHttpClient;/** * Created by ljd on 4/12/16. */public class ProgressHelper { private static ProgressBean progressBean = new ProgressBean(); private static ProgressHandler mProgressHandler; public static OkHttpClient.Builder addProgress(OkHttpClient.Builder builder){ if (builder == null){ builder = new OkHttpClient.Builder(); } final ProgressListener progressListener = new ProgressListener() { //該方法在子線程中運行 @Override public void onProgress(long progress, long total, boolean done) { Log.d("progress:",String.format("%d%% done/n",(100 * progress) / total)); if (mProgressHandler == null){ return; } progressBean.setBytesRead(progress); progressBean.setContentLength(total); progressBean.setDone(done); mProgressHandler.sendMessage(progressBean); } }; //添加攔截器，自定義ResponseBody，添加下載進度 builder.networkInterceptors().add(new Interceptor() { @Override public okhttp3.Response intercept(Chain chain) throws IOException { okhttp3.Response originalResponse = chain.proceed(chain.request()); return originalResponse.newBuilder().body( new ProgressResponseBody(originalResponse.body(), progressListener)) .build(); } }); return builder; } public static void setProgressHandler(ProgressHandler progressHandler){ mProgressHandler = progressHandler; }} 我們通過為OkhttpClient添加一個攔截器來使用我們自定義的ProgressResponseBody。并且在這里我們可以通過實現ProgressListener接口。來獲取下載進度了。但是在這里依然存在一個問題，剛才說到這個ProgressListener接口運行在子線程中。也就是說在ProgressListener這個接口中我們無法進行ui操作。而我們獲取文件下載的進度往往則是需要一個進度條進行ui顯示。顯然這并不是我們想要的結果。
在這個時候我們就需要使用Handler了。我們可以通過Handler將子線程中的ProgressListener的數據發送到ui線程中進行處理。也就是說我們在ProgressListener接口中的操作只是將其參數通過Handler發送出去。很顯然在上面的代碼中我們通過ProgressHandler來發送消息。那么就來看一下具體操作。
這里我們創建一個對象，用于存放ProgressListener中的參數。
package com.example.ljd.retrofit.pojo;import java.util.ArrayList;import java.util.List;/** * Created by ljd on 3/29/16. */public class RetrofitBean { private Integer total_count; private Boolean incompleteResults; private List<Item> items = new ArrayList<Item>(); /** * * @return * The totalCount */ public Integer getTotalCount() { return total_count; } /** * * @param totalCount * The total_count */ public void setTotalCount(Integer totalCount) { this.total_count = totalCount; } /** * * @return * The incompleteResults */ public Boolean getIncompleteResults() { return incompleteResults; } /** * * @param incompleteResults * The incomplete_results */ public void setIncompleteResults(Boolean incompleteResults) { this.incompleteResults = incompleteResults; } /** * * @return * The items */ public List<Item> getItems() { return items; }}然后我們在創建一個ProgressHandler類。
package com.ljd.retrofit.progress;import android.os.Handler;import android.os.Looper;import android.os.Message;/** * Created by ljd on 4/12/16. */public abstract class ProgressHandler { protected abstract void sendMessage(ProgressBean progressBean); protected abstract void handleMessage(Message message); protected abstract void onProgress(long progress, long total, boolean done); protected static class ResponseHandler extends Handler{ private ProgressHandler mProgressHandler; public ResponseHandler(ProgressHandler mProgressHandler, Looper looper) { super(looper); this.mProgressHandler = mProgressHandler; } @Override public void handleMessage(Message msg) { mProgressHandler.handleMessage(msg); } }} 上面的ProgressHandler他是一個抽象類。在這里我們需要通過Handler對象進行發送和處理消息。于是定義了兩個抽象方法sendMessage和handleMessage。之后又定義了一個抽象方法onProgress來處理下載進度的顯示，而這個onProgress則是我們需要在ui線程進行調用。最后創建了一個繼承自Handler的ResponseHandler內部類。為了避免內存泄露我們使用static關鍵字。
下面來創建一個DownloadProgressHandler類，他繼承于ProgressHandler，用來發送和處理消息。
package com.ljd.retrofit.progress;import android.os.Looper;import android.os.Message;/** * Created by ljd on 4/12/16. */public abstract class DownloadProgressHandler extends ProgressHandler{ private static final int DOWNLOAD_PROGRESS = 1; protected ResponseHandler mHandler = new ResponseHandler(this, Looper.getMainLooper()); @Override protected void sendMessage(ProgressBean progressBean) { mHandler.obtainMessage(DOWNLOAD_PROGRESS,progressBean).sendToTarget(); } @Override protected void handleMessage(Message message){ switch (message.what){ case DOWNLOAD_PROGRESS: ProgressBean progressBean = (ProgressBean)message.obj; onProgress(progressBean.getBytesRead(),progressBean.getContentLength(),progressBean.isDone()); } }} 在這里我們接收到消息以后調用抽象方法onProgress，這樣一來我們只需要創建一個DownloadProgressHandler對象，實現onProgress即可。
對于上面的分析，下面我們就來看一下是如何使用的。
package com.example.ljd.retrofit.download;import android.app.ProgressDialog;import android.os.Environment;import android.os.Looper;import android.support.v7.app.AppCompatActivity;import android.os.Bundle;import android.util.Log;import com.example.ljd.retrofit.R;import com.ljd.retrofit.progress.DownloadProgressHandler;import com.ljd.retrofit.progress.ProgressHelper;import java.io.BufferedInputStream;import java.io.File;import java.io.FileOutputStream;import java.io.IOException;import java.io.InputStream;import butterknife.ButterKnife;import butterknife.OnClick;import okhttp3.OkHttpClient;import okhttp3.ResponseBody;import retrofit2.Call;import retrofit2.Callback;import retrofit2.Response;import retrofit2.Retrofit;import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;import retrofit2.converter.gson.GsonConverterFactory;public class DownloadActivity extends AppCompatActivity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_download); ButterKnife.bind(this); } @Override protected void onDestroy() { ButterKnife.unbind(this); super.onDestroy(); } @OnClick(R.id.start_download_btn) public void onClickButton(){ retrofitDownload(); } private void retrofitDownload(){ //監聽下載進度 final ProgressDialog dialog = new ProgressDialog(this); dialog.setProgressNumberFormat("%1d KB/%2d KB"); dialog.setTitle("下載"); dialog.setMessage("正在下載，請稍后..."); dialog.setProgressStyle(ProgressDialog.STYLE_HORIZONTAL); dialog.setCancelable(false); dialog.show(); Retrofit.Builder retrofitBuilder = new Retrofit.Builder() .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) .addConverterFactory(GsonConverterFactory.create()) .baseUrl("http://msoftdl.360.cn"); OkHttpClient.Builder builder = ProgressHelper.addProgress(null); DownloadApi retrofit = retrofitBuilder .client(builder.build()) .build().create(DownloadApi.class); ProgressHelper.setProgressHandler(new DownloadProgressHandler() { @Override protected void onProgress(long bytesRead, long contentLength, boolean done) { Log.e("是否在主線程中運行", String.valueOf(Looper.getMainLooper() == Looper.myLooper())); Log.e("onProgress",String.format("%d%% done/n",(100 * bytesRead) / contentLength)); Log.e("done","--->" + String.valueOf(done)); dialog.setMax((int) (contentLength/1024)); dialog.setProgress((int) (bytesRead/1024)); if(done){ dialog.dismiss(); } } }); Call<ResponseBody> call = retrofit.retrofitDownload(); call.enqueue(new Callback<ResponseBody>() { @Override public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) { try { InputStream is = response.body().byteStream(); File file = new File(Environment.getExternalStorageDirectory(), "12345.apk"); FileOutputStream fos = new FileOutputStream(file); BufferedInputStream bis = new BufferedInputStream(is); byte[] buffer = new byte[1024]; int len; while ((len = bis.read(buffer)) != -1) { fos.write(buffer, 0, len); fos.flush(); } fos.close(); bis.close(); is.close(); } catch (IOException e) { e.printStackTrace(); } } @Override public void onFailure(Call<ResponseBody> call, Throwable t) { } }); }}總結
對于上面的實現我們可以看出是通過OkhttpClient實現的。也正是由于在retrofit2.0中它依賴于OkHttp，因此對于OkHttp的功能retrofit也都具備。利用這一特性，我們可以通過定制OkhttpClient來配置我們的retrofit。
源碼下載：https://github.com/lijiangdong/retrofit-example
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持武林網。
新聞熱點
疑難解答
