在這篇博客中，將會講述使用Retrofit十分需要的一個功能：怎么去下載文件，下面會展示一些下載文件需要寫的代碼片段，從小的 png 圖片到大的 zip文件。
原文地址
Retrofit 2 — How to Download Files from Server
怎么指定一個Retrofit請求
如果你剛剛開始閱讀這篇文章并且以前沒有寫過任何關于Retrofit請求的代碼，可以先看一下前面翻譯的Retrofit系列的文章。對于已經用過的人來說，下載文件的請求和其他的請求看起來是差不多的。
// 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);
如果你想下載的文件資源是靜態的（資源一直在同一個地址）并且和你的base URL相關聯，可以使用第一種方式。正如你所看到的，這看起來就像是Retrofit 2的一般的請求，值得注意的是，我們指定了 ResponseBody 來作為返回的類型。你不應該使用任何其他的類型，否則Retrofit會嘗試去解析和映射轉換，在下載任務的時候這些操作都是沒有意義的。
第二種方式是Retrofit 2新加的，你現在可以輕松的通過一個動態的URL作為請求的參數，這個特性在下載文件的時候是格外有用的，因為一般url都是根據參數，使用者，和時間所決定的，你可以動態的去構建完整的請求URL。如果你還沒有使用過動態URL，可以回頭去看我已經翻譯的另一篇文章：Retrofit2-如何在請求時使用動態URL。
你可以自己選擇使用哪一種方法，然后我們接著看下一步。
怎么調用這個請求方法
當我們聲明了一個方法后，我們需要去調用它，代碼如下：
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");
}
});
如果你對 ServiceGenerator.create() 感到迷惑，可以回頭看我翻譯的系列第一篇文章 Retrofit-開始并創建一個Android客戶端，一旦我們創建了這個service，就可以像其他請求一樣來調用這個請求，當然這只是第一步，真正重要的功能是 writeResponseBodyToDisk() 將返回的 ResponseBoby寫到磁盤中。
怎么保存文件
這個 writeResponseBodyToDisk() 方法拿到了 ResponseBody 對象，然后從里面讀流并寫到磁盤中，這個代碼只是看起來比較復雜。
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的模板代碼，你可能需要去自己改變第一行文件保存的地址和文件保存的名字。當你做完這些后，已經算是準備好了使用Retrofit來下載文件，但是，仍然還有一些事情沒有解決，比如一個主要的問題：默認情況下，Retrofit會將服務器的返回全部放到內存之中，這個操作在返回JSON或者XML時是OK的，因為這些都比較小，但是大文件就非常容易導致 Out-of-Memory-Errors。
如果你的應用需要下載一些大的文件，我們強烈建議閱讀下面這一段。
謹防大文件：使用 @Streaming
如果你在下載一個大的文件，Retrofit默認會將整個文件移到內存中，為了避免這種情況，我們需要為這種請求加一個特殊的注解：
@Streaming
@GET
Call<ResponseBody> downloadFileWithDynamicUrlAsync(@Url String fileUrl);
加入這個 @Streaming 聲明后并不是將整個文件全部放入內存中，而是實時的返回字節碼。值得注意的是，如果你在添加了 @Streaming聲明的情況下依然使用上面的方式來進行下載，Android就會拋出一個溢出 android.os.NetworkOnMainThreadException。
所以，最后一步就是把請求包裝到一個另外的線程中，比如使用 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();
如果你記住了一個 @Streaming 聲明和上面這一段，你就能用Retrofit來有效的下載大文件而不是出現內存溢出的問題。
