自己造輪子,寫個下載管理器(三)

DownloadManager.class

在完成了編寫網絡請求、下載進度、線程等關鍵“零件”過后,我們現在要做的就是把這些零件通過一個核心骨架串聯,方便調用。這有點類似Java代理模式一樣,需要一個或多個Class帶負責這些組件的邏輯運行。現在,我們要編寫一個完成這些職責的Class,這里就命名為DownloadManager.java

 /**
 * Created by mid1529 on 2016/12/19.
 * 下載管理方法
 */
public final class DownloadManager {
    private static final String TAG = "DownloadManager";
    public static final int HANDLER_DOWNLOAD_COMPLETED = 0x234123;
    public static final int HANDLER_DOWNLOAD_FAILED = 0x12345234;
    public static final int HANDLER_DOWNLOAD_PROGRESS = 0x2052344;
    public static final int HANDLER_DOWNLOAD_CALL = 0x4234134;
    @SuppressLint("StaticFieldLeak")
    private static DownloadManager ourInstance = new DownloadManager();
    private SQLiteDao mSQLiteDao = null;
    private ArrayMap<Long, DownloadTask> mDownloadTaskQueue = null; //當前下載任務的集合
    private ArrayMap<Long, Call> mDownloadTaskCallQueue = null;
    private DownloadService.DownloadServiceBinder mDownloadServiceBinder = null;
    private ServiceConnection mServiceConnection = null;
    private Application mApplication = null;
    private DownloadCallback mDownloadCallback = null;
    private DownloadHandler mHandler = null;
    private boolean mIsDeleteHistory = false;
    private ExecutorService mCachedThreadPool = null;


    public synchronized static DownloadManager getInstance() {
        if (ourInstance == null) {
            synchronized (DownloadManager.class) {
                ourInstance = new DownloadManager();
            }
        }
        return ourInstance;
    }

    private DownloadManager() {
        mDownloadTaskQueue = new ArrayMap<>();
        mDownloadTaskCallQueue = new ArrayMap<>();
    }

    /**
     * 在Application中調用此方法初始化
     * 只有調用這方法后才可以正常運行,否則會報錯
     *
     * @param app Application
     * @return DownloadManager實例
     */
    public synchronized DownloadManager startService(Application app) {
        if (mServiceConnection != null && mApplication != null)
            return ourInstance;
        mHandler = new DownloadHandler();
        mCachedThreadPool = Executors.newCachedThreadPool();
        mApplication = app;
        Intent intent = new Intent(app, DownloadService.class);
        mServiceConnection = new ServiceConnection() {
            @Override
            public void onServiceConnected(ComponentName componentName, IBinder iBinder) {
                try {
                    mDownloadServiceBinder = (DownloadService.DownloadServiceBinder) iBinder;
                    mDownloadServiceBinder.setHandler(mHandler);
                } catch (Exception e) {
                    e.printStackTrace();
                    onDestory();
                }
            }

            @Override
            public void onServiceDisconnected(ComponentName componentName) {
                onDestory();
            }
        };
        app.startService(intent);
        app.bindService(intent, mServiceConnection, Context.BIND_AUTO_CREATE);
        mSQLiteDao = new SQLiteDao(app);
        return ourInstance;
    }

    /**
     * 添加到下載隊列,阻塞線程,建議到子線程操作
     * 如果任務已存在隊列或者任務的url、filename不合法,也會添加錯誤
     *
     * @param task 下載任務
     * @return 是否添加成功
     */
    public boolean addTaskToQueue(DownloadTask task) {
        if (!isDownloadTaskLegal(task)) //檢測下載任務的參數是否合法
            return false;
        checkInited();
        DownloadTask query = mSQLiteDao.queryTask(task);
        task.setPause(false);
        if (query == null) {//不存在表中,執行插入操作,加入下載列表
            mSQLiteDao.insertDownloadTask(task);
            query = mSQLiteDao.queryTask(task);
            task.setTaskId(query.getTaskId());
            mDownloadTaskQueue.put(query.getTaskId(), query);
            mDownloadServiceBinder.startDownload(task);
        } else {
            task.setTaskId(query.getTaskId());
            if (mDownloadTaskQueue.get(task.getTaskId()) == null) {
                task.setPause(false);
                mDownloadTaskQueue.put(task.getTaskId(), task);
                mDownloadServiceBinder.startDownload(task);
            }
        }
        return true;
    }

    /**
     * 驗證下載任務是否合法
     *
     * @param downloadTask 下載任務
     * @return 是否合法
     */
    @SuppressWarnings("RedundantIfStatement")
    private boolean isDownloadTaskLegal(DownloadTask downloadTask) {
        if (TextUtils.isEmpty(downloadTask.getFileName()))
            return false;
        if (TextUtils.isEmpty(downloadTask.getUrl()))
            return false;
        if (HttpUrl.parse(downloadTask.getUrl()) == null)
            return false;
        return true;
    }

    /**
     * 暫停下載,并將下載任務從容器中移除
     *
     * @param task 下載的任務
     */
    public void pauseDownload(DownloadTask task) {
        task.setPause(true);
        removeTaskFromQueue(task, false);
    }


