在這篇博客中，將會(huì)講述使用Retrofit十分需要的一個(gè)功能：怎么去下載文件，下面會(huì)展示一些下載文件需要寫(xiě)的代碼片段，從小的 png 圖片到大的 zip文件。

原文地址

Retrofit 2 — How to Download Files from Server

怎么指定一個(gè)Retrofit請(qǐng)求

如果你剛剛開(kāi)始閱讀這篇文章并且以前沒(méi)有寫(xiě)過(guò)任何關(guān)于Retrofit請(qǐng)求的代碼，可以先看一下前面翻譯的Retrofit系列的文章。對(duì)于已經(jīng)用過(guò)的人來(lái)說(shuō)，下載文件的請(qǐng)求和其他的請(qǐng)求看起來(lái)是差不多的。

// option 1: a resource relative to your base URL
@GET("/resource/example.zip")
Call<ResponseBody> downloadFileWithFixedUrl();

// option 2: using a dynamic URL
@GET
Call<ResponseBody> downloadFileWithDynamicUrlSync(@Url String fileUrl);  

如果你想下載的文件資源是靜態(tài)的（資源一直在同一個(gè)地址）并且和你的base URL相關(guān)聯(lián)，可以使用第一種方式。正如你所看到的，這看起來(lái)就像是Retrofit 2的一般的請(qǐng)求，值得注意的是，我們指定了 ResponseBody 來(lái)作為返回的類型。你不應(yīng)該使用任何其他的類型，否則Retrofit會(huì)嘗試去解析和映射轉(zhuǎn)換，在下載任務(wù)的時(shí)候這些操作都是沒(méi)有意義的。
第二種方式是Retrofit 2新加的，你現(xiàn)在可以輕松的通過(guò)一個(gè)動(dòng)態(tài)的URL作為請(qǐng)求的參數(shù)，這個(gè)特性在下載文件的時(shí)候是格外有用的，因?yàn)橐话鉼rl都是根據(jù)參數(shù)，使用者，和時(shí)間所決定的，你可以動(dòng)態(tài)的去構(gòu)建完整的請(qǐng)求URL。如果你還沒(méi)有使用過(guò)動(dòng)態(tài)URL，可以回頭去看我已經(jīng)翻譯的另一篇文章：Retrofit2-如何在請(qǐng)求時(shí)使用動(dòng)態(tài)URL。
你可以自己選擇使用哪一種方法，然后我們接著看下一步。

怎么調(diào)用這個(gè)請(qǐng)求方法

當(dāng)我們聲明了一個(gè)方法后，我們需要去調(diào)用它，代碼如下：

FileDownloadService downloadService = ServiceGenerator.create(FileDownloadService.class);

Call<ResponseBody> call = downloadService.downloadFileWithDynamicUrlSync(fileUrl);

call.enqueue(new Callback<ResponseBody>() {  
    @Override
    public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
        if (response.isSuccess()) {
            Log.d(TAG, "server contacted and has file");

            boolean writtenToDisk = writeResponseBodyToDisk(response.body());

            Log.d(TAG, "file download was a success? " + writtenToDisk);
        } else {
            Log.d(TAG, "server contact failed");
        }
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        Log.e(TAG, "error");
    }
});

如果你對(duì) ServiceGenerator.create() 感到迷惑，可以回頭看我翻譯的系列第一篇文章 Retrofit-開(kāi)始并創(chuàng)建一個(gè)Android客戶端，一旦我們創(chuàng)建了這個(gè)service，就可以像其他請(qǐng)求一樣來(lái)調(diào)用這個(gè)請(qǐng)求，當(dāng)然這只是第一步，真正重要的功能是 writeResponseBodyToDisk() 將返回的 ResponseBoby寫(xiě)到磁盤中。

怎么保存文件

這個(gè) writeResponseBodyToDisk() 方法拿到了 ResponseBody 對(duì)象，然后從里面讀流并寫(xiě)到磁盤中，這個(gè)代碼只是看起來(lái)比較復(fù)雜。

