Android中使用DownloadManager类来管理数据下载的教程

从Android 2.3（API level 9）开始Android用系统服务(Service)的方式提供了Download Manager来优化处理长时间的下载操作。Download Manager处理HTTP连接并监控连接中的状态变化以及系统重启来确保每一个下载任务顺利完成。
在大多数涉及到下载的情况中使用Download Manager都是不错的选择，特别是当用户切换不同的应用以后下载需要在后台继续进行，以及当下载任务顺利完成非常重要的情况（DownloadManager对于断点续传功能支持很好）。

要想使用Download Manager，使用getSystemService方法请求系统的DOWNLOAD_SERVICE服务，代码片段如下：

String serviceString = Context.DOWNLOAD_SERVICE;
DownloadManager downloadManager;
downloadManager = (DownloadManager) getSystemService(serviceString);

下载文件
要请求一个下载操作，需要创建一个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变量是系统为当前的下载请求分配的一个唯一的ID，我们可以通过这个ID重新获得这个下载任务，进行一些自己想要进行的操作或者查询
下载的状态以及取消下载等等。
我们可以通过addRequestHeader方法为DownloadManager.Request对象request添加HTTP头，也可以通过setMimeType方法重写从服务器返回的mime type。
我们还可以指定在什么连接状态下执行下载操作。setAllowedNetworkTypes方法可以用来限定在WiFi还是手机网络下进行下载，setAllowedOverRoaming方法
可以用来阻止手机在漫游状态下下载。
下面的代码片段用于指定一个较大的文件只能在WiFi下进行下载：

request.setAllowedNetworkTypes(Request.NETWORK_WIFI);

Android API level 11 介绍了getRecommendedMaxBytesOverMobile类方法（静态方法），返回一个当前手机网络连接下的最大建议字节数，可以来判断下载
是否应该限定在WiFi条件下。
调用enqueue方法之后，只要数据连接可用并且Download Manager可用，下载就会开始。
要在下载完成的时候获得一个系统通知（notification）,注册一个广播接受者来接收ACTION_DOWNLOAD_COMPLETE广播，这个广播会包含一个
EXTRA_DOWNLOAD_ID信息在intent中包含了已经完成的这个下载的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方法可以打开一个已经下载完成的文件，返回一个ParcelFileDescriptor对象。我们可以通过Download Manager来查询下载文件的保存地址，如果在下载时制定了路径和文件名，我们也可以直接操作文件。
我们可以为ACTION_NOTIFICATION_CLICKED action注册一个广播接受者，当用户从通知栏点击了一个下载项目或者从Downloads app点击可一个下载的项目的
时候，系统就会发出一个点击下载项的广播。
代码片段如下：

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。有以下几个参数：

• Request.VISIBILITY_VISIBLE：在下载进行的过程中，通知栏中会一直显示该下载的Notification，当下载完成时，该Notification会被移除，这是默认的参数值。
• Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED：在下载过程中通知栏会一直显示该下载的Notification，在下载完成后该Notification会继续显示，直到用户点击该
• Notification或者消除该Notification。
• Request.VISIBILITY_VISIBLE_NOTIFY_ONLY_COMPLETION：只有在下载完成后该Notification才会被显示。
• Request.VISIBILITY_HIDDEN：不显示该下载请求的Notification。如果要使用这个参数，需要在应用的清单文件中加上DOWNLOAD_WITHOUT_NOTIFICATION权限。

指定下载保存地址

默认情况下，所有通过Download Manager下载的文件都保存在一个共享下载缓存中，使用系统生成的文件名每一个Request对象都可以制定一个下载
保存的地址，通常情况下，所有的下载文件都应该保存在外部存储中，所以我们需要在应用清单文件中加上WRITE_EXTERNAL_STORAGE权限：

<uses-permission android:name=”android.permission.WRITE_EXTERNAL_STORAGE”/>

下面的代码片段是在外部存储中指定一个任意的保存位置的方法：

request.setDestinationUri(Uri.fromFile(f));

f是一个File对象。
如果下载的这个文件是你的应用所专用的，你可能会希望把这个文件放在你的应用在外部存储中的一个专有文件夹中。注意这个文件夹不提供访问控制，
所以其他的应用也可以访问这个文件夹。在这种情况下，如果你的应用卸载了，那么在这个文件夹也会被删除。
下面的代码片段是指定存储文件的路径是应用在外部存储中的专用文件夹的方法：

