Android 经典笔记之五：DownloadManager下载管理器介绍

DownloadManager下载管理器介绍
目录介绍：

• 0.简单介绍
• 1.所需权限
• 2.获取对象，开始下载
• 3.取消下载

• 4.Request类的介绍

  • 4.5.指定下载的类型
  • 4.6.定制Notification样式
  • 4.7.设置下载文件类型
  • 4.8.添加请求下载的网络链接的http头，比如User-Agent，gzip压缩等
• 5.Query 类
• 6.不足之处
• 7.代码案例【简易】

0.简单介绍

• 关于DownloadManager简单介绍
  DownloadManager是android2.3以后，系统下载的方法，是处理长期运行的HTTP下载的系统服务。客户端可以请求的URI被下载到一个特定的目标文件。客户端将会在后台与http交互进行下载，或者在下载失败，或者连接改变，重新启动系统后重新下载。还可以进入系统的下载管理界面查看进度。DownloadManger有两个内部类，Request 和Query。Request类可设置下载的一些属性。Query类可查询当前下载的进度，下载地址，文件存放目录等数据。

1.所需权限

<uses-permission android:name="android.permission.INTERNET" />;
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>;

注意，访问本地控件【sd卡，手机内存卡】需要检测是否添加权限

/**检测存储权限*/
private final int REQUEST_EXTERNAL_STORAGE = 1;
private String[] PERMISSIONS_STORAGE = {
        Manifest.permission.READ_EXTERNAL_STORAGE,
        Manifest.permission.WRITE_EXTERNAL_STORAGE
};

public void verifyStoragePermissions(Activity activity) {
    // Check if we have write permission
    int permission = ActivityCompat.checkSelfPermission(activity, Manifest.permission.WRITE_EXTERNAL_STORAGE);
    if (permission != PackageManager.PERMISSION_GRANTED) {
        // We don't have permission so prompt the user
        ActivityCompat.requestPermissions(activity, PERMISSIONS_STORAGE, REQUEST_EXTERNAL_STORAGE);
    }
}

2.获取对象，开始下载

• 获取对象，开始下载

DownloadManager downloadManager = (DownloadManager)getSystemService(DOWNLOAD_SERVICE);
DownloadManager.Request request = new DownloadManager.Request(Uri.parse(apkUrl));
long id = downloadManager.enqueue(request);
//每下载的一个文件对应一个id，通过此id可以查询数据。

3.取消下载

downloadManager.remove(REFERENCE_1, REFERENCE_2, REFERENCE_3);
该方法返回成功取消的下载的个数，如果一个下载被取消了，所有相关联的文件，部分下载的文件和完全下载的文件都会被删除.

4.Request类的介绍

/**
* 方法1:
* 目录: Android -> data -> com.app -> files -> Download -> dxtj.apk
* 这个文件是你的应用所专用的,软件卸载后，下载的文件将随着卸载全部被删除
*/
request.setDestinationInExternalFilesDir( this , Environment.DIRECTORY_DOWNLOADS ,  "dxtj.apk" );

/**
* 方法2:
* 下载的文件存放地址  SD卡 download文件夹，dxtj.apk
* 软件卸载后，下载的文件会保留
*/
//在SD卡上创建一个文件夹
request.setDestinationInExternalPublicDir(  "/epmyg/"  , "dxtj.apk" ) ;

/**
* 方法3:
* 如果下载的文件希望被其他的应用共享
* 特别是那些你下载下来希望被Media Scanner扫描到的文件（比如音乐文件）
*/
request.setDestinationInExternalPublicDir( Environment.DIRECTORY_MUSIC,  "告白气球.mp3" );

/**
* 方法4【投资界和新芽目前用这个】
* 文件将存放在外部存储的确实download文件内，如果无此文件夹，创建之，如果有，下面将返回false。
* 系统有个下载文件夹，比如小米手机系统下载文件夹  SD卡--> Download文件夹
*/
//创建目录
Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).mkdir() ;
//设置文件存放路径
request.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS  , "dxtj.apk" ) ;

• 4.1 指定下载的类型