private boolean writeResponseBodyToDisk(ResponseBody body) {  
    try {
        // todo change the file location/name according to your needs
        File futureStudioIconFile = new File(getExternalFilesDir(null) + File.separator + "Future Studio Icon.png");

        InputStream inputStream = null;
        OutputStream outputStream = null;

        try {
            byte[] fileReader = new byte[4096];

            long fileSize = body.contentLength();
            long fileSizeDownloaded = 0;

            inputStream = body.byteStream();
            outputStream = new FileOutputStream(futureStudioIconFile);

            while (true) {
                int read = inputStream.read(fileReader);

                if (read == -1) {
                    break;
                }

                outputStream.write(fileReader, 0, read);

                fileSizeDownloaded += read;

                Log.d(TAG, "file download: " + fileSizeDownloaded + " of " + fileSize);
            }

            outputStream.flush();

            return true;
        } catch (IOException e) {
            return false;
        } finally {
            if (inputStream != null) {
                inputStream.close();
            }

            if (outputStream != null) {
                outputStream.close();
            }
        }
    } catch (IOException e) {
        return false;
    }
}

大部分的代碼只是 Java I/O的模板代碼，你可能需要去自己改變第一行文件保存的地址和文件保存的名字。當(dāng)你做完這些后，已經(jīng)算是準(zhǔn)備好了使用Retrofit來(lái)下載文件，但是，仍然還有一些事情沒(méi)有解決，比如一個(gè)主要的問(wèn)題：默認(rèn)情況下，Retrofit會(huì)將服務(wù)器的返回全部放到內(nèi)存之中，這個(gè)操作在返回JSON或者XML時(shí)是OK的，因?yàn)檫@些都比較小，但是大文件就非常容易導(dǎo)致 Out-of-Memory-Errors。
如果你的應(yīng)用需要下載一些大的文件，我們強(qiáng)烈建議閱讀下面這一段。

謹(jǐn)防大文件：使用 @Streaming

如果你在下載一個(gè)大的文件，Retrofit默認(rèn)會(huì)將整個(gè)文件移到內(nèi)存中，為了避免這種情況，我們需要為這種請(qǐng)求加一個(gè)特殊的注解：

@Streaming
@GET
Call<ResponseBody> downloadFileWithDynamicUrlAsync(@Url String fileUrl);  

加入這個(gè) @Streaming 聲明后并不是將整個(gè)文件全部放入內(nèi)存中，而是實(shí)時(shí)的返回字節(jié)碼。值得注意的是，如果你在添加了 @Streaming聲明的情況下依然使用上面的方式來(lái)進(jìn)行下載，Android就會(huì)拋出一個(gè)溢出 android.os.NetworkOnMainThreadException。
所以，最后一步就是把請(qǐng)求包裝到一個(gè)另外的線程中，比如使用 AsyncTask

final FileDownloadService downloadService =  
                ServiceGenerator.create(FileDownloadService.class);

new AsyncTask<Void, Long, Void>() {  
   @Override
   protected Void doInBackground(Void... voids) {
       Call<ResponseBody> call = downloadService.downloadFileWithDynamicUrlSync(fileUrl);
       call.enqueue(new Callback<ResponseBody>() {
           @Override
           public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
               if (response.isSuccess()) {
                   Log.d(TAG, "server contacted and has file");

                   boolean writtenToDisk = writeResponseBodyToDisk(response.body());

                   Log.d(TAG, "file download was a success? " + writtenToDisk);
               }
               else {
                   Log.d(TAG, "server contact failed");
               }
           }
       return null;
   }
}.execute(); 

如果你記住了一個(gè) @Streaming 聲明和上面這一段，你就能用Retrofit來(lái)有效的下載大文件而不是出現(xiàn)內(nèi)存溢出的問(wèn)題。