Android中使用DownloadManager類來管理數(shù)據(jù)下載的教程
從Android 2.3(API level 9)開始Android用系統(tǒng)服務(wù)(Service)的方式提供了Download Manager來優(yōu)化處理長時間的下載操作。Download Manager處理HTTP連接并監(jiān)控連接中的狀態(tài)變化以及系統(tǒng)重啟來確保每一個下載任務(wù)順利完成。
在大多數(shù)涉及到下載的情況中使用Download Manager都是不錯的選擇,特別是當用戶切換不同的應(yīng)用以后下載需要在后臺繼續(xù)進行,以及當下載任務(wù)順利完成非常重要的情況(DownloadManager對于斷點續(xù)傳功能支持很好)。
要想使用Download Manager,使用getSystemService方法請求系統(tǒng)的DOWNLOAD_SERVICE服務(wù),代碼片段如下:
String serviceString = Context.DOWNLOAD_SERVICE; DownloadManager downloadManager; downloadManager = (DownloadManager) getSystemService(serviceString);
下載文件
要請求一個下載操作,需要創(chuàng)建一個DownloadManager.Request對象,將要請求下載的文件的Uri傳遞給Download Manager的enqueue方法,代碼片段如下所示:
String serviceString = Context.DOWNLOAD_SERVICE;
DownloadManager downloadManager;
downloadManager = (DownloadManager)getSystemService(serviceString);
Uri uri = Uri.parse("http://developer.android.com/shareables/icon_templates-v4.0.zip");
DownloadManager.Request request = new Request(uri);
long reference = downloadManager.enqueue(request);
在這里返回的reference變量是系統(tǒng)為當前的下載請求分配的一個唯一的ID,我們可以通過這個ID重新獲得這個下載任務(wù),進行一些自己想要進行的操作或者查詢
下載的狀態(tài)以及取消下載等等。
我們可以通過addRequestHeader方法為DownloadManager.Request對象request添加HTTP頭,也可以通過setMimeType方法重寫從服務(wù)器返回的mime type。
我們還可以指定在什么連接狀態(tài)下執(zhí)行下載操作。setAllowedNetworkTypes方法可以用來限定在WiFi還是手機網(wǎng)絡(luò)下進行下載,setAllowedOverRoaming方法
可以用來阻止手機在漫游狀態(tài)下下載。
下面的代碼片段用于指定一個較大的文件只能在WiFi下進行下載:
request.setAllowedNetworkTypes(Request.NETWORK_WIFI);
Android API level 11 介紹了getRecommendedMaxBytesOverMobile類方法(靜態(tài)方法),返回一個當前手機網(wǎng)絡(luò)連接下的最大建議字節(jié)數(shù),可以來判斷下載
是否應(yīng)該限定在WiFi條件下。
調(diào)用enqueue方法之后,只要數(shù)據(jù)連接可用并且Download Manager可用,下載就會開始。
要在下載完成的時候獲得一個系統(tǒng)通知(notification),注冊一個廣播接受者來接收ACTION_DOWNLOAD_COMPLETE廣播,這個廣播會包含一個
EXTRA_DOWNLOAD_ID信息在intent中包含了已經(jīng)完成的這個下載的ID,代碼片段如下所示:
IntentFilter filter = new IntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE);
BroadcastReceiver receiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
long reference = intent.getLongExtra(DownloadManager.EXTRA_DOWNLOAD_ID, -1);
if (myDownloadReference == reference) {
}
}
};
registerReceiver(receiver, filter);
使用Download Manager的openDownloadedFile方法可以打開一個已經(jīng)下載完成的文件,返回一個ParcelFileDescriptor對象。我們可以通過Download Manager來查詢下載文件的保存地址,如果在下載時制定了路徑和文件名,我們也可以直接操作文件。
我們可以為ACTION_NOTIFICATION_CLICKED action注冊一個廣播接受者,當用戶從通知欄點擊了一個下載項目或者從Downloads app點擊可一個下載的項目的
時候,系統(tǒng)就會發(fā)出一個點擊下載項的廣播。
代碼片段如下:
IntentFilter filter = new IntentFilter(DownloadManager.ACTION_NOTIFICATION_CLICKED);
BroadcastReceiver receiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
String extraID = DownloadManager.EXTRA_NOTIFICATION_CLICK_DOWNLOAD_IDS;
long[] references = intent.getLongArrayExtra(extraID);
for (long reference : references)
if (reference == myDownloadReference) {
// Do something with downloading file.
}
}
};
registerReceiver(receiver, filter);
定制Download Manager Notifications的樣式
默認情況下,通知欄中會顯示被Download Manager管理的每一個download每一個Notification會顯示當前的下載進度和文件的名字。
通過Download Manager可以為每一個download request定制Notification的樣式,包括完全隱藏Notification。下面的代碼片段顯示了通過setTitle和setDescription
方法來定制顯示在文件下載Notification中顯示的文字。
request.setTitle(“Earthquakes”); request.setDescription(“Earthquake XML”);
setNotificationVisibility方法可以用來控制什么時候顯示Notification,甚至是隱藏該request的Notification。有以下幾個參數(shù):
- Request.VISIBILITY_VISIBLE:在下載進行的過程中,通知欄中會一直顯示該下載的Notification,當下載完成時,該Notification會被移除,這是默認的參數(shù)值。
- Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED:在下載過程中通知欄會一直顯示該下載的Notification,在下載完成后該Notification會繼續(xù)顯示,直到用戶點擊該
- Notification或者消除該Notification。
- Request.VISIBILITY_VISIBLE_NOTIFY_ONLY_COMPLETION:只有在下載完成后該Notification才會被顯示。
- Request.VISIBILITY_HIDDEN:不顯示該下載請求的Notification。如果要使用這個參數(shù),需要在應(yīng)用的清單文件中加上DOWNLOAD_WITHOUT_NOTIFICATION權(quán)限。
指定下載保存地址
默認情況下,所有通過Download Manager下載的文件都保存在一個共享下載緩存中,使用系統(tǒng)生成的文件名每一個Request對象都可以制定一個下載
保存的地址,通常情況下,所有的下載文件都應(yīng)該保存在外部存儲中,所以我們需要在應(yīng)用清單文件中加上WRITE_EXTERNAL_STORAGE權(quán)限:
<uses-permission android:name=”android.permission.WRITE_EXTERNAL_STORAGE”/>
下面的代碼片段是在外部存儲中指定一個任意的保存位置的方法:
request.setDestinationUri(Uri.fromFile(f));
f是一個File對象。
如果下載的這個文件是你的應(yīng)用所專用的,你可能會希望把這個文件放在你的應(yīng)用在外部存儲中的一個專有文件夾中。注意這個文件夾不提供訪問控制,
所以其他的應(yīng)用也可以訪問這個文件夾。在這種情況下,如果你的應(yīng)用卸載了,那么在這個文件夾也會被刪除。
下面的代碼片段是指定存儲文件的路徑是應(yīng)用在外部存儲中的專用文件夾的方法:
request.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, “Bugdroid.png”);
如果下載的文件希望被其他的應(yīng)用共享,特別是那些你下載下來希望被Media Scanner掃描到的文件(比如音樂文件),那么你可以指定你的下載路徑在
外部存儲的公共文件夾之下,下面的代碼片段是將文件存放到外部存儲中的公共音樂文件夾的方法:
request.setDestinationInExternalPublicDir(Environment.DIRECTORY_MUSIC, "Android_Rock.mp3");
在默認的情況下,通過Download Manager下載的文件是不能被Media Scanner掃描到的,進而這些下載的文件(音樂、視頻等)就不會在Gallery和Music Player這樣的應(yīng)用中看到。
為了讓下載的音樂文件可以被其他應(yīng)用掃描到,我們需要調(diào)用Request對象的allowScaningByMediaScanner方法。
如果我們希望下載的文件可以被系統(tǒng)的Downloads應(yīng)用掃描到并管理,我們需要調(diào)用Request對象的setVisibleInDownloadsUi方法,傳遞參數(shù)true。
取消和刪除下載
Download Manager的remove方法可以用來取消一個準備進行的下載,中止一個正在進行的下載,或者刪除一個已經(jīng)完成的下載。
remove方法接受若干個download 的ID作為參數(shù),你可以設(shè)置一個或者幾個你想要取消的下載的ID,如下代碼段所示:
downloadManager.remove(REFERENCE_1, REFERENCE_2, REFERENCE_3);
該方法返回成功取消的下載的個數(shù),如果一個下載被取消了,所有相關(guān)聯(lián)的文件,部分下載的文件和完全下載的文件都會被刪除。
查詢Download Manager
你可以通過查詢Download Manager來獲得下載任務(wù)的狀態(tài),進度,以及各種細節(jié),通過query方法返回一個包含了下載任務(wù)細節(jié)的Cursor。
query方法傳遞一個DownloadManager.Query對象作為參數(shù),通過DownloadManager.Query對象的setFilterById方法可以篩選我們希望查詢的下載任務(wù)的ID。也可以使用setFilterByStatus方法篩選我們希望查詢的某一種狀態(tài)的下載任務(wù),傳遞的參數(shù)是DownloadManager.STATUS_*常量,可以指定正在進行、暫停、失敗、完成四種狀態(tài)。
Download Manager包含了一系列COLUMN_*靜態(tài)String常量,可以用來查詢Cursor中的結(jié)果列索引。我們可以查詢到下載任務(wù)的各種細節(jié),包括狀態(tài),文件大小,已經(jīng)下載的字節(jié)數(shù),標題,描述,URI,本地文件名和URI,媒體類型以及Media Provider download URI。
下面的代碼段是通過注冊監(jiān)聽下載完成事件的廣播接受者來查詢下載完成文件的本地文件名和URI的實現(xiàn)方法:
@Override
public void onReceive(Context context, Intent intent) {
long reference = intent.getLongExtra(DownloadManager.EXTRA_DOWNLOAD_ID, -1);
if (myDownloadReference == reference) {
Query myDownloadQuery = new Query();
myDownloadQuery.setFilterById(reference);
Cursor myDownload = downloadManager.query(myDownloadQuery);
if (myDownload.moveToFirst()) {
int fileNameIdx =
myDownload.getColumnIndex(DownloadManager.COLUMN_LOCAL_FILENAME);
int fileUriIdx =
myDownload.getColumnIndex(DownloadManager.COLUMN_LOCAL_URI);
String fileName = myDownload.getString(fileNameIdx);
String fileUri = myDownload.getString(fileUriIdx);
// TODO Do something with the file.
Log.d(TAG, fileName + " : " + fileUri);
}
myDownload.close();
}
}
對于暫停和失敗的下載,我們可以通過查詢COLUMN_REASON列查詢出原因的整數(shù)碼。
對于STATUS_PAUSED狀態(tài)的下載,可以通過DownloadManager.PAUSED_*靜態(tài)常量來翻譯出原因的整數(shù)碼,進而判斷出下載是由于等待網(wǎng)絡(luò)連接還是等待WiFi連接還是準備重新下載三種原因而暫停。
對于STATUS_FAILED狀態(tài)的下載,我們可以通過DownloadManager.ERROR_*來判斷失敗的原因,可能是錯誤碼(失敗原因)包括沒有存儲設(shè)備,
存儲空間不足,重復(fù)的文件名,或者HTTP errors。
下面的代碼是如何查詢出當前所有的暫停的下載任務(wù),提取出暫停的原因以及文件名稱,下載標題以及當前進度的實現(xiàn)方法:
// Obtain the Download Manager Service.
String serviceString = Context.DOWNLOAD_SERVICE;
DownloadManager downloadManager;
downloadManager = (DownloadManager)getSystemService(serviceString);
// Create a query for paused downloads.
Query pausedDownloadQuery = new Query();
pausedDownloadQuery.setFilterByStatus(DownloadManager.STATUS_PAUSED);
// Query the Download Manager for paused downloads.
Cursor pausedDownloads = downloadManager.query(pausedDownloadQuery);
// Find the column indexes for the data we require.
int reasonIdx = pausedDownloads.getColumnIndex(DownloadManager.COLUMN_REASON);
int titleIdx = pausedDownloads.getColumnIndex(DownloadManager.COLUMN_TITLE);
int fileSizeIdx =
pausedDownloads.getColumnIndex(DownloadManager.COLUMN_TOTAL_SIZE_BYTES);
int bytesDLIdx =
pausedDownloads.getColumnIndex(DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR);
// Iterate over the result Cursor.
while (pausedDownloads.moveToNext()) {
// Extract the data we require from the Cursor.
String title = pausedDownloads.getString(titleIdx);
int fileSize = pausedDownloads.getInt(fileSizeIdx);
int bytesDL = pausedDownloads.getInt(bytesDLIdx);
// Translate the pause reason to friendly text.
int reason = pausedDownloads.getInt(reasonIdx);
String reasonString = "Unknown";
switch (reason) {
case DownloadManager.PAUSED_QUEUED_FOR_WIFI :
reasonString = "Waiting for WiFi"; break;
case DownloadManager.PAUSED_WAITING_FOR_NETWORK :
reasonString = "Waiting for connectivity"; break;
case DownloadManager.PAUSED_WAITING_TO_RETRY :
reasonString = "Waiting to retry"; break;
default : break;
}
// Construct a status summary
StringBuilder sb = new StringBuilder();
sb.append(title).append("\n");
sb.append(reasonString).append("\n");
sb.append("Downloaded ").append(bytesDL).append(" / " ).append(fileSize);
// Display the status
Log.d("DOWNLOAD", sb.toString());
}
// Close the result Cursor.
pausedDownloads.close();
附:DownloadManager的一些重要功能和參數(shù)整理
DownloadManager類提供了以下幾種方法來處理,
long enqueue(DownloadManager.Request request) //存入隊列一個新的下載項
ParcelFileDescriptor openDownloadedFile(long id) //打開一個下載后的文件用于讀取,參數(shù)中的long型id是一個provider中的一條記錄。
Cursor query(DownloadManager.Query query) //查詢一個下載,返回一個Cursor
int remove(long... ids) //取消下載同時移除這些條從下載管理中。
我們可以看到提供的方法都比較簡單,給我們操作的最終封裝成為一個provider數(shù)據(jù)庫的方式進行添加、查詢和移除,但是對于查詢和添加任務(wù)的細節(jié),我們要看看DownloadManager.Request類和DownloadManager.Query 類了。
一、DownloadManager.Request類的成員和定義
- DownloadManager.Request addRequestHeader(String header, String value) // 添加一個Http請求報頭,對于這兩個參數(shù),Android開發(fā)網(wǎng)給大家舉個小例子,比如說User-Agent值可以為Android123或 Windows XP等等了,主要是給服務(wù)器提供標識。
- DownloadManager.Request setAllowedNetworkTypes(int flags) //設(shè)置允許使用的網(wǎng)絡(luò)類型,這一步Android 2.3做的很好,目前有兩種定義分別為NETWORK_MOBILE和NETWORK_WIFI我們可以選擇使用移動網(wǎng)絡(luò)或Wifi方式來下載。
- DownloadManager.Request setAllowedOverRoaming(boolean allowed) //對于下載,考慮到流量費用,這里是否允許使用漫游。
- DownloadManager.Request setDescription(CharSequence description) //設(shè)置一個描述信息,主要是最終顯示的notification提示,可以隨便寫個自己區(qū)別
- DownloadManager.Request setDestinationInExternalFilesDir(Context context, String dirType, String subPath) //設(shè)置目標存儲在外部目錄,一般位置可以用 getExternalFilesDir()方法獲取。
- DownloadManager.Request setDestinationInExternalPublicDir(String dirType, String subPath) //設(shè)置外部存儲的公共目錄,一般通過getExternalStoragePublicDirectory()方法獲取。
- DownloadManager.Request setDestinationUri(Uri uri) //設(shè)置需要下載目標的Uri,可以是http、ftp等等了。
- DownloadManager.Request setMimeType(String mimeType) //設(shè)置mime類型,這里看服務(wù)器配置,一般國家化的都為utf-8編碼。
- DownloadManager.Request setShowRunningNotification(boolean show) //是否顯示下載進度的提示
- DownloadManager.Request setTitle(CharSequence title) //設(shè)置notification的標題
- DownloadManager.Request setVisibleInDownloadsUi(boolean isVisible) //設(shè)置下載管理類在處理過程中的界面是否顯示
- 當然了Google還提供了一個簡單的方法來實例化本類,這個構(gòu)造方法為DownloadManager.Request(Uri uri) ,我們直接填寫一個Uri即可,上面的設(shè)置使用默認情況。
二、DownloadManager.Query類
對于當前下載內(nèi)容的狀態(tài),我們可以使用DownloadManager.Query類來獲取,本類比較簡單,僅僅提供了兩個方法。
- DownloadManager.Query setFilterById(long... ids) //根據(jù)id來過濾查找。
- DownloadManager.Query setFilterByStatus(int flags) //根據(jù)任務(wù)的狀態(tài)來查找。
詳細的狀態(tài)在android.app.DownloadManager類中有定義,目前Android 2.3中的定義為:
- int STATUS_FAILED 失敗
- int STATUS_PAUSED 暫停
- int STATUS_PENDING 等待將開始
- int STATUS_RUNNING 正在處理中
- int STATUS_SUCCESSFUL 已經(jīng)下載成功
最后Android開發(fā)網(wǎng)提醒大家要說的是因為DownloadManager類提供的query方法返回一個Cursor對象,這些狀態(tài)保存在這個游標的COLUMN_STATUS 字段中。
1. 下載的狀態(tài)完成均是以廣播的形式通知大家,目前API Level為9定義了下面三種Intent的action
(1)ACTION_DOWNLOAD_COMPLETE下載完成的動作。
(2)ACTION_NOTIFICATION_CLICKED 當用戶單擊notification中下載管理的某項時觸發(fā)。
(3)ACTION_VIEW_DOWNLOADS 查看下載項
2. 對于一個尚未完成的項,在Cursor中我們查找COLUMN_REASON字段,可能有以下定義:
(1)int ERROR_CANNOT_RESUME 不能夠繼續(xù),由于一些其他原因。
(2)int ERROR_DEVICE_NOT_FOUND 外部存儲設(shè)備沒有找到,比如SD卡沒有插入。
(3)int ERROR_FILE_ALREADY_EXISTS 要下載的文件已經(jīng)存在了,Android123提示下載管理類是不會覆蓋已經(jīng)存在的文件,所以如果需要重新下載,請先刪除以前的文件。
(1)int ERROR_FILE_ERROR 可能由于SD卡原因?qū)е铝宋募e誤。
(2)int ERROR_HTTP_DATA_ERROR 在Http傳輸過程中出現(xiàn)了問題。
(3)int ERROR_INSUFFICIENT_SPACE 由于SD卡空間不足造成的
(4)int ERROR_TOO_MANY_REDIRECTS 這個Http有太多的重定向,導(dǎo)致無法正常下載
(5)int ERROR_UNHANDLED_HTTP_CODE 無法獲取http出錯的原因,比如說遠程服務(wù)器沒有響應(yīng)。
(6)int ERROR_UNKNOWN 未知的錯誤類型.
3. 有關(guān)暫停的一些狀態(tài),同樣COLUMN_REASON字段的值可能是以下定義
(1)int PAUSED_QUEUED_FOR_WIFI 由于移動網(wǎng)絡(luò)數(shù)據(jù)問題,等待WiFi連接能用后再重新進入下載隊列。
(2)int PAUSED_UNKNOWN 未知原因?qū)е铝巳蝿?wù)下載的暫停.
(3)int PAUSED_WAITING_FOR_NETWORK 可能由于沒有網(wǎng)絡(luò)連接而無法下載,等待有可用的網(wǎng)絡(luò)連接恢復(fù)。.
(4)int PAUSED_WAITING_TO_RETRY 由于重重原因?qū)е孪螺d暫停,等待重試。
相關(guān)文章
Android獲取設(shè)備隱私 忽略6.0權(quán)限管理
這篇文章主要介紹了Android獲取設(shè)備隱私,忽略6.0權(quán)限管理,感興趣的小伙伴們可以參考一下2016-01-01
5分鐘學會Android設(shè)計模式之策略模式Strategy Pattern教程
這篇文章主要為大家介紹了5分鐘學會Android設(shè)計模式之策略模式Strategy Pattern教程,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-03-03
android 仿微信demo——登錄功能實現(xiàn)(服務(wù)端)
這系列文章主要介紹了微信小程序-閱讀小程序?qū)嵗?,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧,希望能給你們提供幫助2021-06-06
android studio實現(xiàn)簡單的計算器功能
這篇文章主要為大家詳細介紹了android studio實現(xiàn)簡單的計算器功能,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2020-05-05

