如何使用事件发射器模式在 Node.js 中实现递归文件搜索

秋雪君_4872

秋雪君_4872

2026-07-18

977人浏览

原创

如何使用事件发射器模式在 Node.js 中实现递归文件搜索

本文详解 node.js 异步编程中常见的“提前执行”问题,通过手动状态机替代 foreach 实现串行文件读取,并基于 eventemitter 构建可监听的递归搜索流程,确保匹配文件名与内容能正确收集并写入目标文件。

本文详解 node.js 异步编程中常见的“提前执行”问题,通过手动状态机替代 foreach 实现串行文件读取,并基于 eventemitter 构建可监听的递归搜索流程,确保匹配文件名与内容能正确收集并写入目标文件。

在 Node.js 中,fs.readFile() 是典型的异步非阻塞 I/O 操作:调用后立即返回,不等待文件读取完成,而是通过回调函数通知结果。原代码中使用 fileList.forEach() 并发启动多个 fs.readFile(),但后续的 console.log("All matching files: ", matchingFiles) 会在所有回调执行前就运行——此时 matchingFiles 仍为空数组。这是初学者常遇的经典异步时序陷阱。

要正确收集结果,必须确保:
✅ 所有文件读取完成后再汇总输出;
✅ 错误(如权限拒绝)能中断流程或优雅跳过;
✅ 文件内容匹配逻辑与写入操作可组合、可监听。

以下是一个融合 EventEmitter 模式 与 手动串行控制流 的完整实现方案:

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
const fs = require('fs').promises; // 使用 Promise 版本更简洁(也可用 callback + util.promisify)
const path = require('path');
const EventEmitter = require('events');

class FileSearcher extends EventEmitter {
  constructor() {
    super();
  }

  async search(srcDir, keyword, dstDir, destFile) {
    const outputFile = path.join(dstDir, destFile);
    const matchingFiles = [];

    try {
      // 1. 递归读取所有文件路径(示例:简化为同步获取,实际可用 readdir + 递归)
      const allFiles = await this._collectFiles(srcDir);
      this.emit('scanStart', { total: allFiles.length });

      // 2. 串行处理每个文件(避免并发竞争与时序错乱)
      for (const file of allFiles) {
        const fullPath = path.join(srcDir, file);
        try {
          const content = await fs.readFile(fullPath, 'utf8');
          if (content.includes(keyword)) {
            matchingFiles.push(file);
            this.emit('match', { file, content });
            await this._saveContent(content, outputFile);
          }
        } catch (err) {
          if (err.code === 'ENOENT') {
            this.emit('warn', `File not found: ${fullPath}`);
            continue;
          }
          throw err; // 其他错误中止
        }
      }

      this.emit('complete', { matchingFiles, outputFile });
      return matchingFiles;

    } catch (err) {
      this.emit('error', err);
      throw err;
    }
  }

  _collectFiles(dir) {
    return new Promise((resolve, reject) => {
      const files = [];
      function walk(currentDir) {
        try {
          const entries = fs.readdirSync(currentDir, { withFileTypes: true });
          for (const entry of entries) {
            const fullPath = path.join(currentDir, entry.name);
            if (entry.isDirectory()) {
              walk(fullPath);
            } else if (entry.isFile() && path.extname(entry.name).toLowerCase() === '.txt') {
              files.push(path.relative(dir, fullPath));
            }
          }
        } catch (err) {
          reject(err);
        }
      }
      walk(dir);
      resolve(files);
    });
  }

  _saveContent(content, outputFile) {
    return fs.appendFile(outputFile, `\n--- ${new Date().toISOString()} ---\n${content}\n`);
  }
}

// 使用示例
const searcher = new FileSearcher();

searcher.on('scanStart', ({ total }) => console.log(`? 开始扫描 ${total} 个文件...`));
searcher.on('match', ({ file }) => console.log(`✅ 匹配文件: ${file}`));
searcher.on('warn', msg => console.warn(`⚠️  ${msg}`));
searcher.on('complete', ({ matchingFiles, outputFile }) => {
  console.log(`? 搜索完成!共找到 ${matchingFiles.length} 个匹配文件`);
  console.log(`? 结果已追加至: ${outputFile}`);
});
searcher.on('error', err => console.error('❌ 搜索失败:', err.message));

// 启动搜索
searcher.search('./src', 'TODO', './dist', 'matches.txt')
  .catch(console.error);

关键设计说明:

  • ✅ 串行而非并发:使用 for...of 配合 await 确保逐个处理,自然解决时序问题;
  • ✅ 事件驱动解耦:emit('match')、emit('error') 等让调用方自由订阅行为,符合 EventEmitter 设计模式要求;
  • ✅ 错误分类处理:ENOENT 视为警告并跳过,其他错误(如 EACCES)抛出中断流程;
  • ✅ 内容写入安全:使用 appendFile 而非覆盖,避免多文件写入冲突;
  • ⚠️ 注意递归深度:生产环境建议改用 fs.promises.readdir(..., { recursive: true })(Node.js 16.13+)或流式处理防止栈溢出。

该方案既修复了原始异步时序缺陷,又严格遵循事件发射器范式,同时具备可扩展性(如后续接入日志系统、WebSockets 实时推送进度等)。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js node.js node

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4346

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1089

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4264

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

860

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1756

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3145

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4093

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2640

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.7万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.7万人学习