最近在写一个管理 markdown 文件的工具 knowledge-center ，需要读取指定文件夹内所有 markdown 文件。因此需要用 Node.js 来实现遍历一个文件夹内所有文件的功能。

Node.js 中提供了这些有用的 api：

fs.readdir
fs.readdirSync
fs.statSync

获取的文件列表为数组格式

对于遍历的结果，我们可以选择按列表或文件树来展示。先从最简单的情况看起，用同步方式处理，返回结果是一个列表。

先使用 fs.readdirSync 获取文件列表，然后遍历文件列表，使用 fs.statSync 获取列表中文件的状态，如果是文件，则添加到文件列表中，如果是文件夹，则递归调用 traverseFolderList 函数，直到获取到所有文件。

获取的文件列表为对象格式

如果我们想展示文件夹目录结构，那么列表格式的就不太方便了。假设有如下的文件夹结构：

./1
├── 2
│   ├── test2.txt
│   └── test2_1.txt
└── 3
    ├── 4
    │   └── test4.txt
    └── test3.txt

希望获取到的对象结构如下：

{
  root: {
    path: './1',
    type: 'folder',
    children: ['2', '3'],
    isRoot: true,
  },
  2: {
    path: '2',
    type: 'folder',
    children: ['2/test2.txt', '2/test2_1.txt'],
  },
  3: { path: '3', type: 'folder', children: ['3/4', '3/test3.txt'] },
  '2/test2.txt': { path: '2/test2.txt', type: 'file' },
  '2/test2_1.txt': { path: '2/test2_1.txt', type: 'file' },
  '3/4/test4.txt': { path: '3/4/test4.txt', type: 'folder', children: [] },
  '3/4': { path: '3/4', type: 'folder', children: ['3/4/test4.txt'] },
  '3/test3.txt': { path: '3/test3.txt', type: 'file' },
};

这个对象以文件/文件夹相对于根目录的相对路径为 key，每个节点包含了这些属性：

type
path
children

异步方式

在上面的实现中，都是使用了同步的方式来处理，即 fs.readdirSync 方法，可以使用异步方式来处理吗？

可以选择 fs.readdir 来异步读取文件夹, 但是回调函数的调用方式不太方便。在 Node 10+ 中可以从 fs.promises 中引入 readdir 方法，这样就可以使用方便的 async/await 语法来进行异步处理，同时避免了 的回调函数。

const { readdir } = require('fs').promises; 

将上面的 traverseFolderList 方法重写为异步格式：

比较同步和异步两种方案

traverseFolderList 和 asyncTraverseFolderList 返回的结果都是列表格式，我们可以写一个测试脚本来比较下二者的运行时间：

分别用两个函数遍历了同一个文件夹十次后，统计结果如下，异步方式比同步方式快了约18%。

同步 - 平均耗时：1217.1ms
异步 - 平均耗时：1025.7ms

原文 http://www.wukai.me/2022/02/27/nodejs-traverse-folder/

链接: https://fly63.com/article/detial/11229