鸿蒙HarmonyOS 5.0开发实战：多文件下载监听实现案例

 往期鸿蒙5.0全套实战文章必看：（文中附带鸿蒙5.0全栈学习资料）

• 鸿蒙开发核心知识点，看这篇文章就够了
  
• 最新版！鸿蒙HarmonyOS Next应用开发实战学习路线
  
• 鸿蒙HarmonyOS NEXT开发技能最全学习路线指南
  
• 鸿蒙应用开发实战项目，看这一篇文章就够了（部分项目附源码）
  

---

多文件下载监听案例

介绍

多文件下载监听在应用开发中是一个非常常见的需求。本示例将介绍怎样使用request上传下载模块实现多文件下载监听，如监听每个文件下载任务的进度，任务暂停，下载完成等下载情况。下载汗青页面展示的是下载完成的文件，可对页面中已删除的文件进行重新下载 。
效果图预览

使用说明

• 毗连网络。进入页面，点击“全部开始”，启动所有文件的下载任务。点击“全部暂停”，暂停所有文件下载任务。再次点击“全部开始”,可重新启动未完成的下载任务。如出现下载失败，一般是网络不稳定，点击“全部开始”即可重新下载。
  
• 下载完成的文件会生存在应用缓存路径下,出现在下载汗青页面中。
  
• 可点击删除按钮，在应用缓存路径下删除该文件存储的数据。
  
• 点击文件，若文件中在应用缓存路径下存在，弹窗提示用户“文件已存在”；否则弹窗提示用户“文件不存在，是否重新下载？”，点击确认按钮，该条文件数据会出现在下载列表中，可点击“全部开始“按钮重新下载。
  

实现思路

• 配置下载参数。一个下载任务需要配置对应一套下载参数request.agent.Config。本例中使用downloadConfig方法简单配置了下载文件的url，实际业务中请按实际情况按需配置。
  
  1. let config: request.agent.Config = {
  2.   action: request.agent.Action.DOWNLOAD, // 配置任务选项，这里配置为下载任务
  3.   url: downloadUrl, // 配置下载任务url
  4.   overwrite: true, // 下载过程中路径已存在时的解决方案选择。true表示覆盖已存在的文件
  5.   method: 'GET', // HTTP标准方法。下载时，使用GET或POST。
  6.   saveas: './', // 这里'./'表示下载至应用当前缓存路径下。
  7.   mode: request.agent.Mode.BACKGROUND, // 任务模式设置后台任务。
  8.   gauge: true // 后台任务的过程进度通知策略，仅应用于后台任务。true表示发出每个进度已完成或失败的通知。
  9. };

  复制代码
• 创建多个文件下载监听实例。单个文件下载监听只需要配置下载参数，创建下载任务，注册下载任务相干监听，启动下载任务即可实现。而要实现多文件下载监听，需要每个下载任务注册独立的下载监听回调。本例通过封装自定义组件FileDownloadItem，在每个FileDownloadItem中创建各自的下载任务和监听回调，从而实现多文件下载监听。
  
  1. ForEach(this.downloadConfigArray, (item: request.agent.Config) => {
  2.   ListItem() {
  3.     // 创建文件下载监听实例
  4.     FileDownloadItem({
  5.       downloadConfig: item, // 文件下载配置
  6.       isStartAllDownload: this.isStartAllDownload, // 是否全部开始下载
  7.       downloadCount: this.downloadCount // 待下载任务数量
  8.       downloadFailCount: this.downloadFailCount // 下载失败任务数量
  9.     })
  10.   }
  11. }, (item: request.agent.Config) => JSON.stringify(item))

  复制代码
• 创建下载任务，并注册下载任务相干监听。本例在每个FileDownloadItem中使用request.agent.create创建下载任务。然后在下载任务创建成功后，注册各自下载任务相干监听。本例中注册了下载任务完成回调，下载任务失败回调，下载进度更新回调，暂停任务回调，重新启动任务回调。
  
  1. request.agent.create(context, this.downloadConfig).then((task: request.agent.Task) => {
  2.   // 注册下载任务相关回调
  3.   task.on('completed', this.completedCallback); // 下载任务完成回调
  4.   task.on('failed', this.failedCallback); // 下载任务失败回调
  5.   task.on('pause', this.pauseCallback); // 暂停任务回调
  6.   task.on('resume', this.resumeCallback); // 重新启动任务回调
  7.   task.on('progress', this.progressCallback); // 下载进度更新回调
  8. }).catch((err: BusinessError) => {
  9.   logger.error(TAG, `Failed to task create with error message: ${err.message}, error code: ${err.code}`);
  10. });

  复制代码