    /**
     * 從下載列表中移除下載任務
     *
     * @param downloadTask      下載任務
     * @param isDeleteDbHistory 是否刪除對應任務在數據庫中的記錄
     */
    private void removeTaskFromQueue(final DownloadTask downloadTask, boolean isDeleteDbHistory) {
        if (downloadTask.getTaskId() == null)
            return;
        DownloadTask task = mDownloadTaskQueue.get(downloadTask.getTaskId());
        if (task != null) {
            mDownloadTaskQueue.remove(task.getTaskId());
        }
        Call call = mDownloadTaskCallQueue.get(downloadTask.getTaskId());
        if (call != null) {
            call.cancel();
        }
        if (isDeleteDbHistory) { //不需要刪除
            //noinspection ConstantConditions
            mCachedThreadPool.execute(new Runnable() {
                @Override
                public void run() {
                    mSQLiteDao.deleteDownloadTaskByKey(downloadTask.getTaskId());
                }
            });
        }
    }

    private void addCallToQueue(Long taskId, Call call) {
        mDownloadTaskCallQueue.put(taskId, call);
    }

    /**
     * 停止下載服務,將會停止所有,且清空下載隊列,但不會刪除數據庫中下載記錄
     */
    public void stopService() {
        checkInited();
        mDownloadTaskQueue.clear();
        removeDownloadCallback();
        if (mApplication == null)
            return;
        mApplication.stopService(new Intent(mApplication, DownloadService.class));
        mApplication.unbindService(mServiceConnection);
    }

    /**
     * 銷毀
     * 清空Handler中的消息
     * 清空用到的容器
     * 將對象置為null
     * 盡量減少內存泄漏的可能
     */
    private void onDestory() {
        mHandler.removeCallbacksAndMessages(null);
        mSQLiteDao = null;
        mDownloadTaskQueue.clear(); //當前下載任務的集合
        mDownloadTaskCallQueue.clear();
        mDownloadServiceBinder = null;
        mServiceConnection = null;
        mCachedThreadPool.shutdown();
        mCachedThreadPool = null;
        mApplication = null;
    }

    /**
     * 檢查是否已經調用start()方法初始化,沒有則直接拋異常
     */
    private void checkInited() {
        if (mDownloadServiceBinder == null) {
            throw new NullPointerException("Do you remember invok \"DownloadManager.getInstance().start()\" in your Application.class? ");
        }
    }

    /**
     * @return 返回Dao
     */
    public List<DownloadTask> getDownloadTask() {
        checkInited();
        return mSQLiteDao.queryAllTask();
    }

    /**
     * 設置下載回調監聽
     *
     * @param callback 回調
     */
    public void setDownloadCallback(DownloadCallback callback) {
        this.mDownloadCallback = callback;
    }

    /**
     * 移除監聽
     */
    public void removeDownloadCallback() {
        this.mDownloadCallback = null;
    }

    /**
     * 更新下載任務到數據庫
     *
     * @param downloadTask 下載任務
     */
    private void updateDownloadTask(final DownloadTask downloadTask) {
        mCachedThreadPool.execute(new Runnable() {
            @Override
            public void run() {
                mSQLiteDao.updateDownloadTask(downloadTask);
            }
        });
    }

    /**
     * 清空下載的信息
     *
     * @param downloadTask 下載任務
     */
    private void cleanDownloadInfo(final DownloadTask downloadTask) {
        mCachedThreadPool.execute(new Runnable() {
            @Override
            public void run() {
                removeTaskFromQueue(downloadTask, mIsDeleteHistory);
            }
        });

    }

    /**
     * 是否在下載失敗或完成后,刪除下載任務
     *
     * @return 是否刪除
     */
    public boolean isDeleteHistory() {
        return mIsDeleteHistory;
    }

    /**
     * 設置是否刪除下載任務的記錄
     *
     * @param deleteHistory 是否刪除
     */
    public void setDeleteHistory(boolean deleteHistory) {
        mIsDeleteHistory = deleteHistory;
    }

    /**
     * Handler負責處理進度傳遞消息等
     */
    @SuppressWarnings("unchecked")
    private static class DownloadHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case HANDLER_DOWNLOAD_PROGRESS:
                    getInstance().updateDownloadTask((DownloadTask) msg.obj);
                    getInstance().mDownloadCallback.onProgress((DownloadTask) msg.obj);
                    break;
                case HANDLER_DOWNLOAD_COMPLETED:
                    getInstance().cleanDownloadInfo((DownloadTask) msg.obj);
                    getInstance().mDownloadCallback.onComplete((DownloadTask) msg.obj);
                    break;
                case HANDLER_DOWNLOAD_FAILED:
                    getInstance().cleanDownloadInfo((DownloadTask) msg.obj);
                    getInstance().mDownloadCallback.onDownloadFaild((DownloadTask) msg.obj);
                    break;
                case HANDLER_DOWNLOAD_CALL:
                    if (msg.obj instanceof ArrayMap) {
                        ArrayMap<Long, Call> map = (ArrayMap<Long, Call>) msg.obj;
                        if (map.size() != 0) {
                            getInstance().addCallToQueue(map.keyAt(0), map.get(map.keyAt(0)));
                        }
                    }
                    break;
            }
        }
    }

}

典型的,因為一個App中只需要一個下載管理實例,所以我們控制只能用單例模式獲取DownloadManager實例,然后進行通信。有興趣的參考注釋閱讀。

總結

這個項目中,在提取網絡Header中的數據時,采用正則表達式提取,比如Range,這種做法總感覺不科學,但不知道有什么方法獲取到,這里就謙虛謙虛,誰能告知下科學方法。
整體思路就是這樣,現在只是V0.2版本,很多地方不是很嚴謹,很多地方偷懶,過兩天再改善吧。

流程圖及整體Project周日會放到GitHub中,有興趣的可以看看

到這里算是結束了這為期三天的水文,能靜下來寫點東西還真不容易,好好堅持吧。

Lolipop
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容