如何使用Node.js遍历文件夹详解

前言

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

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

异步方式

比较同步和异步两种方案

附node遍历文件夹并读取文件内容

参考资料

总结

前言

最近在写一个管理 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 API，其中提供了一些文件系统的方法，它们返回的是一个 Promise 对象，而非使用回调函数。这里可以从 fs.promises 中引入 readdir 方法，从而可以使用方便的 async/await 语法来进行异步处理，避免了回调函数的方式。

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

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

比较同步和异步两种方案

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

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

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

注意一点，本文中的代码都是没有做错误处理的，实际上读取文件时可能会出错，因此将相应的代码使用 try...catch 包起来是一个合理的做法。

附node遍历文件夹并读取文件内容

var fs = require('fs');
var path = require('path');//解析需要遍历的文件夹
var filePath = path.resolve('./dist');
//调用文件遍历方法
fileDisplay(filePath);
//文件遍历方法
function fileDisplay(filePath){undefined
    //根据文件路径读取文件，返回文件列表
    fs.readdir(filePath,function(err,files){undefined
        if(err){undefined
            console.warn(err)
        }else{undefined
            //遍历读取到的文件列表
            files.forEach(function(filename){undefined
                //获取当前文件的绝对路径
                var filedir = path.join(filePath, filename);
                //根据文件路径获取文件信息，返回一个fs.Stats对象
                fs.stat(filedir,function(eror, stats){undefined
                    if(eror){undefined
                        console.warn('获取文件stats失败');
                    }else{undefined
                        var isFile = stats.isFile();//是文件
                        var isDir = stats.isDirectory();//是文件夹
                        if(isFile){undefined
                            console.log(filedir);　　　　　　　　　　　　　　　　　// 读取文件内容
                            var content = fs.readFileSync(filedir, 'utf-8');
                            console.log(content);
                        }
                        if(isDir){undefined
                            fileDisplay(filedir);//递归，如果是文件夹，就继续遍历该文件夹下面的文件
                        }
                    }
                })
            });
        }
    });
}

如果碰到有中文不能解析的html，这样写

var cheerio = require('cheerio');
var iconv = require('iconv-lite');
var myHtml = fs.readFileSync("index.html");
var myHtml2 = iconv.decode(myHtml, 'gbk');
console.log(myHtml2);

参考资料

https://stackoverflow.com/a/45130990

fs.promises API

https://javascript.info/promisify

总结

到此这篇关于如何使用Node.js遍历文件夹的文章就介绍到这了,更多相关Node.js遍历文件夹内容请搜索易知道(ezd.cc)以前的文章或继续浏览下面的相关文章希望大家以后多多支持易知道(ezd.cc)！

推荐阅读