转载:
http://www.trinea.cn/android/android-downloadmanager/
http://www.trinea.cn/android/android-downloadmanager-pro/
https://i-blog.csdnimg.cn/blog_migrate/5241a98e37cbdcfd0d3c5ff5b5312edb.png
Android系统下载管理DownloadManager功能介绍及使用示例
本文主要结合源码介绍Android系统下载管理DownloadManager的强大功能及使用。
这是许久来准备写的一系列博客,这篇主要介绍DownloadManager的功能和示例,后面还有两篇会介绍下载管理的底层设计(DownloadProvider、DownloadManager、DownloadManagerUI)、下载管理如何进行功能增强和bug修改。
示例APK可从这些地址下载:Google Play, 360手机助手, 百度手机助手, 小米应用商店, 豌豆荚
可运行代码地址可见DownloadManager Demo,效果图如下:

一、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中添加权限
|
<
uses
-
permission
android
:
name
=
"android.permission.INTERNET"
/
>
<
uses
-
permission
android
:
name
=
"android.permission.WRITE_EXTERNAL_STORAGE"
/
>
|
网络访问权限是必须的,下载地址为sdcard的话需要添加sdcard写权限。
2、调用DownloadManager.Request开始下载
|
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。
从源码中我们可以看出下载完整目录为Environment.getExternalStoragePublicDirectory(dirType)。不过file是通过file.mkdir()创建的,这样如果上级目录不存在就会新建文件夹异常。所以下载前我们最好自己调用File的mkdirs方法递归创建子目录,如下:
|
File
folder
=
new
File
(
folderName
)
;
return
(
folder
.
exists
(
)
&&
folder
.
isDirectory
(
)
)
?
true
:
folder
.
mkdirs
(
)
;
|
否则,会报异常
|
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,用于响应点击的打开文件。
|
<
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定期查询,如下:
|
public
static
ScheduledExecutorService
scheduledExecutorService
=
Executors
.
newScheduledThreadPool
(
3
)
;
Runnable
command
=
new
Runnable
(
)
{
@Override
public
void
run
(
)
{
updateView
(
)
;
}
}
;
scheduledExecutorService
.
scheduleAtFixedRate
(
command
,
0
,
3
,
TimeUnit
.
SECONDS
)
;
|
表示3秒定时刷新
Android下载管理DownloadManager功能扩展和bug修改
本文主要介绍如何修改Android系统下载管理,以支持更多的功能及部分bug修改和如何编译生效。目前内容包括暂停下载、继续下载、通知设置NotiExtra和NotiClass、wifi切换到3g自动暂停、Bug修改。
PS: 很多童鞋不是自己做rom,所以就算修改了系统源码编译出来的包在其他系统上也不通用
这里推荐DownloadProvider@Github(并不是我的开源项目,我的项目为TrineaAndroidCommon@Github,包含图片缓存,下拉刷新,静默安装等,欢迎关注),系统下载管理的独立版,可整合进自己的应用,感谢@DONG童鞋提供地址。
下面需要修改的DownloadManager.java所在目录为frameworks/base/core/java/android/app
DownloadInfo.java, DownloadProvider.java,DownloadThread.java文件所在目录为packages/providers/DownloadProvider/src/com/android/providers/downloads
1、暂停、继续下载功能
(1) DownloadProvider类修改
|
public
int
update
(
final
Uri
uri
,
final
ContentValues
values
,
final
String
where
,
final
String
[
]
whereArgs
)
|
函数,修改后代码如下(只增加了一行有效代码):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
if
(
Binder
.
getCallingPid
(
)
!=
Process
.
myPid
(
)
)
{
filteredValues
=
new
ContentValues
(
)
;
copyString
(
Downloads
.
Impl
.
COLUMN_APP_DATA
,
values
,
filteredValues
)
;
copyInteger
(
Downloads
.
Impl
.
COLUMN_VISIBILITY
,
values
,
filteredValues
)
;
Integer
i
=
values
.
getAsInteger
(
Downloads
.
Impl
.
COLUMN_CONTROL
)
;
if
(
i
!=
null
)
{
filteredValues
.
put
(
Downloads
.
Impl
.
COLUMN_CONTROL
,
i
)
;
startService
=
true
;
}
// trinea BEGIN, added by trinea@trinea.cn 2013/03/01
copyInteger
(
Downloads
.
Impl
.
COLUMN_STATUS
,
values
,
filteredValues
)
;
// trinea END
copyInteger
(
Downloads
.
Impl
.
COLUMN_CONTROL
,
values
,
filteredValues
)
;
copyString
(
Downloads
.
Impl
.
COLUMN_TITLE
,
values
,
filteredValues
)
;
copyString
(
Downloads
.
Impl
.
COLUMN_MEDIAPROVIDER_URI
,
values
,
filteredValues
)
;
copyString
(
Downloads
.
Impl
.
COLUMN_DESCRIPTION
,
values
,
filteredValues
)
;
copyInteger
(
Downloads
.
Impl
.
COLUMN_DELETED
,
values
,
filteredValues
)
;
}
else
{
|
其中以// trinea BEGIN开头,// trinea END结尾为修改部分,下面代码示例同样如此。因为DownloadProvider安全策略对非该进程id的修改会过滤掉COLUMN_STATUS状态,所以我们需要添加该行。
(2) DownloadThread类修改
|
private
void
setupDestinationFile
(
State
state
,
InnerState
innerState
)
|
函数中这个注释掉一个else if,如下:
|
// trinea BEGIN, noted by trinea@trinea.cn 2013/03/01
//} else if (mInfo.mETag == null && !mInfo.mNoIntegrity) {
// // This should've been caught upon failure
// if (Constants.LOGVV) {
// Log.d(TAG, "setupDestinationFile() unable to resume download, deleting "
// + state.mFilename);
// }
// f.delete();
// throw new StopRequestException(Downloads.Impl.STATUS_CANNOT_RESUME,
// "Trying to resume a download that can't be resumed");
// trinea END
|
上面一段代码表示一个验证过程,可以去掉。
mETag为数据库中的etag字段值,代码中没有解释,感觉是一个验证值,类似hashcode。
mNoIntegrity为数据中no_integrity字段值,表示启动下载的应用程序能否验证下载的文件的完整性。不过坑爹的是对于etag和no_integrity都没有提供设置的接口
(3) DownloadManager类中添加对外接口
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
43
44
45
|
/**
* pause download, added by trinea@trinea.cn 2013/03/01
*
* @param ids the IDs of the downloads to be paused
* @return the number of downloads actually paused
*/
public
int
pauseDownload
(
long
.
.
.
ids
)
{
if
(
ids
==
null
||
ids
.
length
==
0
)
{
// called with nothing to remove!
throw
new
IllegalArgumentException
(
"input param 'ids' can't be null"
)
;
}
ContentValues
values
=
new
ContentValues
(
)
;
values
.
put
(
Downloads
.
Impl
.
COLUMN_CONTROL
,
Downloads
.
Impl
.
CONTROL_PAUSED
)
;
values
.
put
(
Downloads
.
Impl
.
COLUMN_STATUS
,
Downloads
.
Impl
.
STATUS_PAUSED_BY_APP
)
;
if
(
ids
.
length
==
1
)
{
return
mResolver
.
update
(
ContentUris
.
withAppendedId
(
mBaseUri
,
ids
[
0
]
)
,
values
,
null
,
null
)
;
}
return
mResolver
.
update
(
mBaseUri
,
values
,
getWhereClauseForIds
(
ids
)
,
getWhereArgsForIds
(
ids
)
)
;
}
/**
* resume download, added by trinea@trinea.cn 2013/03/01
*
* @param ids the IDs of the downloads to be resumed
* @return the number of downloads actually resumed
*/
public
int
resumeDownload
(
long
.
.
.
ids
)
{
if
(
ids
==
null
||
ids
.
length
==
0
)
{
// called with nothing to remove!
throw
new
IllegalArgumentException
(
"input param 'ids' can't be null"
)
;
}
ContentValues
values
=
new
ContentValues
(
)
;
values
.
put
(
Downloads
.
Impl
.
COLUMN_CONTROL
,
Downloads
.
Impl
.
CONTROL_RUN
)
;
values
.
put
(
Downloads
.
Impl
.
COLUMN_STATUS
,
Downloads
.
Impl
.
STATUS_RUNNING
)
;
if
(
ids
.
length
==
1
)
{
return
mResolver
.
update
(
ContentUris
.
withAppendedId
(
mBaseUri
,
ids
[
0
]
)
,
values
,
null
,
null
)
;
}
return
mResolver
.
update
(
mBaseUri
,
values
,
getWhereClauseForIds
(
ids
)
,
getWhereArgsForIds
(
ids
)
)
;
}
|
无论是暂停还是继续我们都是同时把Downloads.Impl.COLUMN_CONTROL和Downloads.Impl.COLUMN_STATUS字段进行修改,因为在DownloadInfo的private boolean isReadyToStart(long now)函数中,会对COLUMN_CONTROL字段进行判断,如果是用户手动暂停的话,是不会自动继续的,部分代码如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
private
boolean
isReadyToStart
(
long
now
)
{
if
(
DownloadHandler
.
getInstance
(
)
.
hasDownloadInQueue
(
mId
)
)
{
// already running
return
false
;
}
if
(
mControl
==
Downloads
.
Impl
.
CONTROL_PAUSED
)
{
// the download is paused, so it's not going to start
Xlog
.
i
(
Constants
.
DL_ENHANCE
,
"Download is paused "
+
"then no need to start"
)
;
return
false
;
}
……
}
|
之后我们直接调用DownloadManager的pauseDownload和resumeDownload接口即可
PS:也可以试试不做第二步的修改,而将第一步DownloadProvider的update函数修改变为
|
// trinea BEGIN, added by trinea@trinea.cn 2013/03/01
copyInteger
(
Downloads
.
Impl
.
COLUMN_STATUS
,
values
,
filteredValues
)
;
copyInteger
(
Downloads
.
Impl
.
COLUMN_NO_INTEGRITY
,
values
,
filteredValues
)
;
// trinea END
|
第二步修改变为在public int resumeDownload(long… ids)加入
|
values
.
put
(
Downloads
.
Impl
.
COLUMN_CONTROL
,
Downloads
.
Impl
.
CONTROL_RUN
)
;
values
.
put
(
Downloads
.
Impl
.
COLUMN_STATUS
,
Downloads
.
Impl
.
STATUS_RUNNING
)
;
values
.
put
(
Downloads
.
Impl
.
COLUMN_NO_INTEGRITY
,
true
)
;
|
没有亲自试,不过按照逻辑应该也可以。
2、通知栏可以设置NotiExtra和NotiClass
(1) DownloadProvider类中修改private void checkInsertPermissions(ContentValues values)函数
|
values
.
remove
(
Downloads
.
Impl
.
COLUMN_IS_VISIBLE_IN_DOWNLOADS_UI
)
;
values
.
remove
(
Downloads
.
Impl
.
COLUMN_MEDIA_SCANNED
)
;
// BEGIN, added by trinea@trinea.cn 2013/03/01
values
.
remove
(
Downloads
.
Impl
.
COLUMN_NOTIFICATION_CLASS
)
;
values
.
remove
(
Downloads
.
Impl
.
COLUMN_NOTIFICATION_EXTRAS
)
;
// trinea END
|
在DownloadProvider insert之前会调用checkInsertPermissions检查不能被插入的字段插入,这里我们需要允许这两个字段存在。
(2) DownloadManager.Request添加对外接口
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
|
// BEGIN, added by trinea@trinea.cn 2013/03/01
private
CharSequence
mNotiClass
;
private
CharSequence
mNotiExtras
;
// trinea END
/**
* Set notiClass, to be used as destination when click downloading in download manager ui
*
* @return this object
*/
public
Request
setNotiClass
(
CharSequence
notiClass
)
{
mNotiClass
=
notiClass
;
return
this
;
}
/**
* Set notiExtras, to be sended to notiClass when click downloading in download manager ui
*
* @return this object
*/
public
Request
setNotiExtras
(
CharSequence
notiExtras
)
{
mNotiExtras
=
notiExtras
;
return
this
;
}
ContentValues
toContentValues
(
String
packageName
)中
putIfNonNull
(
values
,
Downloads
.
Impl
.
COLUMN_TITLE
,
mTitle
)
;
putIfNonNull
(
values
,
Downloads
.
Impl
.
COLUMN_DESCRIPTION
,
mDescription
)
;
putIfNonNull
(
values
,
Downloads
.
Impl
.
COLUMN_MIME_TYPE
,
mMimeType
)
;
// trinea BEGIN
putIfNonNull
(
values
,
Downloads
.
Impl
.
COLUMN_NOTIFICATION_CLASS
,
mNotiClass
)
;
putIfNonNull
(
values
,
Downloads
.
Impl
.
COLUMN_NOTIFICATION_EXTRAS
,
mNotiExtras
)
;
// trinea END
|
在Request中添加接口以及允许字段修改。通过允许设置NotiExtra和NotiClass,我们可以给系统传递更丰富的参数,在通知栏点击相应或是DownloadUi中通过broadcast将这些参数传递出来方便应用调用。
3、wifi切换到3g自动暂停
(1) 修改DownloadInfo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
private
int
checkIsNetworkTypeAllowed
(
int
networkType
)
{
if
(
mIsPublicApi
)
{
final
int
flag
=
translateNetworkTypeToApiFlag
(
networkType
)
;
final
boolean
allowAllNetworkTypes
=
mAllowedNetworkTypes
==
~
0
;
if
(
!
allowAllNetworkTypes
&&
(
flag
&
mAllowedNetworkTypes
)
==
0
)
{
return
NETWORK_TYPE_DISALLOWED_BY_REQUESTOR
;
}
// trinea BEGIN
if
(
mStatus
==
Downloads
.
Impl
.
STATUS_WAITING_FOR_NETWORK
&&
flag
!=
DownloadManager
.
Request
.
NETWORK_WIFI
)
{
return
NETWORK_TYPE_DISALLOWED_BY_REQUESTOR
;
}
// trinea END
}
return
checkSizeAllowedForNetwork
(
networkType
)
;
}
|
表示等待网络时始终只等待wifi
(2) 修改DownloadReceiver.java
|
}
else
if
(
action
.
equals
(
ConnectivityManager
.
CONNECTIVITY_ACTION
)
)
{
NetworkInfo
info
=
(
NetworkInfo
)
intent
.
getParcelableExtra
(
ConnectivityManager
.
EXTRA_NETWORK_INFO
)
;
if
(
info
!=
null
&&
info
.
isConnected
(
)
)
{
startService
(
context
)
;
}
}
else
if
(
action
.
equals
(
Constants
.
ACTION_RETRY
)
)
{
|
修改为:
1
2
3
4
5
6
7
8
9
10
11
12
|
}
else
if
(
action
.
equals
(
ConnectivityManager
.
CONNECTIVITY_ACTION
)
)
{
NetworkInfo
info
=
(
NetworkInfo
)
intent
.
getParcelableExtra
(
ConnectivityManager
.
EXTRA_NETWORK_INFO
)
;
// trinea BEGIN
/**
* modified by trinea@trinea.cn @2013/04/01, resume download only when network type is wifi
*/
if
(
info
!=
null
&&
info
.
isConnected
(
)
&&
info
.
getType
(
)
==
ConnectivityManager
.
TYPE_WIFI
)
{
// trinea END
startService
(
context
)
;
}
}
else
if
(
action
.
equals
(
Constants
.
ACTION_RETRY
)
)
{
|
表示只有连接wifi时才唤醒service去检查是否下载
(3) 修改DownloadThread.java
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
|
/**
* Check if the download has been paused or canceled, stopping the request appropriately if it
* has been.
*/
private
void
checkPausedOrCanceled
(
State
state
)
throws
StopRequestException
{
synchronized
(
mInfo
)
{
if
(
mInfo
.
mControl
==
Downloads
.
Impl
.
CONTROL_PAUSED
)
{
Xlog
.
i
(
Constants
.
DL_ENHANCE
,
"DownloadThread: checkPausedOrCanceled: user pause download"
)
;
throw
new
StopRequestException
(
Downloads
.
Impl
.
STATUS_PAUSED_BY_APP
,
"download paused by owner"
)
;
}
if
(
mInfo
.
mStatus
==
Downloads
.
Impl
.
STATUS_CANCELED
)
{
throw
new
StopRequestException
(
Downloads
.
Impl
.
STATUS_CANCELED
,
"download canceled"
)
;
}
}
// if policy has been changed, trigger connectivity check
if
(
mPolicyDirty
)
{
// trinea BEGIN
/**
* add by trinea@trinea.cn @2013/04/01, when switched from wifi to 3g, pause all download
*/
NetworkInfo
info
=
mSystemFacade
.
getActiveNetworkInfo
(
mInfo
.
mUid
)
;
if
(
info
!=
null
&&
!
info
.
isConnected
(
)
)
{
mInfo
.
mStatus
=
Downloads
.
Impl
.
STATUS_WAITING_FOR_NETWORK
;
}
// trinea END
checkConnectivity
(
)
;
}
}
|
表示如果网络变化并且表示网络断开时,下载状态变为等待网络。
4、Bug修改
(1) 当存储空间不足时,利用DownloadManager下载,只显示通知栏提示,在下载管理UI中不显示
DownloadManager的Cursor runQuery(ContentResolver resolver, String[] projection, Uri baseUri)函数修改如下:
|
if
(
(
mStatusFlags
&
STATUS_RUNNING
)
!=
0
)
{
parts
.
add
(
statusClause
(
"="
,
Downloads
.
Impl
.
STATUS_RUNNING
)
)
;
// trinea BEGIN
parts
.
add
(
statusClause
(
"="
,
Downloads
.
Impl
.
STATUS_INSUFFICIENT_SPACE_ERROR
)
)
;
// trinea END
}
|
DownloadManager的CursorTranslator类的private int translateStatus(int status) 函数修改如下:
|
// trinea BEGIN
case
Downloads
.
Impl
.
STATUS_INSUFFICIENT_SPACE_ERROR
:
// trinea END
case
Downloads
.
Impl
.
STATUS_RUNNING
:
return
STATUS_RUNNING
;
|
5、编译安装
修改后是需要重新编译的,需同时编译framweork和DownloadProvider。
framework编译命令为:./makeMtk model mm frameworks/base/core/
编译后apk所在路径为out\target\product\model\system\framework\secondary_framework.jar,之后push到system/framework重启即可。编译命令中model为机型,非mtk平台命令有所不同
DownloadProvider编译命令为./makeMtk model mm packages/providers/DownloadProvider/
编译后apk所在路径为out\target\product\model\system\app\DownloadProvider.apk,之后push到system/app即可(可能需要先删除/system/app/目录下的DownloadProvider.odex)
从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);
- 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);
- 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);
- 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);
- 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) {
-
- }
- }
- };
-
- registerReceiver(receiver, filter);
- 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) {
-
- }
- }
- };
-
- 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”);
- 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”/>
- <uses-permission android:name=”android.permission.WRITE_EXTERNAL_STORAGE”/>
下面的代码片段是在外部存储中指定一个任意的保存位置的方法:
- request.setDestinationUri(Uri.fromFile(f));
- request.setDestinationUri(Uri.fromFile(f));
f是一个File对象。
如果下载的这个文件是你的应用所专用的,你可能会希望把这个文件放在你的应用在外部存储中的一个专有文件夹中。注意这个文件夹不提供访问控制,
所以其他的应用也可以访问这个文件夹。在这种情况下,如果你的应用卸载了,那么在这个文件夹也会被删除。
下面的代码片段是指定存储文件的路径是应用在外部存储中的专用文件夹的方法:
- request.setDestinationInExternalFilesDir(this,
- Environment.DIRECTORY_DOWNLOADS, “Bugdroid.png”);
- request.setDestinationInExternalFilesDir(this,
- Environment.DIRECTORY_DOWNLOADS, “Bugdroid.png”);
如果下载的文件希望被其他的应用共享,特别是那些你下载下来希望被Media Scanner扫描到的文件(比如音乐文件),那么你可以指定你的下载路径在
外部存储的公共文件夹之下,下面的代码片段是将文件存放到外部存储中的公共音乐文件夹的方法:
- request.setDestinationInExternalPublicDir(Environment.DIRECTORY_MUSIC,
- "Android_Rock.mp3");
- 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);
- 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);
-
-
- Log.d(TAG, fileName + " : " + fileUri);
- }
- myDownload.close();
-
- }
- }
- @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);
-
-
- Log.d(TAG, fileName + " : " + fileUri);
- }
- myDownload.close();
-
- }
- }
对于暂停和失败的下载,我们可以通过查询COLUMN_REASON列查询出原因的整数码。
对于STATUS_PAUSED状态的下载,可以通过DownloadManager.PAUSED_*静态常量来翻译出原因的整数码,进而判断出下载是由于等待网络连接
还是等待WiFi连接还是准备重新下载三种原因而暂停。
对于STATUS_FAILED状态的下载,我们可以通过DownloadManager.ERROR_*来判断失败的原因,可能是错误码(失败原因)包括没有存储设备,
存储空间不足,重复的文件名,或者HTTP errors。
下面的代码是如何查询出当前所有的暂停的下载任务,提取出暂停的原因以及文件名称,下载标题以及当前进度的实现方法:
-
- String serviceString = Context.DOWNLOAD_SERVICE;
- DownloadManager downloadManager;
- downloadManager = (DownloadManager)getSystemService(serviceString);
-
-
- Query pausedDownloadQuery = new Query();
- pausedDownloadQuery.setFilterByStatus(DownloadManager.STATUS_PAUSED);
-
-
- Cursor pausedDownloads = downloadManager.query(pausedDownloadQuery);
-
-
- 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);
-
-
- while (pausedDownloads.moveToNext()) {
-
- String title = pausedDownloads.getString(titleIdx);
- int fileSize = pausedDownloads.getInt(fileSizeIdx);
- int bytesDL = pausedDownloads.getInt(bytesDLIdx);
-
-
- 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;
- }
-
-
- StringBuilder sb = new StringBuilder();
- sb.append(title).append("\n");
- sb.append(reasonString).append("\n");
- sb.append("Downloaded ").append(bytesDL).append(" / " ).append(fileSize);
-
-
- Log.d("DOWNLOAD", sb.toString());
- }
-
-
- pausedDownloads.close();
-
- String serviceString = Context.DOWNLOAD_SERVICE;
- DownloadManager downloadManager;
- downloadManager = (DownloadManager)getSystemService(serviceString);
-
-
- Query pausedDownloadQuery = new Query();
- pausedDownloadQuery.setFilterByStatus(DownloadManager.STATUS_PAUSED);
-
-
- Cursor pausedDownloads = downloadManager.query(pausedDownloadQuery);
-
-
- 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);
-
-
- while (pausedDownloads.moveToNext()) {
-
- String title = pausedDownloads.getString(titleIdx);
- int fileSize = pausedDownloads.getInt(fileSizeIdx);
- int bytesDL = pausedDownloads.getInt(bytesDLIdx);
-
-
- 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;
- }
-
-
- StringBuilder sb = new StringBuilder();
- sb.append(title).append("\n");
- sb.append(reasonString).append("\n");
- sb.append("Downloaded ").append(bytesDL).append(" / " ).append(fileSize);
-
-
- Log.d("DOWNLOAD", sb.toString());
- }
-
-
- pausedDownloads.close();