Node.js匹配文件夹所有文件关键字的完整教程

 更新时间:2025年04月30日 11:38:12   作者:楠木685  
本文基于nodejs构建一个自动化检测工具:读取 Excel 中的关键字,在指定目录的所有文件中搜索是否存在对应内容,最终生成带标记结果的 Excel 文件,需要的朋友可以参考下

一、场景需求分析

典型应用场景:

  • 前端接口冗余:检测接口是否使用
  • 前端项目国际化:检测翻译词库是否已全部使用
  • 代码规范检查:验证废弃 API 是否仍存在引用
  • 文档完整性验证:确认知识库词条是否都有对应文档

二、技术栈说明

技术版本作用
Node.js>=14.x运行环境
xlsx^0.18.5Excel 文件处理
fs/promises内置文件系统操作
path内置路径处理

安装依赖:

npm install xlsx

三、核心代码解析

1. Excel读取模块

const xlsx = require("xlsx");

function readExcelRows(filePath) {
  const workbook = xlsx.readFile(filePath);
  const sheetName = workbook.SheetNames[0];
  const sheet = workbook.Sheets[sheetName];
  // header:1 表示保留二维数组结构
  const rows = xlsx.utils.sheet_to_json(sheet, { header: 1 }); 
  return { workbook, sheetName, rows };
}

注意:sheet_to_json 的 header 参数决定输出格式:

  • header:1 → 二维数组(保留原始行列结构)
  • header:["col1","col2"] → 对象数组(自动映射字段)

2. 目录遍历模块

async function getAllFilesContent(dirPath, fileList = []) {
  return new Promise((resolve, reject) => {
    fs.readdir(dirPath, async (err, files) => {
      if (err) return reject(err);
      
      for (const file of files) {
        const fullPath = path.join(dirPath, file);
        const stats = fs.statSync(fullPath);
        
        if (stats.isDirectory()) {
          if (!excludedDirs.includes(file)) {
            await getAllFilesContent(fullPath, fileList);
          }
        } else if (stats.isFile()) {
          try {
            const content = fs.readFileSync(fullPath, "utf8");
            fileList.push({ path: fullPath, content });
          } catch (err) {
            console.error(`读取文件失败: ${fullPath}`);
          }
        }
      }
      resolve(fileList);
    });
  });
}

最佳实践建议:

  • 使用 fs.statSync 判断文件类型
  • 排除 node_modules 等无关目录
  • 添加错误处理防止程序崩溃

3. 匹配检测逻辑

for (let i = 0; i < rows.length; i++) {
  const row = rows[i];
  const keyword = row[1]; // 取第二列数据
  
  if (typeof keyword === "string") {
    const matched = allFiles.some((file) => 
      file.content.includes(keyword)
    );
    
    if (!matched) {
      row[4] = "是"; // 在第五列标记
    }
  }
}

性能优化思路:

  • 使用正则表达式预编译
  • 增加防抖机制处理超长文本
  • 支持批量处理多个工作表

四、完整代码

const fs = require("fs");
const path = require("path");
const xlsx = require("xlsx");

const excludedDirs = ["node_modules", "public"];

// 读取 Excel 所有行(保留结构)
function readExcelRows(filePath) {
  const workbook = xlsx.readFile(filePath);
  const sheetName = workbook.SheetNames[0];
  const sheet = workbook.Sheets[sheetName];
  const rows = xlsx.utils.sheet_to_json(sheet, { header: 1 }); // 保持数组结构
  return { workbook, sheetName, rows };
}

// 获取目录下所有文件内容
async function getAllFilesContent(dirPath, fileList = []) {
  return new Promise((resolve, reject) => {
    fs.readdir(dirPath, async (err, files) => {
      if (err) return reject(err);

      for (const file of files) {
        const fullPath = path.join(dirPath, file);
        const stats = fs.statSync(fullPath);

        if (stats.isDirectory()) {
          if (!excludedDirs.includes(file)) {
            await getAllFilesContent(fullPath, fileList);
          }
        } else if (stats.isFile()) {
          try {
            const content = fs.readFileSync(fullPath, "utf8");
            fileList.push({ path: fullPath, content });
          } catch (err) {
            console.error(`读取文件失败: ${fullPath}`);
          }
        }
      }

      resolve(fileList);
    });
  });
}

