如何使用Retrofit進行文件下載

一、下載文件的準備工作

在開始使用 Retrofit 進行文件下載前，需要先添加相應的依賴庫，包括 Retrofit、OkHttp 和 Okio。Retrofit 和 OkHttp 是二者都是由 Square 公司開發的，因此在使用過程中它們之間可以無縫的結合使用。而 Okio 則是一個高效的 IO 操作庫，可以提供更好的流處理能力。

添加庫之後，我們需要先定義 Retrofit 構建器。在構建過程中指定 base url 和要使用的轉換器。同時還可以使用 OkHttp 客戶端進行更高效的網絡請求。

二、下載文件的實現

在下載文件的實現中，我們需要先定義 Retrofit 客戶端接口，以及相關的網絡請求方法。

下面是一個簡單的下載文件請求方法，其中 @Streaming 註解用於表示響應體不應該被整個加載到內存中，以防止內存溢出。

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

調用該接口方法時，只需要指定對應的文件 url 地址即可開始文件下載，並將對應的 ResponseBody 通過流寫入本地文件中。

// 首先創建 Retrofit 客戶端
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl(BASE_URL)
        .client(okHttpClient)
        .build();

// 創建 Retrofit 接口實現類對象
Api api = retrofit.create(Api.class);

// 調用 Retrofit 接口方法下載文件
Call<ResponseBody> call = api.downloadFileWithUrlSync(fileUrl);

// 獲取 ResponseBody 並進行文件寫入
ResponseBody response = call.execute().body();
if (response != null) {
    InputStream in = response.byteStream();
    FileOutputStream fos = new FileOutputStream(new File(filePath));
    byte[] buffer = new byte[1024];
    int len;
    while ((len = in.read(buffer)) != -1) {
        fos.write(buffer, 0, len);
    }
    fos.flush();
    fos.close();
    in.close();
}

三、下載進度的監聽與顯示

在進行文件下載時，我們通常需要顯示當前下載進度以及下載速度。為了實現這個功能，我們可以通過自定義實現 OkHttp 的攔截器來監控當前下載進度。同時，我們還需要通過主線程來更新 UI 組件顯示當前下載進度信息。

public class DownloadInterceptor implements Interceptor {
    // 下載進度監聽器
    private ProgressListener listener;
 
    public DownloadInterceptor(ProgressListener listener) {
        this.listener = listener;
    }
 
    @Override
    public Response intercept(Chain chain) throws IOException {
        Response originalResponse = chain.proceed(chain.request());
        return originalResponse.newBuilder()
                .body(new ProgressResponseBody(originalResponse.body(), listener))
                .build();
    }
}

在實際使用過程中，我們可以通過自定義的 ProgressListener 接口來監聽下載進度，並將當前進度信息通過回調方法傳遞給主線程 UI 組件進行顯示。其中包括已下載、總大小、下載速度等信息。

public interface ProgressListener {
    void onProgress(long bytesRead, long contentLength, boolean done);
}

最後，我們可以通過在 OkHttp 客戶端中添加自定義攔截器的方式來實現下載進度的監聽。

ProgressListener progressListener = new ProgressListener() {
    @Override
    public void onProgress(long bytesRead, long contentLength, boolean done) {
        // 更新 UI 組件顯示下載進度信息
    }
};

OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .addNetworkInterceptor(new DownloadInterceptor(progressListener))
        .build();

四、小結

使用 Retrofit 進行文件下載是一個非常方便的方式。在實現過程中，我們需要先準備好相關的依賴庫，並定義好 Retrofit 構建器和接口實現類。通過 Retrofit 客戶端調用接口方法即可開始文件下載，在下載過程中我們可以通過添加自定義攔截器的方式來監聽下載進度並進行 UI 更新。