• 启动下载任务。本例在每个FileDownloadItem中使用task.start方法启动各自的下载任务。
  
  1. task.start((err: BusinessError) => {
  2.   if (err) {
  3.     logger.error(TAG, `Failed to task start with error message: ${err.message}, error code: ${err.code}`);
  4.     return;
  5.   }
  6.   this.downloadTask = task;
  7. })

  复制代码
• 删除文件。使用fs.unlink删除该条数据应用文件路径
  
  1. // TODO：知识点：删除该条数据应用文件路径
  2. fs.unlink(filePath).then(() => {
  3.    // 文件状态变为已删除
  4.    this.FileInfo.fileStatus = 3;
  5.    promptAction.showToast({
  6.       message: $r('app.string.multiple_files_download_history_toast_text_del'),
  7.       duration: 2000,
  8.       bottom: '50%',
  9.    })
  10. }).catch((error: BusinessError) => {
  11.    logger.error("remove file failed with error:" + error);
  12. });

  复制代码
• 重新下载已删除的文件。使用fs.access判断文件是否已经存在，若不存在弹窗提示用户是否重新下载。
  
  1. // 获取应用文件路径
  2. const cacheDir = context.cacheDir;
  3. const FilePath: string = `${cacheDir}/${this.fileName}`;
  5. // TODO：知识点：使用fs.access判断目录是否已经存在。
  6. fs.access(FilePath).then((res: boolean) => {
  7.   if (!res) {
  8.     // 文件已删除，弹窗提示是否重新下载
  9.     AlertDialog.show({
  10.       message: `${this.fileName}文件不存在,是否重新下载？`,
  11.       alignment: DialogAlignment.Center, // 弹窗在竖直方向上的对齐方式。
  12.       autoCancel: false, // 点击遮罩层时，是否关闭弹窗。默认值：true
  13.       primaryButton: {
  14.         value: $r('app.string.multiple_files_download_history_button_text_cancel'),
  15.         fontColor: $r('app.color.multiple_files_download_text_color'),
  16.         action: () => {
  17.           logger.info('已取消');
  18.         }
  19.       },
  20.       secondaryButton: {
  21.         value: $r('app.string.multiple_files_download_history_button_text_confirm'),
  22.         fontColor: $r('app.color.multiple_files_download_del_bgc'),
  23.         action: () => {
  24.           // 更改该条数据下载状态
  25.           this.FileInfo.fileStatus = 0;
  26.           // 该条数据加入下载列表数组中
  27.           this.downloadFileArray.push(this.FileInfo);
  28.           // 下载历史列表删除该条数据
  29.           this.historyArray = this.historyArray.filter( ( item: downloadFilesData ) => {
  30.             return item.id !== this.FileInfo.id;
  31.           });
  32.           // 更新待下载任务数量
  33.           this.downloadCount = this.downloadFileArray.length;
  34.         }
  35.       },
  36.       cornerRadius: $r('app.integer.multiple_files_download_borderRadius_twelve'), // 弹窗边框弧度
  37.       width: $r('app.string.multiple_files_download_list_height'), // 弹窗宽度
  38.       cancel: () => {
  39.         logger.info('点击关闭按钮');
  40.       }
  41.     });
  42.   } else {
  43.     // 文件已下载到本地，弹窗提示文件已存在
  44.     promptAction.showToast({
  45.       message: $r('app.string.multiple_files_download_history_toast_text_exist'),
  46.       duration: 1000,
  47.       bottom: '50%',
  48.     })
  49.   }

  复制代码

高性能知识点

本示例中注册了progress下载进度更新监听，不发起在下载进度更新回调中加日志打印，以淘汰不必要的性能损耗。
FAQ

• 无网络时，点击”全部开始“，下载队列中的任务状态却表现”已暂停“。
  答：request.agent.Config有一个参数retry默认是true，如果没有网络大概网络不满足时，会主动暂停waiting，所以在没网络的时候下载底层逻辑会走暂停回调，应用侧在暂停回调里设置了表现当前下载状态，所以无网络时，点击”全部开始“，下载队列中的任务状态表现”已暂停“。目前本例中已经把retry设置为false，没网络时，开启下载任务会直接走入失败回调，直接表现”下载失败“。
  

工程布局&模块类型

1. multiplefilesdownload                               // har类型
2. |---view
3. |   |---MultipleFilesDownload.ets                   // 视图层-文件下载页面
4. |   |---FileDownloadItem.ets                        // 视图层-单个文件下载组件
5. |   |---HistoryItem.ets                             // 视图层-单个文件历史组件

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。