// 主函数
async function main() {
  const excelPath = "./data.xlsx"; // 替换成你的 Excel 文件路径
  const targetDir1 = ""; // 替换成你要查找的文件夹路径
  const targetDir2 = "";// 替换成你要查找的文件夹路径,可选多个路径

  // 1. 读取 Excel 原始行数据
  const { workbook, sheetName, rows } = readExcelRows(excelPath);
  console.log(`📋 共读取 ${rows.length} 行`);

  // 2. 获取两个目录的所有文件内容
  const files1 = await getAllFilesContent(targetDir1);
  const files2 = await getAllFilesContent(targetDir2);
  const allFiles = [...files1, ...files2];
  console.log(`📄 共读取 ${allFiles.length} 个文件`);

  // 3. 遍历 Excel 每一行,检查第2列关键词是否被文件匹配
  for (let i = 0; i < rows.length; i++) {
    const row = rows[i];
    const keyword = row[1]; // 第二列

    if (typeof keyword === "string") {
      const matched = allFiles.some((file) => file.content.includes(keyword));
      if (!matched) {
        row[4] = "是"; // 第5列写入“是”
      }
    }
  }

  // 4. 写回新的 Excel 文件
  const newSheet = xlsx.utils.aoa_to_sheet(rows);
  const newWorkbook = xlsx.utils.book_new();
  xlsx.utils.book_append_sheet(newWorkbook, newSheet, sheetName);
  xlsx.writeFile(newWorkbook, "./test.xlsx");

  console.log(
    "✅ 处理完成,未匹配的关键词已在第5列标记“是”,结果已保存为 keywords_result.xlsx"
  );
}

main();

到此这篇关于Node.js匹配文件夹所有文件关键字的完整教程的文章就介绍到这了,更多相关Node.js匹配文件夹文件关键字内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 从零开始学习Node.js系列教程之设置HTTP头的方法示例

    从零开始学习Node.js系列教程之设置HTTP头的方法示例

    这篇文章主要介绍了Node.js设置HTTP头的方法,详细分析了常见HTTP头的功能、原理及相关设置操作技巧,需要的朋友可以参考下
    2017-04-04
  • Node.js 连接 MySql 统计组件属性的使用情况解析

    Node.js 连接 MySql 统计组件属性的使用情况解析

    这篇文章主要为大家介绍了Node.js 连接 MySql 统计组件属性的使用情况解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-10-10
  • node实现socket链接与GPRS进行通信的方法

    node实现socket链接与GPRS进行通信的方法

    这篇文章主要介绍了node实现socket链接与GPRS进行通信的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-05-05
  • nodejs express实现中间件

    nodejs express实现中间件

    这篇文章主要为大家介绍了nodejs express实现中间件实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-10-10
  • Node.js 多线程实战小结

    Node.js 多线程实战小结

    在 Node.js 的世界中,多线程技术一直是一个受到广泛关注的领域,本文主要介绍了Node.js 多线程实战小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • 利用Node.js了解与测量HTTP所花费的时间详解

    利用Node.js了解与测量HTTP所花费的时间详解

    这篇文章主要给大家介绍了关于利用Node.js了解与测量HTTP所花费的时间的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2017-09-09
  • 基于Node.js实现nodemailer邮件发送

    基于Node.js实现nodemailer邮件发送

    Nodemailer 是一个简单易用的 Node.JS 邮件发送模块(通过 SMTP,sendmail,或者 Amazon SES),支持 unicode,你可以使用任何你喜欢的字符集。Nodemailer是一个简单易用的Node.js邮件发送组件,需要的朋友可以参考下
    2016-01-01
  • Node.js与MySQL交互操作及其注意事项

    Node.js与MySQL交互操作及其注意事项

    这篇文章给大家主要介绍了Node.js与MySQL交互操作及其注意事项,非常的详细,有相同需求的小伙伴可以参考下
    2016-10-10
  • 从零开始学习Node.js系列教程五:服务器监听方法示例

    从零开始学习Node.js系列教程五:服务器监听方法示例

    这篇文章主要介绍了Node.js服务器监听方法,结合实例形式分析了nodejs事件监听相关操作技巧,需要的朋友可以参考下
    2017-04-04
  • Node.js 制作实时多人游戏框架

    Node.js 制作实时多人游戏框架

    这篇文章主要介绍了Node.js 制作实时多人游戏框架,需要的朋友可以参考下
    2015-01-01

最新评论