//指定在WIFI状态下，执行下载操作。
request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_WIFI);
//指定在MOBILE状态下，执行下载操作
request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_MOBILE);
//是否允许漫游状态下，执行下载操作
request.setAllowedOverRoaming(boolean);
//是否允许“计量式的网络连接”执行下载操作
request.setAllowedOverMetered(boolean); //默认是允许的。

• 4.2 定制Notification样式

//设置Notification的标题和描述
request.setTitle("标题"); 
request.setDescription("描述");
//设置Notification的显示，和隐藏。
request.setNotificationVisibility(visibility);
VISIBILTY_HIDDEN: Notification:将不会显示，如果设置该属性的话，必须要添加权限
android.permission.DOWNLOAD_WITHOUT_NOTIFICATION.
VISIBILITY_VISIBLE： Notification显示，但是只是在下载任务执行的过程中显示，下载完成自动消失。（默认值）
VISIBILITY_VISIBLE_NOTIFY_COMPLETED : Notification显示，下载进行时，和完成之后都会显示。
VISIBILITY_VISIBLE_NOTIFY_ONLY_COMPLETION ：只有当任务完成时，Notification才会显示。
对Notification的设定方法相对较少。

• 4.3 设置下载文件类型

request.setMimeType("application/vnd.android.package-archive");
这是安卓.apk文件的类型。有些机型必须设置此方法，才能在下载完成后，点击通知栏的Notification时，才能正确的打开安装界面。不然会弹出一个Toast（can not open file）.其他文件类型的MimeType

• 4.4 添加请求下载的网络链接的http头，比如User-Agent，gzip压缩等

request.addRequestHeader(String header, String value)；

5.Query 类

• 我们的需求，可能不只是在Notification 中显示进度就好了，也许，在app中也需要获取实时下载进度。所以Query类就是提供查询的一些方法。
• 但API中就只有两个方法，原来，他把数据保存在数据库中去了。我们需要获得一个Cursor 结果集，通过结果集获得我们想要的数据。

DownloadManager.Query query = new DownloadManager.Query();
Cursor cursor = downloadManager.query(query.setFilterById(id));
if (cursor != null && cursor.moveToFirst()) {
    //下载的文件到本地的目录
    String address = cursor.getString(cursor.getColumnIndex(DownloadManager.COLUMN_LOCAL_URI));
    //已经下载的字节数
    int bytes_downloaded = cursor.getInt(cursor.getColumnIndex(DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR));
    //总需下载的字节数
    int bytes_total = cursor.getInt(cursor.getColumnIndex(DownloadManager.COLUMN_TOTAL_SIZE_BYTES));
    //Notification 标题
    String title =cursor.getString(cursor.getColumnIndex(DownloadManager.COLUMN_TITLE));
    //描述
    String description =cursor.getString(cursor.getColumnIndex(DownloadManager.COLUMN_DESCRIPTION));
    //下载对应id
    long id =cursor.getLong(cursor.getColumnIndex(DownloadManager.COLUMN_ID));
    //下载文件名称
    String filename =cursor.getString(cursor.getColumnIndex(DownloadManager.COLUMN_LOCAL_FILENAME));
    //下载文件的URL链接
    String url =cursor.getString(cursor.getColumnIndex(DownloadManager.COLUMN_URI));
}

6.不足之处

• 1、我发现，在下载的时候，发送Notification时 是没有声音的。也没有设置声音的方法。不过这影响不大。主要的功能实现就好。
• 2、因为这是系统的类，每个系统的Notification界面是不一样的。这就是每个rom厂家的自定义了。小米和魅族的就大不一样。魅族Notification上有一个下载暂停的按钮，而小米没有。所以导致Notification是不能统一的。其实，暂停的话用户可以点击notification,进入到下载管理界面，就有暂停按钮了。

7.代码案例【简易】

/**
* 开始下载
* @param context
*/
private static void startDownload(Context context) {
    int status = getDownloadStatus(context);
    if (status != DOWNLOAD_STATUS_NEED_LOAD) {
        // 不用下载则无需下列操作
        return;
    }

    DialogUtils.showToast(context, "开始下载安装包...");
    // parse url
    Uri mUri = Uri.parse(path);
    // create request
    DownloadManager.Request r = new DownloadManager.Request(mUri);
    // set request property
    String apkName = getDownloadApkName(context);
    // set 下载路径
    r.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, apkName);
    // set Notification
    r.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
    // create manager
    DownloadManager dm = (DownloadManager) context.getSystemService(Context.DOWNLOAD_SERVICE);
    // key code, set mine type
    r.setMimeType("application/vnd.android.package-archive");
    // add to queue
    dm.enqueue(r);
}