request.setDestinationInExternalFilesDir(this,
 Environment.DIRECTORY_DOWNLOADS, “Bugdroid.png”);

如果下载的文件希望被其他的应用共享，特别是那些你下载下来希望被Media Scanner扫描到的文件（比如音乐文件），那么你可以指定你的下载路径在
外部存储的公共文件夹之下，下面的代码片段是将文件存放到外部存储中的公共音乐文件夹的方法：

request.setDestinationInExternalPublicDir(Environment.DIRECTORY_MUSIC,
 "Android_Rock.mp3");

在默认的情况下，通过Download Manager下载的文件是不能被Media Scanner扫描到的，进而这些下载的文件（音乐、视频等）就不会在Gallery和Music Player这样的应用中看到。
为了让下载的音乐文件可以被其他应用扫描到，我们需要调用Request对象的allowScaningByMediaScanner方法。
如果我们希望下载的文件可以被系统的Downloads应用扫描到并管理，我们需要调用Request对象的setVisibleInDownloadsUi方法，传递参数true。

取消和删除下载
Download Manager的remove方法可以用来取消一个准备进行的下载，中止一个正在进行的下载，或者删除一个已经完成的下载。
remove方法接受若干个download 的ID作为参数，你可以设置一个或者几个你想要取消的下载的ID，如下代码段所示：

downloadManager.remove(REFERENCE_1, REFERENCE_2, REFERENCE_3); 
该方法返回成功取消的下载的个数，如果一个下载被取消了，所有相关联的文件，部分下载的文件和完全下载的文件都会被删除。
查询Download Manager
你可以通过查询Download Manager来获得下载任务的状态，进度，以及各种细节，通过query方法返回一个包含了下载任务细节的Cursor。
query方法传递一个DownloadManager.Query对象作为参数，通过DownloadManager.Query对象的setFilterById方法可以筛选我们希望查询的下载任务的ID。也可以使用setFilterByStatus方法筛选我们希望查询的某一种状态的下载任务，传递的参数是DownloadManager.STATUS_*常量，可以指定正在进行、暂停、失败、完成四种状态。
Download Manager包含了一系列COLUMN_*静态String常量，可以用来查询Cursor中的结果列索引。我们可以查询到下载任务的各种细节，包括状态，文件大小，已经下载的字节数，标题，描述，URI，本地文件名和URI，媒体类型以及Media Provider download URI。
下面的代码段是通过注册监听下载完成事件的广播接受者来查询下载完成文件的本地文件名和URI的实现方法：

@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列查询出原因的整数码。
对于STATUS_PAUSED状态的下载，可以通过DownloadManager.PAUSED_*静态常量来翻译出原因的整数码，进而判断出下载是由于等待网络连接还是等待WiFi连接还是准备重新下载三种原因而暂停。
对于STATUS_FAILED状态的下载，我们可以通过DownloadManager.ERROR_*来判断失败的原因，可能是错误码（失败原因）包括没有存储设备，
存储空间不足，重复的文件名，或者HTTP errors。
下面的代码是如何查询出当前所有的暂停的下载任务，提取出暂停的原因以及文件名称，下载标题以及当前进度的实现方法：

// 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的一些重要功能和参数整理

DownloadManager类提供了以下几种方法来处理，
long  enqueue(DownloadManager.Request request)   //存入队列一个新的下载项
ParcelFileDescriptor  openDownloadedFile(long id)  //打开一个下载后的文件用于读取，参数中的long型id是一个provider中的一条记录。
Cursor  query(DownloadManager.Query query)  //查询一个下载，返回一个Cursor
int  remove(long... ids)  //取消下载同时移除这些条从下载管理中。
我们可以看到提供的方法都比较简单，给我们操作的最终封装成为一个provider数据库的方式进行添加、查询和移除，但是对于查询和添加任务的细节，我们要看看DownloadManager.Request类和DownloadManager.Query 类了。
一、DownloadManager.Request类的成员和定义

