本文介绍如何使用 Node.js 的 fs 和 path 模块递归读取指定文件夹，生成包含文件路径和子目录结构的 JSON 对象。通过 getDirTree 函数实现目录树的构建，并将结果格式化输出为 JSON 文件，便于查看和后续处理。
Node.js 读取指定文件夹并生成文件树结构详解
前言
本文档旨在演示如何利用 Node.js 进行文件系统的操作。编写此文的初衷是为了实践和学习 Node.js 中关于文件系统的相关 API，同时探索树形数据结构的应用。掌握树结构的构建与遍历是理解复杂文件操作的关键。
实现思路
实现思路：
- 首先读取当前指定文件夹（排除非文件夹类型），获取该目录下所有文件和子目录的名称数组；
- 遍历上述数组，判断每一项是文件还是文件夹。如果是文件，则将其信息（包含短文件名和完整文件路径）推入 childFiles 数组中；
- 如果是文件夹，则将该文件夹路径作为键，存入父级对象的 childDir 属性中，并递归调用当前函数，传入该子文件夹的路径继续处理；
- 每一层级的文件夹对象均包含三个核心属性：dir（当前文件夹路径）、childFiles（子文件列表）和 childDir（子目录集合），整体以对象结构存储；
- 重复上述步骤，直到遍历到最底层的空文件夹或仅包含文件的目录为止；
最终输出的数据结构示例见 components-dir-tree.json；
{
"dir": "D:\\node-test\\components",
"childFiles": [
{
"short": "components-dir-tree.json",
"full": "D:\\node-test\\components\\components-dir-tree.json"
},
{
"short": "file.js",
"full": "D:\\node-test\\components\\file.js"
},
{
"short": "index.js",
"full": "D:\\node-test\\components\\index.js"
}
],
"childDir": {
"no": null,
"test": {
"dir": "D:\\node-test\\components\\test",
"childFiles": [],
"childDir": {
"aa": {
"dir": "D:\\node-test\\components\\test\\aa",
"childFiles": [
{
"short": "bb.js",
"full": "D:\\node-test\\components\\test\\aa\\bb.js"
}
],
"childDir": {
"cc": null
}
}
}
}
}
}
。示例目录结构（仅展示 components 部分）：
``` |-- components |-- index.js |-- file.js |-- components-dir-tree.json // 生成的文件树对象的输出文件，方便查看 |-- no |-- test |-- aa |-- cc ```
使用方法与代码实现
使用方法：
将生成的结果对象格式化为 JSON 字符串，并写入文件，以便直观查看目录树结构；
components/index.js:
/**
* init
*/
require('console-color-mr'); // 命令行样式
const fs = require('fs');
const path = require('path');
const { getDirTree, getDirName } = require('./file.js');
const componentDir = path.resolve(__dirname, './');
// console.log('componentDir: ', componentDir);
const ComponentInit = (function init() {
console.log('______ init ______'.blueBG, '\n');
let treeObj = getDirTree(componentDir);
// console.log('treeObj: ',treeObj);
if (treeObj) {
let outdir = `${__dirname}\\${getDirName(componentDir)}-dir-tree.json`;
// 写入文件
fs.writeFile(outdir, JSON.stringify(treeObj, '', '\t'), 'utf8', (err) => {
if (err) throw err;
console.log(`目录树已输出为文件保存: ${outdir}`.greenBG);
});
}
return init;
})();
module.exports = ComponentInit;
核心主函数 getDirTree 的实现逻辑如下：
/components/file.js
const fs = require('fs');
/**
* 获取目录下的文件树
* @param {读取的路径} dir
* @returns 返回 dir 目录下的文件树
*/
function getDirTree(dir) {
let obj = {
dir: dir, // 文件夹路径
childFiles: [], // 子文件
childDir: {} // 子目录
};
let objStr = JSON.stringify(obj);
if (isFile(dir)) return console.log(`${dir}: 不是文件夹`.redBG);
// 读取目录
let files = readDir(dir);
if (!files.length) console.log(`${dir}: 文件夹为空`.redBG);
// 遍历文件
files.forEach(file => {
let tempdir = `${dir}\\${file}`;
if (isFile(tempdir)) {
obj.childFiles.push({
short: file, // 文件名
full: tempdir // 完整路径
});
} else {
// console.log('tempdir: ',tempdir);
let dirname = getDirName(tempdir);
// 在当前文件夹的对象下 childDir 属性(1)，以文件夹名作为key(2)，
// (2)的值是该目录下 路径dir、childFiles子文件、childDir子文件夹组成的对象或null
obj.childDir[dirname] = getDirTree(tempdir);
}
});
return JSON.stringify(obj) === objStr ? null : obj;
}
辅助工具函数 readDir 和 isFile 的定义如下：
// 读取路径下的文件、文件夹
function readDir(dir) {
return fs.readdirSync(dir, (err, files) => {
if (err) throw err;
// console.log(`${dir}, files: `.green, files);
// if (!files.length) console.log(`${dir}: 文件夹为空`.redBG);
return files;
})
}
// 判断制定路径是否是文件
function isFile(dir) {
return fs.statSync(dir).isFile();
}
// 获取目录名
function getDirName(dir) {
let tempdir = dir.substr(dir.lastIndexOf('\\')+1, dir.length);
return tempdir;
}
// const components_out = readFile(path.resolve(__dirname, './components-dir-tree.json'));
// console.log('components-dir-tree: ', components_out);
// 读取指定目录的文件
function readFile(dir) {
let result = fs.readFileSync(dir, 'utf-8');
return (
result
? {
dir: dir,
result: result
}
: null
);
}
module.exports = {
getDirTree,
readDir,
isFile,
readFile
}
至此，功能实现完毕。
以上所述是小编给大家介绍的Node.js读指定文件夹输出该文件夹文件树详解整合，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对本站网站的支持！