/**获得Apk的名称*/
@NonNull
private static String getDownloadApkName(Context context) {
    return context.getString(R.string.app_name) + "_" + version + ".apk";
}

/**
* 判断当前版本文件下载状态
* @param context
* @return
*/
private static int getDownloadStatus(Context context) {
    DownloadManager.Query query = new DownloadManager.Query();
    DownloadManager dm = (DownloadManager) context.getSystemService(Activity.DOWNLOAD_SERVICE);
    Cursor c = dm.query(query);

    if (!c.moveToFirst()) {
        // 无下载内容
        return DOWNLOAD_STATUS_NEED_LOAD;
    }

    do {
        int status = c.getInt(c.getColumnIndex(DownloadManager.COLUMN_STATUS));
        String title = c.getString(c.getColumnIndex(DownloadManager.COLUMN_TITLE));
        String apkName = getDownloadApkName(context);
        if (title.equals(apkName)) {
            // 如果下载列表中文件是当前版本应用，则继续判断下载状态
            if (status == DownloadManager.STATUS_SUCCESSFUL) {
                // 如果已经下载，返回状态，同时直接提示安装
                String uri = c.getString(c.getColumnIndex(DownloadManager.COLUMN_LOCAL_URI));
                promptInstall(context, Uri.parse(uri));
                return DOWNLOAD_STATUS_LOADED;
            } else if (status == DownloadManager.STATUS_RUNNING
                    || status == DownloadManager.STATUS_PAUSED
                    || status == DownloadManager.STATUS_PENDING) {
                return DOWNLOAD_STATUS_RUNNING;
            } else {
                // 失败也视为可以再次下载
                return DOWNLOAD_STATUS_NEED_LOAD;
            }
        }
    } while (c.moveToNext());
    return DOWNLOAD_STATUS_NEED_LOAD;
}

/**
* 根据下载队列id获取下载Uri
* @param enqueueId
* @return null-获取不到
*/
public static Uri getDownloadUriById(Context context, long enqueueId) {
    DownloadManager.Query query = new DownloadManager.Query();
    query.setFilterById(enqueueId);
    DownloadManager dm = (DownloadManager) context.getSystemService(Activity.DOWNLOAD_SERVICE);
    Cursor c = dm.query(query);
    if (c.moveToFirst()) {
        int columnIndex = c.getColumnIndex(DownloadManager.COLUMN_STATUS);
        if (DownloadManager.STATUS_SUCCESSFUL == c.getInt(columnIndex)) {
            String uri = c.getString(c.getColumnIndex(DownloadManager.COLUMN_LOCAL_URI));
            return Uri.parse(uri);
        }
    }
    return null;
}

/**
* 安装文件
* @param context      上下文
* @param data          uri地址
*/
public static void promptInstall(Context context, Uri data) {
    Intent promptInstall = new Intent(Intent.ACTION_VIEW).setDataAndType(data, "application/vnd.android.package-archive");
    // FLAG_ACTIVITY_NEW_TASK 可以保证安装成功时可以正常打开 app
    promptInstall.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
    context.startActivity(promptInstall);
}

其他

• 知乎：https://www.zhihu.com/people/yang-chong-69-24/pins/posts
• 领英：https://www.linkedin.com/in/chong-yang-049216146/
• 简书：http://www.jianshu.com/u/b7b2c6ed9284
• csdn：http://my.csdn.net/m0_37700275
• 网易博客：http://yangchong211.blog.163.com/
• 新浪博客：http://blog.sina.com.cn/786041010yc
• github：https://github.com/yangchong211
• 喜马拉雅听书：http://www.ximalaya.com/zhubo/71989305/
• 脉脉：yc930211
• 360图书馆：http://www.360doc.com/myfiles.aspx
• 开源中国：https://my.oschina.net/zbj1618/blog
• 泡在网上的日子：http://www.jcodecraeer.com/member/content_list.php?channelid=1
• 邮箱：yangchong211@163.com