前言
- 用來幹什麼:想幹嘛幹嘛
- 為什麼寫:寫來玩,學習
node.js
檔案系統相關api;樹結構這種東西還是挺不錯的,會用會造才是真的會 - 用了什麼:
fs.readdir(dir)
,fs.stat(dir).isFile()
,path
處理路徑等 - 思路:
- 讀取當前資料夾(不是資料夾的另作處理),獲得其下所有檔案和目錄組成的陣列;
- 迴圈該陣列,判斷是資料夾還是檔案,檔案的話直接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);
// 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-test