Node.js折騰記一：讀指定文件夾，輸出該文件夾的文件樹

前言

1. 用來幹什麼：想幹嗎幹嗎
2. 爲何寫：寫來玩，學習node.js文件系統相關api；樹結構這種東西仍是挺不錯的，會用會造纔是真的會
3. 用了什麼： fs.readdir(dir), fs.stat(dir).isFile(), path處理路徑等
4. 思路：
   • 讀取當前文件夾（不是文件夾的另做處理），得到其下全部文件和目錄組成的數組；
   • 循環該數組，判斷是文件夾仍是文件，文件的話直接push到childFiles（對象有兩個屬性：short文件名，full完整文件路徑）
   • 文件夾的話，先把當前文件夾做爲key，存到父級文件夾的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);
  
  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-test

到這裏就結束了！