NodeJS流:Pipeline优雅结束方法
时间:2025-08-02 08:39:28 465浏览 收藏
今天golang学习网给大家带来了《NodeJS流:Pipeline中优雅结束读取流》,其中涉及到的知识点包括等等,无论你是小白还是老手,都适合看一看哦~有好的建议也欢迎大家在评论留言,若是看完有所收获,也希望大家能多多点赞支持呀!一起加油学习~
本文探讨了在使用 NodeJS Streams 的 pipeline 处理大型文件时,如何在满足特定条件后提前结束读取流,同时确保已读取的数据块能够完成处理。文章提供了两种解决方案:一种是在转换流中“吞噬”后续数据,另一种是利用 AbortController 中止 pipeline,并详细讲解了实现方法和注意事项,旨在帮助开发者更有效地处理流数据。
在使用 NodeJS streams 的 pipeline 处理大型文件时,有时需要在特定条件满足时提前结束读取流,但同时又希望已读取的数据块能够继续完成处理。直接销毁读取流可能会导致 ERR_STREAM_PREMATURE_CLOSE 错误,并且不够优雅。本文将介绍两种更佳的解决方案,帮助你安全且高效地实现这一需求。
方案一:在转换流中“吞噬”后续数据
这种方法的核心思想是在检测到需要停止读取的条件后,让转换流“吞噬”后续的所有数据,使其不再向下传递。这样,读取流会一直读取到文件末尾,但下游的流只处理到满足停止条件之前的数据。
以下是示例代码:
const { Transform } = require("node:stream"); const { pipeline } = require("node:stream/promises"); const fs = require("node:fs"); let shouldStop = false; const firstStream = fs.createReadStream("./lg.txt"); const secondStream = new Transform({ transform(chunk, encoding, callback) { if (shouldStop) { // 吞噬剩余数据 callback(null, ""); } else { const text = chunk.toString(); const foundText = text.search("CHAPTER 9") !== -1; if (foundText) { // 设置标志位,吞噬剩余数据 shouldStop = true; } callback(null, text.toUpperCase()); } }, }); const lastStream = process.stdout; pipeline(firstStream, secondStream, lastStream) .then(() => console.log("Pipeline completed successfully.")) .catch(err => console.error("Pipeline failed.", err));
代码解释:
- shouldStop 变量用于标记是否需要停止处理数据。
- 在 secondStream 的 transform 函数中,如果 shouldStop 为 true,则直接调用 callback(null, ""),表示吞噬当前数据块,不向下传递。
- 如果 shouldStop 为 false,则检查当前数据块中是否包含目标文本。如果包含,则设置 shouldStop 为 true,并对数据进行转换后向下传递。
优点:
- 逻辑简单,易于理解和实现。
- 不需要中断 pipeline,避免了潜在的错误。
缺点:
- 读取流会一直读取到文件末尾,可能会浪费一些资源。
方案二:使用 AbortController 中止 Pipeline
AbortController 提供了一种更优雅的方式来中止 pipeline,并且可以进行清理工作。通过 AbortController,可以向 pipeline 发送一个中止信号,pipeline 会在完成当前数据块的处理后停止。
以下是示例代码:
const { Transform } = require("node:stream"); const { pipeline } = require("node:stream/promises"); const fs = require("node:fs"); const firstStream = fs.createReadStream("./lg.txt"); const ac = new AbortController(); const signal = ac.signal; const secondStream = new Transform({ transform(chunk, encoding, callback) { const text = chunk.toString(); const foundText = text.search("CHAPTER 9") !== -1; callback(null, text.toUpperCase()); if (foundText) { ac.abort(new Error("reading terminated, match found")); } }, }); const lastStream = process.stdout; pipeline(firstStream, secondStream, lastStream, { signal }).then(() => { console.log("\nall done without match"); }).catch((err) => { if (err.code === "ABORT_ERR") { console.log(`\n${signal.reason.message}`); } else { console.log(err); } });
代码解释:
- 创建 AbortController 实例 ac,并获取其 signal 属性。
- 在 secondStream 的 transform 函数中,如果检测到目标文本,则调用 ac.abort(new Error("reading terminated, match found")),发送中止信号。
- 在调用 pipeline 函数时,将 signal 作为选项传递。
- 使用 try...catch 捕获 pipeline 函数可能抛出的错误。如果错误代码为 ABORT_ERR,则表示 pipeline 被中止,可以获取中止原因。
优点:
- 更优雅地中止 pipeline,可以进行清理工作。
- 可以获取中止原因,方便调试。
缺点:
- 代码相对复杂一些。
注意事项:
- 跨 Chunk 边界问题: 在搜索目标文本时,需要注意目标文本可能跨越 chunk 边界的情况。为了避免漏检,可以保留每个 chunk 的最后 N-1 个字符,并将其添加到下一个 chunk 的开头,其中 N 为目标文本的长度。
- 错误处理: 在使用 pipeline 函数时,需要注意错误处理。可以使用 try...catch 语句捕获可能抛出的错误,并进行相应的处理。
- 资源释放: 在中止 pipeline 后,需要确保所有资源都得到正确释放。
总结
本文介绍了两种在 NodeJS Streams 的 pipeline 中提前结束读取流的解决方案。第一种方案是在转换流中“吞噬”后续数据,逻辑简单,但可能会浪费一些资源。第二种方案是使用 AbortController 中止 pipeline,更优雅,可以进行清理工作,但代码相对复杂。选择哪种方案取决于具体的应用场景和需求。同时,需要注意跨 chunk 边界问题和错误处理,确保程序的稳定性和可靠性。
到这里,我们也就讲完了《NodeJS流:Pipeline优雅结束方法》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于的知识点!
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
306 收藏
-
465 收藏
-
464 收藏
-
171 收藏
-
454 收藏
-
378 收藏
-
268 收藏
-
497 收藏
-
149 收藏
-
347 收藏
-
413 收藏
-
177 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 511次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 498次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习