在前端开发过程中，经常需要上传和下载文件。而对于大型文件，传统的一次性上传和下载会导致很高的服务器负载和网络带宽占用，甚至会造成阻塞。为了避免这种情况，我们可以使用分段上传和下载技术。
npm 包 multi-part 是一个基于 streaming-parser 的 Node.js 客户端，可以方便地实现分段上传和下载功能。本文将详细介绍 multi-part 的使用方法，并提供示例代码以指导读者深入学习。
安装
使用 npm 可以简单地安装 multi-part：
npm install multi-part
分段上传
下面以一个简单的上传文件的例子来介绍 multi-part 的使用。
准备工作
首先，我们需要准备一个 HTML 文件，用于上传文件。在 HTML 中，我们可以使用 FormData 构造函数创建一个包含文件内容的表单。
-- -------------------- ---- ------- --------- ----- ------ ------ ----- ---------------- ------ ----------- ----------- --------------- ------- ------------- --------------------------------- ------- -------- ----- ---- - -------------------------------------- ----- --------- - ------------------------------------- ----- ------------ - ---------------------------------------- ------------------------------- ------- -- - ----------------------- ----- -------- - --- ----------- ----------------------- -------------------- ----------------- --- ----- -------- ---------------- - -- ----- ------ ----- ---------- - --------- ------- -------
在表单提交事件中，我们创建了一个 FormData 并将上传的文件添加到其中，然后调用 upload 函数进行上传。
上传流程
multi-part 的分段上传可以分为三个主要步骤：
- 创建分段上传任务；
- 分段上传文件；
- 完成上传。
对于已经创建好的分段上传任务，我们可以使用 multiPart.startUpload() 方法来上传文件。该方法接受一个只读流（readable stream）并开始上传。在上传过程中，multi-part 会把流拆分成多个部分，每个部分大小由设置的 partSize 决定。当上传完成之后，multiPart.completeUpload() 方法会返回一个包含上传结果的对象。
-- -------------------- ---- -------
----- --------- - ----------------------
----- -- - --------------
----- --------- - --- ------------
-------- ------------------ -
----- ---------- - ----------------------------
----- -----------
----- -----------
----- ------------
---- -----------
---
------
------------ ------- -- -
------------------- ------ -------- -------
-------------------
--
----------- ------- -- -
-- ------------------------ ------- -- ----
------------------------
--
---------- -- -- -
-- ------------------------ ------- -- ----
-----------------
----- ------ - ----------------------------------------------
------------------- --------- --------
---
-
-- -----
----- ---------- - -------------------------------------
-----------------------在这个例子中，我们使用 fs.createReadStream() 创建了一个可读流，并将其作为参数传递给 uploadFile() 函数。然后，我们使用 MultiPart 类创建了一个 multiPart 实例，并使用 createUploadTask() 方法来创建一个分段上传任务。接着，我们监听可读流的 data 和 end 事件，并在 data 事件中逐段上传，最后在结束事件中完成上传。
需要注意的是，我们需要执行 uploadTask.end() 来显式告诉 multi-part 上传已经完成。如果不调用此方法，则上传任务将被终止。同时，我们还需要检查 uploadTask.isAborted() 来防止已终止的任务仍然上传。
完成上传
在上传完成之后，使用 multiPart.completeUpload() 方法获取上传结果。该方法接受一个上传任务 ID，返回一个包含上传结果的对象。上传结果包括文件的唯一标识符、文件名、文件大小、文件类型等。
分段下载
multi-part 同样支持分段下载文件。对于两者的区别，相信读者已有了一定的了解。
下面以一个简单的下载文件的例子来介绍 multi-part 的使用。
下载流程
multi-part 的分段下载可以分为三个主要步骤：
- 创建分段下载任务；
- 分段下载文件；
- 完成下载。
对于已经创建好的分段下载任务，我们可以使用 multiPart.startDownload() 方法来下载文件。该方法会生成一个只写流（writeable stream），并通过多个分段下载，逐步将文件写入流中。在下载完成之后，multiPart.completeDownload() 方法会返回一个包含下载结果的对象。
-- -------------------- ---- -------
----- --------- - ----------------------
----- -- - --------------
----- --------- - --- ------------
----- -------- -------------------- -
----- ------------ - ------------------------------
-------
--------- ---- - -----
---
----- ----------- - -------------------------------------------------
------------
------------ ------- -- -
----------------------- -------- -------
---------------------- -- ---
--
----------- ------- -- -
------------------------- -- ----
--
---------- -- -- -
------------------
----- ------ - ----------------------------------------------------
--------------------- --------- --------
---
---------------------
-
-- -----
-----------------------------------在这个例子中，我们使用 createDownloadTask() 方法创建了一个分段下载任务。接着，我们创建了一个只写流，并在下载任务中监听 data 和 end 事件，并将下载到的数据写入文件中。在下载结束后，我们执行 writeStream.end() 来结束写入流，并使用 multiPart.completeDownload() 方法获取下载结果。
总结
通过本文，我们详细介绍了 npm 包 multi-part 的使用方法。它基于 Node.js 客户端，可以方便地实现分段上传和下载功能。在分段上传和下载中，我们需要先创建上传或下载任务，然后分段传输数据，最后完成任务。本文提供了完整的示例代码，让读者可以在实际项目中方便地使用该包。
有关 multi-part 更多的用法和参数请参考官方文档：MultiPart API。
参考资料
- multi-part npm 包
- streaming-parser GitHub 仓库
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/68579