1# 文件上传下载性能提升指导 2 3## 概述 4 5在开发应用时，要实现高效的客户端跟服务器之间数据交换，文件传输的性能是至关重要的。一个数据交换性能较低的应用会导致其在加载过程中耗费较长时间，在很多的场景造成页面卡顿，极大的影响了用户体验。相反，一个数据交换高效的应用，则会让应用变得更加流畅。 6 7本文将介绍两种常见的上传下载传输和网络请求的关键技术：数据压缩和断点续传，可提升上传下载的性能、减少宽带占用，从而提高数据传输效率。 8 9## 上传下载接口 10 11目前系统内提供给文件上传下载可用的模块有[@ohos.net.http](../reference/apis-network-kit/js-apis-http.md)模块和[@ohos.request](../reference/apis-basic-services-kit/js-apis-request.md)模块。[@ohos.net.http](../reference/apis-network-kit/js-apis-http.md)模块提供基础的HTTP数据请求能力，功能较为基础，本文不做介绍。[@ohos.request](../reference/apis-basic-services-kit/js-apis-request.md)模块主要给应用提供上传下载文件、后台传输代理的基础能力。它具备任务管理系统的默认并发功能，简化下载功能的实现和管理，提升数据传输的安全，整合通知机 制，新增任务状态与进度查询功能，具有灵活性、高效性、可扩展性、可靠性、一致性和安全性的优势。 12 13具体来说，[@ohos.request](../reference/apis-basic-services-kit/js-apis-request.md)模块包括以下功能： 14 151. 任务管理：任务管理操作包括创建任务、暂停任务、恢复任务、删除任务、文件上传、文件下载、系统通知等。创建的任务分为前端任务和后台任务。前端任务是立即的、模态界面的、同步的，跟随应用的生命周期，通常数据量较小、耗时短，例如发布微信朋友圈、微博，通常优先级高且倾斜带宽资源。后台任务为可等待的、任意界面的、异步的，通常数据量较大、耗时长，例如缓存一部电影、同步数百兆字节乃至若干吉字节的数据，优先级相较于前端任务低且与应用生命周期无关。 16 172. 任务查询管理：系统查询所有任务、过滤上传任务、过滤下载任务、过滤时间段内任务、过滤前端任务、过滤后台任务、用户查询指定任务信息、用户查询指定隐藏任务信息、系统查询指定任务信息、系统清理指定任务等。 18 193. 任务自动恢复：网络条件不满足时任务不启动或者暂停，满足后自动启动或者恢复（需要HTTP服务器支持断点续传）。 20 214. 安全隐私保护：包括网络权限检查、普通接口仅操作自己创建的任务、任务信息加密存储、系统接口检查、系统接口查询隐匿任务敏感字段、普通接口查询隐匿任务敏感字段、遍历攻击、DOS、僵尸任务、恶意的静默后台任务、系统管理接口权限等。 22 235. 日志：包括调试模式和发布模式。调试模式可打印所有内存修改、磁盘、网络读写、逻辑分支等日志。发布模式下除了导致任务失败、服务异常的日志，其余日志都会关闭。 24 256. 任务失败重试：对于不可恢复的原因，直接失败；对于可恢复的原因，网络断开、网络类型不匹配等，不现场重试，任务到等待网络恢复队列；网络超时则就地重试1次，仍网络超时，则立即失败。 26 277. 服务按需启停：上传下载服务不随系统自启。应用主动调用任意接口，上传下载服务自动启动。网络连接事件会触发上传下载服务启动。在任务队列中，没有正在处理的任务，或者等待网络恢复的任务，延迟10秒钟，再check一次，仍旧没有的，则通知系统服务框架（SAMGR）可以停止并卸载上传下载服务。在服务退出过程中，新的接口请求可能失败，在客户端检查服务状态、通过重试按需启动。 28 298. 通知：任务从第一次开始到最终结束都应该有进度通知。目前采用固定时间间隔触发进度通知，前台任务1秒，后台任务3秒。任务状态的每次变化也要触发进度通知。当任务完成和失败，则触发其专用的进度通知。提供了抑制开关，可以在创建任务时打开，以避免频繁通知。 30 31 32### 下载任务的状态迁移流程 33 34使用[@ohos.request](../reference/apis-basic-services-kit/js-apis-request.md)模块执行下载的任务，具有四种运行状态：初始任务、就绪任务、挂起任务、待网任务、成功任务、失败任务。可以通过create创建任务，start开始任务，pause挂起任务，resume恢复任务，remove移除任务，stop停止任务，任务结果有final-failed任务失败，final-completed下载完成，recoverable-failed重试失败，并支持查询任务状态，具体流程如图一所示： 35 36**图一 模块流程图** 37 38 39 40## 常见场景与方案 41 42**场景1：低带宽网络上传琐碎文件场景** 43 44在网络连接较差，低带宽的网络环境中，HTTP连接的建立耗时可能会大幅提升。这时候进行[数据压缩](#数据压缩)可以加快页面加载速度，并减少HTTP请求数量和移动数据流量。 45 46**场景2：处理大量资源的场景** 47 48如应用商店、网盘应用等，这类应用通常拥有大体积的文件资源。当用户从暂停或者断网中重新恢复时，如果从头开始上传下载则会额外耗费大量的时间。此时可以采用[断点续传](#断点续传)方法进行上传下载。 49 50### 数据压缩 51 52数据压缩是指在应用中对数据进行压缩，以减少存储空间和数据传输量、节省带宽，提高加载速度。数据压缩通常在网络传输和存储方面发挥着重要作用，特别是在处理大量数据或需要频繁传输数据的场景下。 53 54在应用开发中，常见的数据压缩技术分类如下： 55 56- 有损压缩：仅限图片视频音频等文件适用。通过减少图片视频文件的分辨率，降低音频的音质等手段，以减少文件的大小，来实现减少加载时间和带宽消耗。 57- 无损压缩：对一些零碎文件可以使用 [@ohos.zlib（Zip模块）](../reference/apis-basic-services-kit/js-apis-zlib.md)来进行打包压缩，减少上传请求次数；对一些大文件可以利用缓存技术，服务器将曾经上传过的大文件MD5码缓存起来，本地在上传前预生成MD5码并传输到服务器进行比对，如果相同则说明服务器存在该文件，可以跳过该文件上传，从而省略重复传输时间。 58 59 60以从相册批量上传图片为例，介绍大量文件打包无损压缩上传相关技术，下图为相关示例的界面截图： 61 62**图二 相册批量上传图片示例图** 63 64 65 66以批量上传照片（分辨率为480\*640，24位，平均大小50\~120KB）为例，在RK设备上测试的结果如下表所示： 67 68| 上传照片数量 | 优化前耗时（ms） | 优化后耗时（ms） | 69| --- | --- | ---| 70| 10 | 470 | 526 | 71| 20 | 1124 | 1091 | 72| ... | ... | ... | 73| 50 | 2379 | 2138 | 74| 80 | 3950 | 3258 | 75| ... | ... | ... | 76| 100 | 5276 | 3909 | 77 78**图三 上传数量和耗时对比图表** 79 80 81 82由于上传耗时收到网络状态影响偏差较大，结果取的几次测量结果的最小值。但是仍然可以从数据中看出，优化前的耗时基本为线性增长，压缩优化后的耗时在上传文件数量较低时并不明显，还会因为多余的压缩处理影响耗时。不过随着上传的照片数量增多，优化后的耗时和优化之前的耗时差距越来越明显，优化效果越好。 83 84**数据压缩的相关示例代码如下：** 85 861. 导入相关模块： 87 88```ts 89import common from '@ohos.app.ability.common'; 90import fs from '@ohos.file.fs'; 91import zlib from '@ohos.zlib'; 92``` 932. 创建压缩上传相关类： 94 95```ts 96class ZipUpload { 97 // 创建任务前存放的uri 98 private waitList: Array<string> = []; 99 // 需要上传的文件uri 100 private fileUris: Array<string> = []; 101 // ... 102} 103``` 1043. 建立用于接收图库图片的临时文件夹，并将整个临时文件夹打包添加到待上传list内： 105 106```ts 107// 文件压缩处理 108async zipUploadFiles(fileUris: Array<string>): Promise<void> { 109 this.context = getContext(this) as common.UIAbilityContext; 110 let cacheDir = this.context.cacheDir; 111 let tempDir = fs.mkdtempSync(`${cacheDir}/XXXXXX`); 112 // 将图库图片获取的uri放入fileUris中，遍历复制到临时文件夹 113 for (let i = 0; i < fileUris.length; i++) { 114 let fileName = fileUris[i].split('/').pop(); 115 let resourceFile: fs.File = fs.openSync(fileUris[i], fs.OpenMode.READ_ONLY); 116 fs.copyFileSync(resourceFile.fd, `${tempDir}/${fileName}`, 0); 117 fs.closeSync(resourceFile); 118 } 119 // 文件压缩，将之前生成的临时文件夹内打包到test.zip内 120 let options: zlib.Options = { 121 level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION, 122 memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT, 123 strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY 124 }; 125 let data = await zlib.compressFile(tempDir, `${cacheDir}/test.zip`, options); 126 // 删除临时文件夹 127 fs.rmdirSync(tempDir); 128 // 将生成的zip包放到传输队列 129 this.waitList.push(`${cacheDir}/test.zip`); 130} 131``` 132### 断点续传 133 134断点续传功能的实现，不管是应用端还是服务器端都需要用到合理的技术来互相协同。在实际开发中，开发者无需亲自实现断点续传功能，只需对SDK进行合理配置。 135 136在应用端需要用到的技术和API： 137 138- [@ohos.file.fs（文件管理）](../reference/apis-core-file-kit/js-apis-file-fs.md)：用于处理文件上传操作，提供了读取文件内容，文件分片和组合的功能。 139- [@ohos.file.hash（文件哈希处理）](../reference/apis-core-file-kit/js-apis-file-hash.md)：用于实现文件MD5的计算，将计算的MD5值预先传到服务器端进行预处理，实现文件秒传，同时确保传输的准确性和可靠性。 140- [@ohos.request（上传下载）](../reference/apis-basic-services-kit/js-apis-request.md)：用于实现文件上传操作，并支持在上传过程中的断点续传功能。 141 142 143在服务器端需要用到的技术： 144 145- 协议需要支持Range：用于在服务器端支持范围请求，方便处理文件上传下载断点续传功能。 146- 文件校验相关逻辑：需要实现校验文件是否有错，确保在传输中断后能够准确恢复并继续传输。 147 148 149通过结合应用端和服务器端的相关技术，可以共同实现高效且可靠的文件断点续传功能，提供更好的用户体验并确保数据传输的稳定性。 150 151本文基于[上传和下载](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Connectivity/UploadAndDownLoad)中的后台上传场景，给出了部分断点续传的示例代码，具体可以参考该工程。 152 153#### 文件上传 154 155对于大文件断点续传上传，本文采用[@ohos.request（上传下载）](../reference/apis-basic-services-kit/js-apis-request.md)模块中的**request.agent**任务托管接口，可以自动实现暂停继续重试等操作，无需手动将文件分片和记录上传分片信息。流程图如图四所示： 156 157**图四 断点续传上传流程图** 158 159 160 161 **断点续传上传示例代码如下：** 162 163具体可以参考[RequestUpload.ets](https://gitee.com/openharmony/applications_app_samples/blob/master/code/BasicFeature/Connectivity/UploadAndDownLoad/features/uploadanddownload/src/main/ets/upload/RequestUpload.ets) 164 1651. 导入相关模块： 166```ts 167import common from '@ohos.app.ability.common'; 168import request from '@ohos.request'; 169``` 170 1712. 创建相关上传类： 172```ts 173class Upload { 174 // 后台任务 175 private backgroundTask: request.agent.Task | undefined = undefined; 176 // 创建任务前存放的uri 177 private waitList: Array<string> = []; 178 // ... 179} 180``` 1813. 生成MD5码，上传到服务器进行校验： 182```ts 183async checkFileExist(fileUri: string): Promise<boolean> { 184 let httpRequest = http.createHttp(); 185 // 生成md5码 186 let md5 = await hash.hash(fileUri, 'md5'); 187 let requestOption: http.HttpRequestOptions = { 188 method: http.RequestMethod.POST, 189 extraData: { 190 'MD5': md5 191 } 192 } 193 let response = await httpRequest.request('http://XXX.XXX.XXX.XXX/XXXX', requestOption); 194 let result = response.result; 195 let flag = false; 196 // ... 197 // 根据服务器返回对应数据判断是否存在 198 if (flag) { 199 return true; 200 } else { 201 return false; 202 } 203} 204``` 2054. 配置Config，创建后台上传任务： 206```ts 207private config: request.agent.Config = { 208 action: request.agent.Action.UPLOAD, 209 headers: HEADER, 210 url: '', 211 mode: request.agent.Mode.BACKGROUND, 212 method: 'POST', 213 title: 'upload', 214 network: request.agent.Network.ANY, 215 data: [], 216 token: 'UPLOAD_TOKEN' 217} 218// ... 219// 转换uri 220private async getFilesAndData(cacheDir: string, fileUris: Array<string>): Promise<Array<request.agent.FormItem>> { 221// ... 222} 223// 创建文件上传后台任务 224async createBackgroundTask(fileUris: Array<string>) { 225 // 获取上传url 226 this.config.url = 'http://XXX.XXX.XXX.XXX'; 227 this.config.mode = request.agent.Mode.BACKGROUND; 228 let tempData = await this.getFilesAndData(this.context.cacheDir, fileUris); 229 // 判断每个文件是否为空 230 for (let i = 0; i < tempData.length; i++) { 231 let flag = await this.checkFileExist(`${this.context.cacheDir}/${tempData[i].name}`); 232 if (!flag) { 233 this.config.data.push(tempData[i]) 234 } 235 } 236 let isFileExist = await this.checkFileExist(`${this.context.cacheDir}/${this.config.data[0].name}`); 237 if (this.config.data.length === 0) { 238 return; 239 } 240 this.backgroundTask = await request.agent.create(this.context, this.config); 241} 242``` 2435. 任务开始： 244```ts 245await this.backgroundTask.start(); 246``` 2476. 任务暂停： 248```ts 249async pause() { 250 if (this.backgroundTask === undefined) { 251 return; 252 } 253 await this.backgroundTask.pause(); 254} 255``` 2567. 任务继续： 257```ts 258async resume() { 259 if (this.backgroundTask === undefined) { 260 return; 261 } 262 await this.backgroundTask.resume(); 263} 264``` 265#### 文件下载 266 267对于大文件断点续传下载，也可以直接调用**request.agent**接口，该接口的断点续传是基于HTTP协议Header里的Range字段实现的，在任务暂停重启的时候，会自动设置Header中的Range字段，无需进行额外的配置。 268 269> **Range简介** 270> 271> HTTP协议里面的Range字段，官方名称为范围请求，它允许服务器只发送 HTTP 272> 消息的一部分到客户端，可以用来请求部分数据而不是整个资源。 273> 274> Range的格式通常是Range: 275> `<unit>=<start>-<end>`，其中`<unit>`表示范围所采用的单位，通常是字节（bytes），`<start>` 和 `<end>` 表示请求的起始字节和结束字节的位置。 276> 277> Range语法如下： 278> ```ts 279> // 表示从range-start到文件末尾 280> Range: <unit>=<range-start>- 281> // 表示从range-start到range-end 282> Range: <unit>=<range-start>-<range-end> 283> // 可以同时选择多段，用逗号分隔 284> Range: <unit>=<range-start>-<range-end>, <range-start>-<range-end> 285> 286> // 示例：表示返回1024btyes之后的文件 287> Range: bytes=1024- 288> ``` 289> 服务器收到请求后，正确处理请求会回复206 Partial 290> Content，未正常处理则会回复其他响应码。下表是服务器回复的常见响应码： 291> 292> | 服务器响应码 | 常见的原因 | 293> | ------------------ | -----------------| 294> | 206 Partial Content | 服务器收到正常Range请求的响应码，返回部分内容的响应。| 295> | 416 Range Not Satisfiable | 所请求的范围不合法，表示服务器错误。| 296> |200 OK | 服务器忽略了 Range 首部，返回整个文件。| 297> 298 299**断点续传下载示例代码如下：** 300 301具体可以参考[RequestDownload.ets](https://gitee.com/openharmony/applications_app_samples/blob/master/code/BasicFeature/Connectivity/UploadAndDownLoad/features/uploadanddownload/src/main/ets/download/RequestDownload.ets) 302 3031. 导入模块： 304```ts 305import common from '@ohos.app.ability.common'; 306import request from '@ohos.request'; 307``` 3082. 创建下载类： 309```ts 310class Download { 311 // 任务存放前的uri 312 private waitList: Array<string[]> = []; 313 // 下载任务 314 private downloadTask: request.agent.Task | undefined = undefined; 315 // 后台任务下载列表 316 private backgroundDownloadTaskList: Array<request.agent.Task> = []; 317 // ... 318} 319``` 3203. 配置Config，创建后台下载任务： 321```ts 322async createBackgroundTask(downloadList: Array<string[]>) { 323 let splitUrl = url.split('//')[1].split('/'); 324 let context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext; 325 let downloadConfig: request.agent.Config = { 326 action: request.agent.Action.DOWNLOAD, 327 url: url, 328 method: 'POST', 329 title: 'download', 330 mode: request.agent.Mode.FOREGROUND, // 必须是后台任务才能续传 331 network: request.agent.Network.ANY, 332 saveas: `./${folder}/${splitUrl[splitUrl.length-1]}`, 333 overwrite: true 334 } 335 this.downloadTask = await request.agent.create(context, downloadConfig); 336 if (this.backgroundDownloadTaskList.findIndex(task => task.config.url === downTask.config.url) === -1) { 337 this.backgroundDownloadTaskList.push(downTask); 338 } 339} 340``` 3414. 任务开始： 342```ts 343await downTask.start(); 344``` 3455. 任务暂停： 346```ts 347async pause() { 348 if (this.backgroundDownloadTaskList.length === 0) { 349 return; 350 } 351 this.backgroundDownloadTaskList.forEach(async task => { 352 await task.pause(); 353 }) 354} 355``` 3566. 任务继续： 357```ts 358async resume() { 359 if (this.backgroundDownloadTaskList.length === 0) { 360 return; 361 } 362 this.backgroundDownloadTaskList.forEach(async task => { 363 await task.resume(); 364 }) 365} 366``` 3677. 任务停止： 368```ts 369async deleteAllBackTasks() { 370 if (this.backgroundDownloadTaskList.length > 0) { 371 this.backgroundDownloadTaskList.forEach(async task => { 372 await request.agent.remove(task.tid); 373 }) 374 this.backgroundDownloadTaskList = []; 375 } 376} 377``` 378 379## 相关实例 380 381针对断点续传，有以下相关实例可以参考： 382 383- [上传和下载](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Connectivity/UploadAndDownLoad)
