利用FileDownLoad实现文件框架

来源:互联网 发布:淘宝精品推荐是什么 编辑:程序博客网 时间:2024/06/06 11:39

最近项目中有个文件下载及管理的功能。一般自己写的下载只能实现下载功能,要实现本地文件管理的功能颇复杂,需要自己维护本地数据库。网上查了下,刚好有个使用的框架——FileDownloader。
项目主页:https://github.com/wlfcolin/file-downloader
1、gradle中使用:compile 'org.wlf:FileDownloader:0.3.2'
2、application的onCreate()中初始化FileDownloader

  // 1、创建BuilderBuilder builder = new FileDownloadConfiguration.Builder(this);// 2.配置Builder// 配置下载文件保存的文件夹builder.configFileDownloadDir(Environment.getExternalStorageDirectory().getAbsolutePath() + File.separator +"FileDownloader");// 配置同时下载任务数量,如果不配置默认为2builder.configDownloadTaskSize(3);// 配置失败时尝试重试的次数,如果不配置默认为0不尝试builder.configRetryDownloadTimes(5);// 开启调试模式,方便查看日志等调试相关,如果不配置默认不开启builder.configDebugMode(true);// 配置连接网络超时时间,如果不配置默认为15秒builder.configConnectTimeout(25000);// 25秒// 3、使用配置文件初始化FileDownloaderFileDownloadConfiguration configuration = builder.build();FileDownloader.init(configuration);

3、 注册监听器(如果不需要监听,可以忽略),监听器是基于观察者模式设计的全局监听器,可以设置多个,记得在不需要的时候取消注册
-注册下载状态监听器(一般在fragment或activity的onCreate方法中注册,如果你使用service,请查看在Service中使用FileDownloader)