• DownloadManager.Request  addRequestHeader(String header, String value)  // 添加一个Http请求报头，对于这两个参数，Android开发网给大家举个小例子，比如说User-Agent值可以为Android123或 Windows XP等等了，主要是给服务器提供标识。
• DownloadManager.Request  setAllowedNetworkTypes(int flags)  //设置允许使用的网络类型，这一步Android 2.3做的很好，目前有两种定义分别为NETWORK_MOBILE和NETWORK_WIFI我们可以选择使用移动网络或Wifi方式来下载。
• DownloadManager.Request  setAllowedOverRoaming(boolean allowed)  //对于下载，考虑到流量费用，这里是否允许使用漫游。
• DownloadManager.Request  setDescription(CharSequence description)  //设置一个描述信息，主要是最终显示的notification提示，可以随便写个自己区别
• DownloadManager.Request  setDestinationInExternalFilesDir(Context context, String dirType, String subPath)  //设置目标存储在外部目录，一般位置可以用 getExternalFilesDir()方法获取。
• DownloadManager.Request  setDestinationInExternalPublicDir(String dirType, String subPath)  //设置外部存储的公共目录，一般通过getExternalStoragePublicDirectory()方法获取。
• DownloadManager.Request  setDestinationUri(Uri uri)  //设置需要下载目标的Uri，可以是http、ftp等等了。
• DownloadManager.Request  setMimeType(String mimeType)  //设置mime类型，这里看服务器配置，一般国家化的都为utf-8编码。
• DownloadManager.Request  setShowRunningNotification(boolean show)  //是否显示下载进度的提示
• DownloadManager.Request  setTitle(CharSequence title)  //设置notification的标题
• DownloadManager.Request  setVisibleInDownloadsUi(boolean isVisible)  //设置下载管理类在处理过程中的界面是否显示
• 当然了Google还提供了一个简单的方法来实例化本类，这个构造方法为DownloadManager.Request(Uri uri) ，我们直接填写一个Uri即可，上面的设置使用默认情况。

二、DownloadManager.Query类

对于当前下载内容的状态，我们可以使用DownloadManager.Query类来获取，本类比较简单，仅仅提供了两个方法。

• DownloadManager.Query  setFilterById(long... ids)  //根据id来过滤查找。
• DownloadManager.Query  setFilterByStatus(int flags) //根据任务的状态来查找。

详细的状态在android.app.DownloadManager类中有定义，目前Android 2.3中的定义为:

• int STATUS_FAILED 失败
• int STATUS_PAUSED 暂停
• int STATUS_PENDING 等待将开始
• int STATUS_RUNNING 正在处理中
• int STATUS_SUCCESSFUL 已经下载成功

最后Android开发网提醒大家要说的是因为DownloadManager类提供的query方法返回一个Cursor对象，这些状态保存在这个游标的COLUMN_STATUS 字段中。

1. 下载的状态完成均是以广播的形式通知大家，目前API Level为9定义了下面三种Intent的action
（1）ACTION_DOWNLOAD_COMPLETE下载完成的动作。
（2）ACTION_NOTIFICATION_CLICKED 当用户单击notification中下载管理的某项时触发。
（3）ACTION_VIEW_DOWNLOADS 查看下载项
2. 对于一个尚未完成的项，在Cursor中我们查找COLUMN_REASON字段，可能有以下定义:
（1）int ERROR_CANNOT_RESUME 不能够继续，由于一些其他原因。
（2）int ERROR_DEVICE_NOT_FOUND 外部存储设备没有找到，比如SD卡没有插入。
（3）int ERROR_FILE_ALREADY_EXISTS 要下载的文件已经存在了，Android123提示下载管理类是不会覆盖已经存在的文件，所以如果需要重新下载，请先删除以前的文件。
（1）int ERROR_FILE_ERROR 可能由于SD卡原因导致了文件错误。
（2）int ERROR_HTTP_DATA_ERROR 在Http传输过程中出现了问题。
（3）int ERROR_INSUFFICIENT_SPACE 由于SD卡空间不足造成的
（4）int ERROR_TOO_MANY_REDIRECTS 这个Http有太多的重定向，导致无法正常下载
（5）int ERROR_UNHANDLED_HTTP_CODE 无法获取http出错的原因，比如说远程服务器没有响应。
（6）int ERROR_UNKNOWN 未知的错误类型.
3. 有关暂停的一些状态，同样COLUMN_REASON字段的值可能是以下定义
（1）int PAUSED_QUEUED_FOR_WIFI 由于移动网络数据问题，等待WiFi连接能用后再重新进入下载队列。
（2）int PAUSED_UNKNOWN 未知原因导致了任务下载的暂停.
（3）int PAUSED_WAITING_FOR_NETWORK 可能由于没有网络连接而无法下载，等待有可用的网络连接恢复。.
（4）int PAUSED_WAITING_TO_RETRY 由于重重原因导致下载暂停，等待重试。