从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传递给DownloadManager的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 = newRequest(uri); long reference =downloadManager.enqueue(request);
在这里返回的reference变量是系统为当前的下载请求分配的一个唯一的ID,我们可以通过这个ID重新获得这个下载任务,进行一些自己想要进行的操作或者查询下载的状态以及取消下载等等。
我们可以通过addRequestHeader方法为DownloadManager.Request对象request添加HTTP头,也可以通过setMimeType方法重写从服务器返回的mimetype。
我们还可以指定在什么连接状态下执行下载操作。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 = newIntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE); BroadcastReceiver receiver = newBroadcastReceiver() { @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 = newIntentFilter(DownloadManager.ACTION_NOTIFICATION_CLICKED); BroadcastReceiver receiver = newBroadcastReceiver() { @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(“EarthquakeXML”);
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-permissionandroid: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 ManagerService. String serviceString =Context.DOWNLOAD_SERVICE; DownloadManager downloadManager; downloadManager =(DownloadManager)getSystemService(serviceString); // Create a query for pauseddownloads. Query pausedDownloadQuery = newQuery(); pausedDownloadQuery.setFilterByStatus(DownloadManager.STATUS_PAUSED); // Query the Download Manager for pauseddownloads. Cursor pausedDownloads =downloadManager.query(pausedDownloadQuery); // Find the column indexes for the data werequire. 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); intfileSize = pausedDownloads.getInt(fileSizeIdx); intbytesDL = pausedDownloads.getInt(bytesDLIdx); //Translate the pause reason to friendly text. intreason = 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(" "); sb.append(reasonString).append(" "); sb.append("Downloaded ").append(bytesDL).append(" /" ).append(fileSize); //Display the status Log.d("DOWNLOAD", sb.toString()); } // Close the result Cursor. pausedDownloads.close();
DownloadManager怎设置下载路径
首先要在AndroidManifest.xml中申请访问DownloadManager的权限 添加一个下载任务: ContentValues values = new ContentValues(); values.put(Downloads.URI, url);//指定下载地址 values.put(Downloads.COOKIE_DATA, cookie);//如果下载Server需要cookie,设置cookie values.put(Downloads.VISIBILITY,Downloads.VISIBILITY_HIDDEN);//设置下载提示是否在屏幕顶部显示 values.put(Downloads.NOTIFICATION_PACKAGE, getPackageName());//设置下载完成之后回调的包名 values.put(Downloads.NOTIFICATION_CLASS, DownloadCompleteReceiver.class.getName());//设置下载完成之后负责接收的Receiver,这个类要继承BroadcastReceiver values.put(Downloads.DESTINATION,save_path);//设置下载到的路径,这个需要在Receiver里自行处理 values.put(Downloads.TITLE,title);//设置下载任务的名称 this.getContentResolver().insert(Downloads.CONTENT_URI, values);//将其插入到DownloadManager的数据库中,数据库会触发修改事件,启动下载任务 到eoeAndroid网站查看回答详情>>
android downloadmanager获取下载文件总大小的时,为何会返回-1
HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestProperty("Accept-Encoding", "identity"); conn.connect();
加上中间这一行。(默认使用gzip压缩,导致无法提前获取下载文件的总大小,不让它压缩即可)
确保下载路径存在。
Android学习笔记(四六):互联网通信-文件下载
在Android 2.3引入了DownloadManager可以处理复杂的文件下载,包括检查用户是否有数据联系(WIFI或者移动数据),当用户从一个有数据连接的地方移动到无连接的地方(例如离开了wifi或者3G data的access point),确保设备在下载过程中保持awake状态。DownloadManager可以处理HTTP URLs,但是不能处理HTTPS(SSL) URLs。
设置下载文件条件许可
在这个例子,将学习通过DownloadManager从Internet下载文件,并存储在外部存储介质SD卡上。有以下需要注意:
- 由于不支持2.3之前的版本,需将最小版本设置为Android2.3或者以上。
- 在模拟器,我们需确保已设置SD卡,如右图所示。
- 程序具有Internet以及外部存储的访问权限,在Androidmanifest.xml中设置:
<uses-permission android:name="android.permission.INTERNET"/> < uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> < application> .... < /application>
小程序的设计
具体的xml文件略去。布局简单地分为3个button,如右图,第一个button设置android:onClick="startDownload",即点击后触发startDownload()方法,用于请求下载文件。第二个button触发queryStatus(),并disabled,点击触发下载的状态查询。第三个button触发viewLog(),调用系统提供的DownloadManager的Activity,用来查看历史下载情况。
请求文件下载
privateDownloadManager mgr = null; private long lastDownloadId = 0;
protected void onCreate(Bundle savedInstanceState) { … … // 步骤1 : 获取系统服务,并指明是下载服务,即DownloadManager。系统的这类服务大部分这些管理没有close() ,release()之类的由系统garbage收集来处理。我们只需获取这些服务的对象,并发出我们的请求 mgr = (DownloadManager)getSystemService(DOWNLOAD_SERVICE); }
public void startDownload(View v){ Uri uri = Uri.parse("http://commonsware.com/misc/test.mp4"); //文件将存放在外部存储的确实download文件内,如果无此文件夹,创建之,如果有,下面将返回false。不同的手机不同Android版本的SD卡的挂载点可能会不一样,因此通过系统方式获取。 Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).mkdir();
//步骤2: 通过向下载服务发出enqueue()的请求,将放在下载队列中,通常会触发立即下载,并返回下载的ID号,根据这个号,可以查询相关的下载情况。分别设置请求的Uri,允许的数据访问方式,是否允许漫游,本地存储的位置,以及为这个下载设置title和描述信息。 lastDownloadId = mgr.enqueue(new DownloadManager.Request(uri) .setAllowedNetworkTypes(DownloadManager.Request.NETWORK_MOBILE | DownloadManager.Request.NETWORK_WIFI) .setAllowedOverRoaming(false) //缺省是true,所以天价漫游数据费的产生 .setTitle("MyTest") //用于信息查看 .setDescription("Something Useful") //用于信息查看 .setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, "test.mp4")); v.setEnabled(false); findViewById(R.id.c25_query).setEnabled(true); }
获取下载状态
通常会有一个后台运行来不断更新下载的情况,例子目的是如何获取,所以简单地通过点击第二个button触发查询下载状态。
public void queryStatus(View v){ //关键:通过ID向下载管理查询下载情况,返回一个cursor Cursor c = mgr.query(new DownloadManager.Query().setFilterById(lastDownloadId)); if(c == null){ Toast.makeText(this, "Download not found!", Toast.LENGTH_LONG).show(); }else{ //以下是从游标中进行信息提取 c.moveToFirst(); Log.d(getClass().getName(),"Column_id : " + c.getLong(c.getColumnIndex(DownloadManager.COLUMN_ID))); Log.d(getClass().getName(),"Column_bytes_downloaded so far : " + c.getLong(c.getColumnIndex(DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR))); Log.d(getClass().getName(),"Column last modified timestamp : " + c.getLong(c.getColumnIndex(DownloadManager.COLUMN_LAST_MODIFIED_TIMESTAMP))); Log.d(getClass().getName(),"Column local uri : " + c.getString(c.getColumnIndex(DownloadManager.COLUMN_LOCAL_URI))); Log.d(getClass().getName(),"Column statue : " + c.getInt(c.getColumnIndex(DownloadManager.COLUMN_STATUS))); Log.d(getClass().getName(),"Column reason : " + c.getInt(c.getColumnIndex(DownloadManager.COLUMN_REASON)));
Toast.makeText(this, statusMessage(c), Toast.LENGTH_LONG).show(); } }
private String statusMessage(Cursor c){ switch(c.getInt(c.getColumnIndex(DownloadManager.COLUMN_STATUS))){ case DownloadManager.STATUS_FAILED: return "Download failed"; case DownloadManager.STATUS_PAUSED: return "Download paused"; case DownloadManager.STATUS_PENDING: return "Download pending"; case DownloadManager.STATUS_RUNNING: return "Download in progress!"; case DownloadManager.STATUS_SUCCESSFUL: return "Download finished"; default: return "Unknown Information"; } }
从信息中,我们可以看到下载的存放的位置,SD卡的挂点为/mnt/sdcard/我们可以通过$adb shell进入模拟器的控制台进行查看。另外获取文件的总体大小为COLUMN_TOTAL_SIZE_BYTES。
# pwd/mnt/sdcard/Download # ls -l ----rwxr-x system sdcard_rw 6219229 2011-11-01 14:19 test.mp4
通过下载管理查看
public void viewLog(View v){ startActivity(new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS)); }
通过BoardReceiver获取实时事件触发
在上面的例子中,希望在一下载完进行触发,将第一个button恢复为enabled状态。在Android学习笔记(三四):再谈Intent(上)-一些知识中谈到,通过BoardReceiver从服务器中获取事件触发处理。
protected void onCreate(Bundle savedInstanceState) { ... ... //当下载结束时进行触发。 registerReceiver(onComplete, new IntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE)); //当点击一个正在下载的文件,如图所示 registerReceiver(onNotification,new IntentFilter(DownloadManager.ACTION_NOTIFICATION_CLICKED)); } BroadcastReceiver onComplete = new BroadcastReceiver() { public void onReceive(Context context, Intent intent) { findViewById(R.id.c25_start).setEnabled(true); } }; BroadcastReceiver onNotification = new BroadcastReceiver() { public void onReceive(Context context, Intent intent) { Toast.makeText(context, "..............", Toast.LENGTH_LONG).show(); } };
对于DownloadManager,如果文件已经下载,第二次无需再下载。另外由于DownloadManager属于系统服务,不仅是你的app可以调用,也就是上面list的内容是全局的,可能部分并非你的app在下载,这样会使用户迷惑,在request请求中,我们可以同setVisibleInDownloadsUi(false),可以屏蔽之。
传统文件下载方式
ownloadManager服务需要Android版本2.3以上,如果不满足条件,可采用获取网络文件流的方式来处理,具体步骤如下:
- 建一个HttpURLConnection的对象,可以通过URL对象的openConnection()方法获取,例如:HttpURLConnection urlConn = (HttpURLConnection) url.openconnection();
- 获取一个InputStream对象:urlConn.getInputStream()。
有了InputStream,剩下的都是Java的标准I/O操作。
注意
对于Internet的访问,不要再应用的主线程进行,而应该在后台线程中处理HttpClient,HttpUrlConnection以及其他的Internet access API。Android学习笔记(四五):互联网通信-HttpClient、XML解析(W3C)的例子只是作为小例子简单清晰说明相关的使用方式。
相关链接:我的Andriod开发相关文章