private OnFileDownloadStatusListener mOnFileDownloadStatusListener = new OnSimpleFileDownloadStatusListener() {    @Override    public void onFileDownloadStatusRetrying(DownloadFileInfo downloadFileInfo, int retryTimes) {        // 正在重试下载(如果你配置了重试次数,当一旦下载失败时会尝试重试下载),retryTimes是当前第几次重试    }    @Override    public void onFileDownloadStatusWaiting(DownloadFileInfo downloadFileInfo) {        // 等待下载(等待其它任务执行完成,或者FileDownloader在忙别的操作)    }    @Override    public void onFileDownloadStatusPreparing(DownloadFileInfo downloadFileInfo) {        // 准备中(即,正在连接资源)    }    @Override    public void onFileDownloadStatusPrepared(DownloadFileInfo downloadFileInfo) {        // 已准备好(即,已经连接到了资源)    }    @Override    public void onFileDownloadStatusDownloading(DownloadFileInfo downloadFileInfo, float downloadSpeed, long            remainingTime) {        // 正在下载,downloadSpeed为当前下载速度,单位KB/s,remainingTime为预估的剩余时间,单位秒    }    @Override    public void onFileDownloadStatusPaused(DownloadFileInfo downloadFileInfo) {        // 下载已被暂停    }    @Override    public void onFileDownloadStatusCompleted(DownloadFileInfo downloadFileInfo) {        // 下载完成(整个文件已经全部下载完成)    }    @Override    public void onFileDownloadStatusFailed(String url, DownloadFileInfo downloadFileInfo, FileDownloadStatusFailReason failReason) {        // 下载失败了,详细查看失败原因failReason,有些失败原因你可能必须关心        String failType = failReason.getType();        String failUrl = failReason.getUrl();// 或:failUrl = url,url和failReason.getUrl()会是一样的        if(FileDownloadStatusFailReason.TYPE_URL_ILLEGAL.equals(failType)){            // 下载failUrl时出现url错误        }else if(FileDownloadStatusFailReason.TYPE_STORAGE_SPACE_IS_FULL.equals(failType)){            // 下载failUrl时出现本地存储空间不足        }else if(FileDownloadStatusFailReason.TYPE_NETWORK_DENIED.equals(failType)){            // 下载failUrl时出现无法访问网络        }else if(FileDownloadStatusFailReason.TYPE_NETWORK_TIMEOUT.equals(failType)){            // 下载failUrl时出现连接超时        }else{            // 更多错误....        }        // 查看详细异常信息        Throwable failCause = failReason.getCause();// 或:failReason.getOriginalCause()        // 查看异常描述信息        String failMsg = failReason.getMessage();// 或:failReason.getOriginalCause().getMessage()    }};FileDownloader.registerDownloadStatusListener(mOnFileDownloadStatusListener);

注册文件数据变化监听器,监听比如文件不存在了,被删除了,状态变化了等任何与文件数据变化相关都会收到通知

private OnDownloadFileChangeListener mOnDownloadFileChangeListener = new OnDownloadFileChangeListener() {    @Override    public void onDownloadFileCreated(DownloadFileInfo downloadFileInfo) {        // 一个新下载文件被创建,也许你需要同步你自己的数据存储,比如在你的业务数据库中增加一条记录    }    @Override    public void onDownloadFileUpdated(DownloadFileInfo downloadFileInfo, Type type) {        // 一个下载文件被更新,也许你需要同步你自己的数据存储,比如在你的业务数据库中更新一条记录    }    @Override    public void onDownloadFileDeleted(DownloadFileInfo downloadFileInfo) {        // 一个下载文件被删除,也许你需要同步你自己的数据存储,比如在你的业务数据库中删除一条记录    }};FileDownloader.registerDownloadFileChangeListener(mOnDownloadFileChangeListener);

下载状态监听器和文件数据变化监听器的主要区别在于,前者关心下载进度和错误(前端UI),后者关心文件数据变化(数据存储)

4、下载文件和管理文件(FileDownloader API的简单使用)
创建一个新下载

FileDownloader.start(url);// 如果文件没被下载过,将创建并开启下载,否则继续下载,自动会断点续传(如果服务器无法支持断点续传将从头开始下载)

创建一个自定义保存路径和文件名称的下载

FileDownloader.detect(url, new OnDetectBigUrlFileListener() {    @Override    public void onDetectNewDownloadFile(String url, String fileName, String saveDir, long fileSize) {        // 如果有必要,可以改变文件名称fileName和下载保存的目录saveDir        FileDownloader.createAndStart(url, newFileDir, newFileName);    }    @Override    public void onDetectUrlFileExist(String url) {        // 继续下载,自动会断点续传(如果服务器无法支持断点续传将从头开始下载)        FileDownloader.start(url);    }    @Override    public void onDetectUrlFileFailed(String url, DetectBigUrlFileFailReason failReason) {        // 探测一个网络文件失败了,具体查看failReason    }});

暂停下载

FileDownloader.pause(url);// 暂停单个下载任务FileDownloader.pause(urls);// 暂停多个下载任务FileDownloader.pauseAll();// 暂停所有下载任务

继续下载

FileDownloader.start(url);// 继续下载,自动会断点续传(如果服务器无法支持断点续传将从头开始下载)

移动下载文件

FileDownloader.move(url, newDirPath, mOnMoveDownloadFileListener);// 移动单个下载文件到新文件夹中FileDownloader.move(urls, newDirPath, mOnMoveDownloadFilesListener);// 移动多个下载文件到新文件夹中

删除下载文件

FileDownloader.delete(url, true, mOnDeleteDownloadFileListener);// 删除单个下载文件FileDownloader.delete(urls, true, mOnDeleteDownloadFilesListener);// 删除多个下载文件

重命名下载文件

FileDownloader.rename(url, newName, true, mOnRenameDownloadFileListener);// 重命名一个下载文件

5、取消注册的监听器
取消注册下载状态监听器(一般在fragment或activity的onDestroy方法中取消注册)

FileDownloader.unregisterDownloadStatusListener(mOnFileDownloadStatusListener);

取消注册文件数据变化监听器

FileDownloader.unregisterDownloadFileChangeListener(mOnDownloadFileChangeListener);

service中使用FileDownLoader:

1.初始化FileDownLoader(同上)
2.让你的service实现OnRetryableFileDownloadStatusListener接口,并且在service的onCreate方法中注册当前service为FileDownloader的下载状态监听器, 并在service的onDestroy方法中取消注册当前service为FileDownloader的下载状态监听器。

public class YourService extends Service implements OnRetryableFileDownloadStatusListener {    @Override    public IBinder onBind(Intent intent) {        return null;    }    @Override    public void onCreate() {        super.onCreate();        // 将当前service注册为FileDownloader下载状态监听器        FileDownloader.registerDownloadStatusListener(this);        // 如果希望service启动就开始下载所有未完成的任务,则开启以下实现        FileDownloader.continueAll(true);    }    @Override    public void onDestroy() {        super.onDestroy();        // 将当前service取消注册为FileDownloader下载状态监听器        FileDownloader.unregisterDownloadStatusListener(this);       // 如果希望service停止就停止所有下载任务,则开启以下实现        FileDownloader.pauseAll();// 暂停所有下载任务    }    @Override    public void onFileDownloadStatusRetrying(DownloadFileInfo downloadFileInfo, int retryTimes) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusWaiting(DownloadFileInfo downloadFileInfo) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusPreparing(DownloadFileInfo downloadFileInfo) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusPrepared(DownloadFileInfo downloadFileInfo) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusDownloading(DownloadFileInfo downloadFileInfo, float downloadSpeed, long            remainingTime) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusPaused(DownloadFileInfo downloadFileInfo) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusCompleted(DownloadFileInfo downloadFileInfo) {        // 发送通知或者广播    }    @Override    public void onFileDownloadStatusFailed(String url, DownloadFileInfo downloadFileInfo, FileDownloadStatusFailReason failReason) {        // 发送通知或者广播    }}

3.在其它地方(比如应用application的onCreate方法,或者MainActivity的onCreate方法)开启service

Intent intent = new Intent(this, YourService.class);startService(intent);

4.在其它地方(比如在activity或者fragment中)使用FileDownloader下载API下载文件

FileDownloader.detect(url, new OnDetectBigUrlFileListener() {// 创建一个自定义保存路径和文件名称的下载    @Override    public void onDetectNewDownloadFile(String url, String fileName, String saveDir, long fileSize) {        // 如果有必要,可以改变文件名称fileName和下载保存的目录saveDir        FileDownloader.createAndStart(url, newFileDir, newFileName);    }    @Override    public void onDetectUrlFileExist(String url) {        // 继续下载,自动会断点续传(如果服务器无法支持断点续传将从头开始下载)        FileDownloader.start(url);    }    @Override    public void onDetectUrlFileFailed(String url, DetectBigUrlFileFailReason failReason) {        // 探测一个网络文件失败了,具体查看failReason    }});FileDownloader.start(url);// 如果文件没被下载过,将创建并开启下载,否则继续下载,自动会断点续传(如果服务器无法支持断点续传将从头开始下载)FileDownloader.pause(url);// 暂停单个下载任务FileDownloader.pause(urls);// 暂停多个下载任务FileDownloader.pauseAll();// 暂停所有下载任务

5.在service实现的OnRetryableFileDownloadStatusListener接口方法中发送通知或者广播出去

public class YourService extends Service implements OnRetryableFileDownloadStatusListener {    @Override    public void onFileDownloadStatusCompleted(DownloadFileInfo downloadFileInfo) {        // 如果有必要,发送通知或者广播    }    @Override    public void onFileDownloadStatusFailed(String url, DownloadFileInfo downloadFileInfo, FileDownloadStatusFailReason failReason) {        // 如果有必要,发送通知或者广播    }    // 省略更多方法....}

6.在其它地方(比如应用application的onTerminate方法,或者MainActivity的onDestroy方法)关闭service

Intent intent = new Intent(this, YourService.class);stopService(intent);

注意断点续传

阿里云断点续传时,header中的参数为Content-Range:bytes-0-9/44
表示整个文件长度为44,此次返回0-9。如果不符合规范,则传送整个文件,并且不在结果中提及Content-Range。返回码为206。
而FileDownLoader中,range参数为[22,44]表示上一次接收到的长度22,总长度44。通过追溯源码,添加新的自定义header参数,可以解决此问题。
另一个问题是,阿里云在range请求读取后会返回状态码为206的响应,在FileDownloader中,作者只进行了200与非200的区分。
所以在使用FileDownloader对接阿里云时注意这些问题。

阅读全文
0 0