欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Node.js折腾记一:读指定文件夹,输出该文件夹的文件树详解

程序员文章站 2022-03-18 17:21:27
前言 用来干什么:想干嘛干嘛 为什么写:写来玩,学习node.js文件系统相关api;树结构这种东西还是挺不错的,会用会造才是真的会 用了什么: fs.readdir...

前言

用来干什么:想干嘛干嘛
为什么写:写来玩,学习node.js文件系统相关api;树结构这种东西还是挺不错的,会用会造才是真的会
用了什么: fs.readdir(dir), fs.stat(dir).isfile(), path处理路径等

思路:

  1. 读取当前文件夹(不是文件夹的另作处理),获得其下所有文件和目录组成的数组;
  2. 循环该数组,判断是文件夹还是文件,文件的话直接push到childfiles(对象有两个属性:short文件名,full完整文件路径)
  3. 文件夹的话,先把当前文件夹作为key,存到父级文件夹的childdir属性下,然后自调用传当前文件夹路径
  4. 每一层文件夹都包含三个属性:dir文件夹路径,childfiles子文件,childdir子文件夹,存储为对象结构
  5. 以上步骤重复,直到达到最底层空文件夹或该文件夹只有文件

输出的样子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读指定文件夹输出该文件夹文件树详解整合,希望对大家有所帮助