- 原文鏈接： Retrofit 2 — How to Download Files from Server
- 原文出自： Future Studio
- 譯文出自： 小鄧子的簡書
- 譯者： 小鄧子
- 狀態： 完成
如何聲明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方式，可以翻到開頭，看看這篇專題博客Retrofit 2中的動態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()感到困惑，可以閱讀我們的第一篇博客 。一旦創建了service，我們就能像其他Retrofit調用一樣做網絡請求了。
還剩下一件很重要的事，隱藏在代碼塊中的writeResponseBodyToDisk()函數：負責將文件寫進磁盤。
如何保存文件
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在處理結果前會將整個Server Response讀進內存，這在JSON或者XML等Response上表現還算良好，但如果是一個非常大的文件，就可能造成OutofMemory異常。
如果你的應用需要下載略大的文件，我們強烈建議閱讀下一節內容。
當心大文件：請使用@Streaming！
如果下載一個非常大的文件，Retrofit會試圖將整個文件讀進內存。為了避免這種現象的發生，我們添加了一個特殊的注解來聲明請求。
@Streaming
@GET
Call<ResponseBody> downloadFileWithDynamicUrlAsync(@Url String fileUrl);
聲明@Streaming并不是意味著你需要觀察一個Netflix文件。它意味著立刻傳遞字節碼，而不需要把整個文件讀進內存。值得注意的是，如果你使用了@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高效下載大文件了。
