本文主要结合源码介绍Android系统下载管理DownloadManager的强大功能及使用。
这是许久来准备写的一系列博客，这篇主要介绍DownloadManager的功能和示例，后面还有两篇会介绍下载管理的底层设计(DownloadProvider、DownloadManager、DownloadManagerUI)、下载管理如何进行功能增强和bug修改。
更多下载相关开源项目可见 Android 下载。
Demo APK 可以方便的查看效果，在各大应用商店搜索 trinea android 下载即可，如：Google Play。
可运行代码地址可见DownloadManager Demo，效果图如下：
|
1 |
Android网络应用开发中经常需要下载文件，如音乐、应用、系统升级包。一般的要求是统一的管理(暂停、继续、取消)中心、断点续传、并发下载、wifi及3g的不同处理、下载完成后处理、管理中心与应用的交互。可以使用RandomAccessFile和多线程自己实现。三方应用通常要么跳转到浏览器下载，要么勉强实现后却像天天动听、海豚浏览器那样bug百出(鄙视下)。实际上Android下载管理已经提供了功能强大(超乎你的想象)的API供第三方调用，google play、chrome都会调用系统下载管理进行下载。本文就以一个示例着手介绍DownloadManager的使用及丰富功能。 |
一、DownloadManager简单介绍
DownloadManager是系统开放给第三方应用使用的类，包含两个静态内部类DownloadManager.Query和DownloadManager.Request。DownloadManager.Request用来请求一个下载，DownloadManager.Query用来查询下载信息，这两个类的具体功能会在后面穿插介绍。DownloadManager的源码可见DownloadManager@Grepcode。
DownloadManager主要提供了下面几个接口：
public long enqueue(Request request)执行下载，返回downloadId，downloadId可用于后面查询下载信息。若网络不满足条件、Sdcard挂载中、超过最大并发数等异常会等待下载，正常则直接下载。
public int remove(long… ids)删除下载，若下载中取消下载。会同时删除下载文件和记录。
public Cursor query(Query query)查询下载信息。
public static Long getRecommendedMaxBytesOverMobile(Context context通过移动网络下载的最大字节数
public String getMimeTypeForDownloadedFile(long id)得到下载的mimeType，如何设置后面会进行介绍
其它：通过查看代码我们可以发现还有个CursorTranslator私有静态内部类。这个类主要对Query做了一层代理。将DownloadProvider和DownloadManager之间做个映射。将DownloadProvider中的十几种状态对应到了DownloadManager中的五种状态，DownloadProvider中的失败、暂停原因转换为了DownloadManager的原因。
二、下载管理示例
下面具体介绍利用DownloadManager进行下载。
1、AndroidManifest中添加权限
|
1 2 |
<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> |
网络访问权限是必须的，下载地址为sdcard的话需要添加sdcard写权限。
2、调用DownloadManager.Request开始下载
|
1 2 3 4 5 6 7 8 9 10 11 |
DownloadManager downloadManager = (DownloadManager)getSystemService(DOWNLOAD_SERVICE); String apkUrl = "http://img.meilishuo.net/css/images/AndroidShare/Meilishuo_3.6.1_10006.apk"; DownloadManager.Request request = new DownloadManager.Request(Uri.parse(apkUrl)); request.setDestinationInExternalPublicDir("Trinea", "MeiLiShuo.apk"); // request.setTitle("MeiLiShuo"); // request.setDescription("MeiLiShuo desc"); // request.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED); // request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_WIFI); // request.setNotificationVisibility(DownloadManager.Request.VISIBILITY_HIDDEN); // request.setMimeType("application/cn.trinea.download.file"); long downloadId = downloadManager.enqueue(request); |
上面调用downloadManager的enqueue接口进行下载，返回唯一的downloadId。
DownloadManager.Request除了构造函数的Uri必须外，其他设置都为可选设置。下面逐个介绍下：
request.setDestinationInExternalPublicDir(“Trinea”, “MeiLiShuo.apk”);表示设置下载地址为sd卡的Trinea文件夹，文件名为MeiLiShuo.apk。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
public Request setDestinationInExternalPublicDir(String dirType, String subPath) { File file = Environment.getExternalStoragePublicDirectory(dirType); Xlog.v(XLOGTAG, "setExternalPublicDir: dirType " + dirType + " subPath " + subPath + "file" + file); if (file.exists()) { if (!file.isDirectory()) { throw new IllegalStateException(file.getAbsolutePath() + " already exists and is not a directory"); } } else { if (!file.mkdir()) { throw new IllegalStateException("Unable to create directory: "+ file.getAbsolutePath()); } } setDestinationFromBase(file, subPath); return this; } |
从源码中我们可以看出下载完整目录为Environment.getExternalStoragePublicDirectory(dirType)。不过file是通过file.mkdir()创建的，这样如果上级目录不存在就会新建文件夹异常。所以下载前我们最好自己调用File的mkdirs方法递归创建子目录，如下：
|
1 2 |
File folder = new File(folderName); return (folder.exists() && folder.isDirectory()) ? true : folder.mkdirs(); |
否则，会报异常
|
1 2 |
java.lang.IllegalStateException: Unable to create directory: /storage/sdcard0/Trinea/aa at android.app.DownloadManager$Request.setDestinationInExternalPublicDir(DownloadManager.java) |
其他设置下载路径接口为setDestinationUri，setDestinationInExternalFilesDir，setDestinationToSystemCache。其中setDestinationToSystemCache仅限系统app使用。
request.allowScanningByMediaScanner();表示允许MediaScanner扫描到这个文件，默认不允许。
request.setTitle(“MeiLiShuo”);设置下载中通知栏提示的标题
request.setDescription(“MeiLiShuo desc”);设置下载中通知栏提示的介绍
request.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
表示下载进行中和下载完成的通知栏是否显示。默认只显示下载中通知。VISIBILITY_VISIBLE_NOTIFY_COMPLETED表示下载完成后显示通知栏提示。VISIBILITY_HIDDEN表示不显示任何通知栏提示，这个需要在AndroidMainfest中添加权限android.permission.DOWNLOAD_WITHOUT_NOTIFICATION.
request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_WIFI);
表示下载允许的网络类型，默认在任何网络下都允许下载。有NETWORK_MOBILE、NETWORK_WIFI、NETWORK_BLUETOOTH三种及其组合可供选择。如果只允许wifi下载，而当前网络为3g，则下载会等待。
request.setAllowedOverRoaming(boolean allow)移动网络情况下是否允许漫游。
request.setMimeType(“application/cn.trinea.download.file”);
设置下载文件的mineType。因为下载管理Ui中点击某个已下载完成文件及下载完成点击通知栏提示都会根据mimeType去打开文件，所以我们可以利用这个属性。比如上面设置了mimeType为application/cn.trinea.download.file，我们可以同时设置某个Activity的intent-filter为application/cn.trinea.download.file，用于响应点击的打开文件。
|
1 2 3 4 5 6 7 |
<intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <data android:mimeType="application/cn.trinea.download.file" /> </intent-filter> |
request.addRequestHeader(String header, String value)
添加请求下载的网络链接的http头，比如User-Agent，gzip压缩等
3 下载进度状态监听及查询
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
class DownloadChangeObserver extends ContentObserver { public DownloadChangeObserver(){ super(handler); } @Override public void onChange(boolean selfChange) { updateView(); } } public void updateView() { int[] bytesAndStatus = downloadManagerPro.getBytesAndStatus(downloadId); handler.sendMessage(handler.obtainMessage(0, bytesAndStatus[0], bytesAndStatus[1], bytesAndStatus[2])); } private DownloadChangeObserver downloadObserver; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.download_manager_demo); …… downloadObserver = new DownloadChangeObserver(); } @Override protected void onResume() { super.onResume(); /** observer download change **/ getContentResolver().registerContentObserver(DownloadManagerPro.CONTENT_URI, true, downloadObserver); } @Override protected void onPause() { super.onPause(); getContentResolver().unregisterContentObserver(downloadObserver); } |
其中我们会监听Uri.parse(“content://downloads/my_downloads”)。然后查询下载状态和进度，发送handler进行更新，handler中处理就是设置进度条和状态等。
其中DownloadManagerPro.getBytesAndStatus的主要代码如下，可直接引入TrineaAndroidCommon@Github(欢迎star和fork^_^)作为你项目的library(如何拉取代码及添加公共库)：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
public int[] getBytesAndStatus(long downloadId) { int[] bytesAndStatus = new int[] { -1, -1, 0 }; DownloadManager.Query query = new DownloadManager.Query().setFilterById(downloadId); Cursor c = null; try { c = downloadManager.query(query); if (c != null && c.moveToFirst()) { bytesAndStatus[0] = c.getInt(c.getColumnIndexOrThrow(DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR)); bytesAndStatus[1] = c.getInt(c.getColumnIndexOrThrow(DownloadManager.COLUMN_TOTAL_SIZE_BYTES)); bytesAndStatus[2] = c.getInt(c.getColumnIndex(DownloadManager.COLUMN_STATUS)); } } finally { if (c != null) { c.close(); } } return bytesAndStatus; } |
从上面代码可以看出我们主要调用DownloadManager.Query()进行查询。DownloadManager.Query为下载管理对外开放的信息查询类，主要包括以下接口：
setFilterById(long… ids)根据下载id进行过滤
setFilterByStatus(int flags)根据下载状态进行过滤
setOnlyIncludeVisibleInDownloadsUi(boolean value)根据是否在download ui中可见进行过滤。
orderBy(String column, int direction)根据列进行排序，不过目前仅支持DownloadManager.COLUMN_LAST_MODIFIED_TIMESTAMP和DownloadManager.COLUMN_TOTAL_SIZE_BYTES排序。
4 下载成功监听
下载完成后，下载管理会发出DownloadManager.ACTION_DOWNLOAD_COMPLETE这个广播，并传递downloadId作为参数。通过接受广播我们可以打开对下载完成的内容进行操作。代码如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
class CompleteReceiver extends BroadcastReceiver { @Override public void onReceive(Context context, Intent intent) { // get complete download id long completeDownloadId = intent.getLongExtra(DownloadManager.EXTRA_DOWNLOAD_ID, -1); // to do here } }; private CompleteReceiver completeReceiver; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.download_manager_demo); … completeReceiver = new CompleteReceiver(); /** register download success broadcast **/ registerReceiver(completeReceiver, new IntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE)); } @Override protected void onDestroy() { super.onDestroy(); unregisterReceiver(completeReceiver); } |
5、响应通知栏点击
(1) 响应下载中通知栏点击
点击下载中通知栏提示，系统会对下载的应用单独发送Action为DownloadManager.ACTION_NOTIFICATION_CLICKED广播。intent.getData为content://downloads/all_downloads/29669，最后一位为downloadId。
如果同时下载多个应用，intent会包含DownloadManager.EXTRA_NOTIFICATION_CLICK_DOWNLOAD_IDS这个key，表示下载的的downloadId数组。这里设计到下载管理通知栏的显示机制，会在下一篇具体介绍。
(2) 响应下载完成通知栏点击
下载完后会调用下面代码进行处理，从中我们可以发现系统会调用View action根据mimeType去查询。所以可以利用我们在介绍的DownloadManager.Request的setMimeType函数。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
private void openDownload(Context context, Cursor cursor) { String filename = cursor.getString(cursor.getColumnIndexOrThrow(Downloads.Impl._DATA)); String mimetype = cursor.getString(cursor.getColumnIndexOrThrow(Downloads.Impl.COLUMN_MIME_TYPE)); Uri path = Uri.parse(filename); // If there is no scheme, then it must be a file if (path.getScheme() == null) { path = Uri.fromFile(new File(filename)); } Intent activityIntent = new Intent(Intent.ACTION_VIEW); mimetype = DownloadDrmHelper.getOriginalMimeType(context, filename, mimetype); activityIntent.setDataAndType(path, mimetype); activityIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); try { context.startActivity(activityIntent); } catch (ActivityNotFoundException ex) { Log.d(Constants.TAG, "no activity for " + mimetype, ex); } } |
如果界面上过多元素需要更新，且网速较快不断的执行onChange会对页面性能有一定影响。推荐ScheduledExecutorService定期查询，如下:
|
1 2 3 4 5 6 7 8 9 |
public static ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(3); Runnable command = new Runnable() { @Override public void run() { updateView(); } }; scheduledExecutorService.scheduleAtFixedRate(command, 0, 3, TimeUnit.SECONDS); |
表示3秒定时刷新
为什么在2g的网络情况下会下载失败
看是不是设置request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_WIFI);，这个表示只能在wifi下载，不设置任何网络皆可
我的没有任何设置 为什么也是失败啊
可能你系统被三方改了，可能你调用有问题，logcat看异常
这个项目有个严重BUG，就是download文件夹删除后，不会自己创建。原来是代码：setDestinationFromBase( Environment.getExternalStoragePublicDirectory(dirType), subPath);修改为可修复这个BUG： File file = Environment.getExternalStoragePublicDirectory(dirType); if (file.mkdirs()) { setDestinationFromBase(file,subPath); }代码在DownloadManager类setDestinationInExternalPublicDir方法中。
嗯，这个问题我在博客上提到了，原生是有这个bug的，所有要求你在下载前检查文件是否存在，否则mkdirs
如果不改源码有暂停的方法么？你把暂停和继续放在DownloadManagerPro类中，但对我们这些应用层的开发一点用都没啊
嗯，是的，DownloadManagerPro里面的这两个方法对于一般系统确实没用，你可以用DownloadManager修改 里面提到的github上那个开源项目
咨询一下，download moving arrow下载的过程中在状态栏上显示的icon下载图标是静态的而不是动态的，我看很多app都是在下载过程中是动态的icon，请指教！
DownloadManager下载的哪个demo
下载的图标静止不动！
系统下载管理读取的是frameworks/base/core/res/res/values/colors.xml下面的< drawable name=”stat_sys_upload_done” >@drawable/stat_sys_upload_anim0< /drawable >从中你也可以看出只是一张图片，不过你可以使用animation-list完成动态icon，如下< animation-list xmlns:android=”http://schemas.android.com/apk/res/android” android:oneshot=”false” > < item android:drawable=”@drawable/image_1″ android:duration=”100″ / > < item android:drawable=”@drawable/image_2″ android:duration=”100″ / > < item android:drawable=”@drawable/image_3″ android:duration=”100″ / >< /animation-list >可参考：http://blog.csdn.net/aminfo/article/details/7847761
哦，明白了，太感谢了，哈哈！
你好，用你下载管理pro 在2.3 的设备下下载 文件才开始下载，0% 马上就结束了，在4.0上的设备正常，请教这是什么问题呢
pro里面只有获取信息的方法，真正的下载用的都是downloadmanager。你试试下载其他文件类型会不会有问题
谢谢你的回复，我试了下载jpg 文件，和下载apk文件一样，在下载管理里看到是下载失败
去数据库中看为什么失败 /data/data/com.android.providers.downloads/databases/downloads.db
非常感谢，我看看
还有个问题请教， 手机在有外部sd卡的时候，下载会报错（java.lang.SecurityException: Destination must be on external storage），卸载sd卡后就正常了，这是什么原因
请问下，下载过程中，你的statusbar上的图标是动的还是静态的？？
是mtk芯片 4.2系统？那个上面有个内部卡和sdcard被交换的问题，你调用的是setDestinationInExternalPublicDir吗
谢谢，是调用的setDestinationInExternalPublicDir
请教下这个问题应该怎么解决呢，谢谢
你是不是加这个权限WRITE_EXTERNAL_STORAGE。。。
是的，加了权限WRITE_EXTERNAL_STORAGE
自己对照DownloadProvider#checkFileUriDestination看看原因
我比较初级，看不出原因，请教能解决这个问题吗
请问这个代码有可以直接管理同时下载多个文件么？我下载的代码里有你的依赖工程。跑不起来。
我只想要下载管理的，可以不用公共库么。。
可以，下载管理是系统的，有些高级功能可以自己参考DownloadManagerPro
DownloadManager支持多线程
博主你好，在三星I9300上使用downloadmanager，执行request时出现Failed to find provider info for downloads，java.lang.IllegalArgumentException: Unknown URL content://downloads/my_downloads苦于找不到答案，还烦劳能帮忙解答，谢谢
可以看看/data/data/com.android.providers.downloads/databases/downloads.db这个文件是否存在，如果不存在的话，可能是三星阉割了系统的DownloadProvider，你可以用github上开源的DownloadProvider
谢谢博主指点
博主 你好 你的公共库JAR包打的有问题，无法加载，请重新打包下，感谢分享
问题已经解决，请拉取最新代码
你好 我从google上拉的最新trinea-android-demo，也手动把trineaandroidcommon.jar 加入了，但JAR包导入好像不行，在JAVA代码里不能加载相关类
问题已经解决，请拉取最新代码
帮了大忙了，谢谢