使用DownloadManager处理下载任务

最近做SDK开发,有个简单的下载功能,为了方便及不增加第三方库,遂采用了系统的DownloadManager来处理下载任务。

官网的说明:

The download manager is a system service that handles long-running HTTP downloads. Clients may request that a URI be downloaded to a particular destination file. The download manager will conduct the download in the background, taking care of HTTP interactions and retrying downloads after failures or across connectivity changes and system reboots.

Apps that request downloads through this API should register a broadcast receiver for ACTION_NOTIFICATION_CLICKED to appropriately handle when the user clicks on a running download in a notification or from the downloads UI.

Note that the application must have the Manifest.permission.INTERNET permission to use this class.

Instances of this class must be obtained using Context.getSystemService(Class) with the argument DownloadManager.class or Context.getSystemService(String) with the argument Context.DOWNLOAD_SERVICE.

下载状态:
DownloadManager.STATUS_PAUSED:下载暂停
DownloadManager.STATUS_PENDING:下载延迟
DownloadManager.STATUS_RUNNING:正在下载
DownloadManager.STATUS_SUCCESSFUL:下载完成
DownloadManager.STATUS_FAILED:下载失败

文件信息:
DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR:已下载文件大小
DownloadManager.COLUMN_TOTAL_SIZE_BYTES:文件总大小

广播:
DownloadManager.ACTION_NOTIFICATION_CLICKED:下载通知点击事件广播

最后代码如下

public class DownloadHelper {

    private static final String TAG = "DownloadHelper";

    private boolean debug = false;

    private Context context;
    /**
     * 系统下载管理器
     */
    private DownloadManager mDownloadManager;
    /**
     * 下载ID
     */
    private long mDownloadId;
    /**
     * 文件名
     */
    private String fileName;
    /**
     * 文件下载地址
     */
    private String downloadUrl;

    private boolean downloading;

    /**
     * 通知栏点击事件,点击进入下载详情
     */
    private BroadcastReceiver mDownloadDetailsReceiver;

    private final Runnable mQueryProgressRunnable = new Runnable() {

        @Override
        public void run() {
            queryProgress();
            if (downloading) {
                mHandler.postDelayed(mQueryProgressRunnable, 1000);
            }
        }
    };

    private final Handler mHandler = new Handler(Looper.getMainLooper());

    private DownloadListener downloadListener;

    public interface DownloadListener {

        void onStart();

        void onProgress(long soFarSize, long totalSize);

        void onFinish(String fileFullPath, long totalSize);

        void onFailed();
    }

    public void setDownloadListener(DownloadListener listener) {
        this.downloadListener = listener;
    }

    private DownloadHelper(Context context, String fileName, String downloadUrl) {
        this.context = context;
        this.fileName = fileName;
        this.downloadUrl = downloadUrl;
    }

    public static DownloadHelper getInstance(Context context, String fileName, String downloadUrl) {
        DownloadHelper helper = new DownloadHelper(context, fileName, downloadUrl);
        helper.registerReceiver();
        return helper;
    }

