多文件下载监听在应用开发中是一个非常常见的需求。本示例将介绍如何使用request上传下载模块实现多文件下载监听,如监听每个文件下载任务的进度,任务暂停,下载完成等下载情况。每个应用最多支持创建10个未完成的任务,相关规格说明请参考request.agent.create。
使用说明
配置下载参数。一个下载任务需要配置对应一套下载参数request.agent.Config。本例中使用downloadConfig方法简单配置了下载文件的url,实际业务中请按实际情况按需配置。源码参考MultipleFilesDownload.ets。
let config: request.agent.Config = {
action: request.agent.Action.DOWNLOAD, // 配置任务选项,这里配置为下载任务
url: downloadUrl, // 配置下载任务url
overwrite: true, // 下载过程中路径已存在时的解决方案选择。true表示覆盖已存在的文件
method: 'GET', // HTTP标准方法。下载时,使用GET或POST。
saveas: './', // 这里'./'表示下载至应用当前缓存路径下。
mode: request.agent.Mode.BACKGROUND, // 任务模式设置后台任务。
gauge: true // 后台任务的过程进度通知策略,仅应用于后台任务。true表示发出每个进度已完成或失败的通知。
};
创建多个文件下载监听实例。单个文件下载监听只需要配置下载参数,创建下载任务,注册下载任务相关监听,启动下载任务即可实现。而要实现多文件下载监听,需要每个下载任务注册独立的下载监听回调。本例通过封装自定义组件FileDownloadItem,在每个FileDownloadItem中创建各自的下载任务和监听回调,从而实现多文件下载监听。源码参考MultipleFilesDownload.ets。
ForEach(this.downloadConfigArray, (item: request.agent.Config) => {
ListItem() {
// 创建文件下载监听实例
FileDownloadItem({
downloadConfig: item, // 文件下载配置
isStartAllDownload: this.isStartAllDownload, // 是否全部开始下载
downloadCount: this.downloadCount // 待下载任务数量
downloadFailCount: this.downloadFailCount // 下载失败任务数量
})
}
}, (item: request.agent.Config) => JSON.stringify(item))
创建下载任务,并注册下载任务相关监听。本例在每个FileDownloadItem中使用request.agent.create创建下载任务。然后在下载任务创建成功后,注册各自下载任务相关监听。本例中注册了下载任务完成回调,下载任务失败回调,下载进度更新回调,暂停任务回调,重新启动任务回调。源码参考FileDownloadItem.ets。
request.agent.create(context, this.downloadConfig).then((task: request.agent.Task) => {
// 注册下载任务相关回调
task.on('completed', this.completedCallback); // 下载任务完成回调
task.on('failed', this.failedCallback); // 下载任务失败回调
task.on('pause', this.pauseCallback); // 暂停任务回调
task.on('resume', this.resumeCallback); // 重新启动任务回调
task.on('progress', this.progressCallback); // 下载进度更新回调
}).catch((err: BusinessError) => {
logger.error(TAG, `Failed to task create with error message: ${err.message}, error code: ${err.code}`);
});
启动下载任务。本例在每个FileDownloadItem中使用task.start方法启动各自的下载任务。源码参考FileDownloadItem.ets。
task.start((err: BusinessError) => {
if (err) {
logger.error(TAG, `Failed to task start with error message: ${err.message}, error code: ${err.code}`);
return;
}
this.downloadTask = task;
})
本示例中注册了progress下载进度更新监听,不建议在下载进度更新回调中加日志打印,以减少不必要的性能损耗。
无网络时,点击”全部开始“,下载队列中的任务状态却显示”已暂停“。
答:request.agent.Config有一个参数retry默认是true,如果没有网络或者网络不满足时,会自动暂停waiting,所以在没网络的时候下载底层逻辑会走暂停回调,应用侧在暂停回调里设置了显示当前下载状态,所以无网络时,点击”全部开始“,下载队列中的任务状态显示”已暂停“。目前本例中已经把retry设置为false,没网络时,开启下载任务会直接走入失败回调,直接显示”下载失败“。
multiplefilesdownload // har类型
|---view
| |---MultipleFilesDownload.ets // 视图层-文件下载页面
| |---FileDownloadItem.ets // 视图层-单个文件下载组件
本示例依赖common模块来实现日志的打印、动态路由模块来实现页面的动态加载。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。