如何用directory-tree npm读取15000个子目录并设置10秒超时

问题背景 #

使用directory-tree npm包读取包含15000+多级子目录的目录时，同步调用耗时长达30分钟，需要实现10秒超时机制：若读取未在10秒内完成，立即终止HTTP请求并返回指定错误信息。

核心解决方案 #

1. 异步化读取+超时控制 #

同步的dirTree调用会阻塞Node.js事件循环，导致定时器无法正常触发，因此必须先将其转为异步操作，再结合Promise.race实现超时逻辑。

代码实现

const dirTree = require("directory-tree");
const { promisify } = require("util");
// 将同步方法转为异步Promise版本
const asyncDirTree = promisify(dirTree);

// HTTP请求处理函数示例
async function handleDirectoryRead(req, res) {
  try {
    // 定义10秒超时的Promise
    const timeoutPromise = new Promise((_, reject) => {
      setTimeout(() => reject(new Error("TIMEOUT")), 10000);
    });

    // 同时执行目录读取和超时检测
    const directoryStructure = await Promise.race([
      asyncDirTree("./test"),
      timeoutPromise
    ]);

    res.send(directoryStructure);
  } catch (error) {
    if (error.message === "TIMEOUT") {
      // 超时返回指定错误
      res.send({ msg: "读取所有目录耗时过长，请稍后再试。" });
    } else {
      // 处理其他读取错误
      res.status(500).send({ msg: "目录读取失败", error: error.message });
    }
  }
}

2. 性能优化：仅读取目录（关键） #

directory-tree默认会遍历所有文件并读取元数据（如大小、类型），这是导致大目录读取缓慢的主要原因。如果只需要目录结构，可通过过滤参数仅保留目录项，能大幅提升读取速度。

过滤目录的代码示例

// 仅读取目录，过滤所有文件
const directoryStructure = await asyncDirTree("./test", {
  filter: (item) => item.type === "directory"
});

注意事项 #

• 必须使用异步读取：同步操作会阻塞事件循环，导致超时定时器无法触发，无法实现超时终止逻辑。
• 若directory-tree版本支持原生异步API（如回调形式），可直接使用原生异步方法，无需promisify转换。
• 过滤目录是提升速度的核心手段，多数情况下优化后可在10秒内完成读取，无需触发超时。

内容的提问来源于stack exchange，提问作者Reena