    /**
     * 注册广播
     */
    private void registerReceiver() {
        mDownloadDetailsReceiver = new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                String action = intent.getAction();
                if (DownloadManager.ACTION_NOTIFICATION_CLICKED.equals(action)) {
                    showDownloadList();
                }
            }
        };
        context.registerReceiver(mDownloadDetailsReceiver, new IntentFilter(DownloadManager.ACTION_NOTIFICATION_CLICKED));
    }

    /**
     * 显示下载列表
     */
    public void showDownloadList() {
        Intent downloadIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
        if (downloadIntent.resolveActivity(context.getPackageManager()) != null) {
            context.startActivity(downloadIntent);
        }
    }

    /**
     * 开始下载
     */
    public void startDownload() {
        if (downloadListener != null) downloadListener.onStart();

        mDownloadManager = (DownloadManager) context.getSystemService(Context.DOWNLOAD_SERVICE);
        DownloadManager.Request request = new DownloadManager.Request(Uri.parse(downloadUrl));
        request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_MOBILE | DownloadManager.Request.NETWORK_WIFI)
                .setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED)
                .setTitle(fileName) // 通知标题信息
                .setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
        try {
            mDownloadId = mDownloadManager.enqueue(request); // 加入下载队列
            if (mDownloadId != 0) {
                startQueryProgress();
            }
        } catch (IllegalArgumentException e) {
            if (downloadListener != null) downloadListener.onFailed();
            // "更新失败", "请在设置中开启下载管理"
            Intent intent = new Intent(Settings.ACTION_APPLICATION_DETAILS_SETTINGS);
            intent.setData(Uri.parse("package:" + "com.android.providers.downloads"));
            if (intent.resolveActivity(context.getPackageManager()) != null) {
                context.startActivity(intent);
            }
        }
    }

    /**
     * 查询下载进度
     */
    private void queryProgress() {
        // 通过ID向下载管理查询下载情况,返回一个cursor
        Cursor c = mDownloadManager.query(new DownloadManager.Query().setFilterById(mDownloadId));
        if (c != null && c.moveToFirst()) {
            int status = c.getInt(c.getColumnIndex(DownloadManager.COLUMN_STATUS));
            logDebug("下载状态:" + status);
            switch (status) {
                case DownloadManager.STATUS_PAUSED: //下载暂停, 由系统触发
                case DownloadManager.STATUS_PENDING: //下载延迟, 由系统触发
                    break;
                case DownloadManager.STATUS_RUNNING: //正在下载, 由系统触发
                    long soFarSize = c.getLong(c.getColumnIndex(DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR));
                    long totalSize = c.getLong(c.getColumnIndex(DownloadManager.COLUMN_TOTAL_SIZE_BYTES));
                    if (totalSize > 0) {
                        logDebug(String.format("total:%s soFar:%s ", totalSize, soFarSize) + soFarSize * 1.0f / totalSize);
                        if (downloadListener != null) {
                            downloadListener.onProgress(soFarSize, totalSize);
                        }
                    }
                    break;
                case DownloadManager.STATUS_SUCCESSFUL: //下载完成, 由系统触发
                    stopQueryProgress();
                    File downloadDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS);
                    totalSize = c.getLong(c.getColumnIndex(DownloadManager.COLUMN_TOTAL_SIZE_BYTES));
                    if (downloadListener != null) {
                        String fullName = downloadDir.getPath() + File.separator + fileName;
                        logDebug(fullName);
                        downloadListener.onFinish(fullName, totalSize);
                    }
                    break;
                case DownloadManager.STATUS_FAILED: //下载失败, 由系统触发
                    if (downloadListener != null) downloadListener.onFailed();
                    break;
            }
        } else {
            stopQueryProgress();
            if (downloadListener != null) downloadListener.onFailed();
        }
        closeCursor(c);
    }

    private void closeCursor(Cursor cursor) {
        if (cursor != null && !cursor.isClosed()) {
            cursor.close();
        }
    }

    private void logDebug(String msg) {
        if (debug) {
            Log.e(TAG, msg);
        }
    }

    /**
     * 移除下载并删除下载文件
     */
    public void removeDownload() {
        mDownloadManager.remove(mDownloadId);
        stopQueryProgress();
    }

    /**
     * 开始查询下载进度
     */
    private void startQueryProgress() {
        downloading = true;
        mHandler.post(mQueryProgressRunnable);
    }

    /**
     * 停止查询下载进度
     */
    private void stopQueryProgress() {
        downloading = false;
        mHandler.removeCallbacks(mQueryProgressRunnable);
    }

    public boolean isDownloading() {
        return downloading;
    }

    public void onDestroy() {
        try {
            stopQueryProgress(); //停止查询下载进度
            context.unregisterReceiver(mDownloadDetailsReceiver);
        } catch (Exception ex) {
            //java.lang.IllegalArgumentException: Receiver not registered:
        }
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容