以異步方式讀取指定目錄下的內容。
fs.readdir(path, [callback(err, files)])
屬於 fs 模塊,使用前先引入:
var fs = require("fs");
path:目錄路徑。callback:回調函式,接收兩個參數——異常 err,以及 files。後者是一個陣列,內容為該目錄底下所有項目的名稱。var fs = require('fs');
fs.readdir('readdirtest', function (err, files) {
if (err) {
console.log(err);
return; // 出錯時記得 return,避免後續用到 undefined
}
console.log(files);
});
fs.readdir = function(path, callback) {
callback = makeCallback(callback);
if (!nullCheck(path, callback)) return;
binding.readdir(pathModule._makeLong(path), callback);
};
又是熟悉的開場三連:確認回調是函式、檢查路徑是否含空字節、把路徑轉成平台可用的長路徑形式,然後才交給底層執行。把這幾個 fs 方法的源碼放在一起看,會發現它們的差異其實只在最後那一行 binding 呼叫,外層的防禦性檢查幾乎完全一致——這正是 Node 早期版本刻意維持的一致風格。
第一,回傳的只有名稱,不含路徑。要拿完整路徑必須自己用 path.join(目錄, 名稱) 拼一次,直接字串相加在跨平台時會出問題。
第二,回傳的項目包含目錄本身,不只有檔案。若要區分,需對每一項再呼叫 fs.stat(會判斷符號鏈接指向的目標)或 fs.lstat(判斷鏈接自身),然後用 isFile() / isDirectory() 判斷。
第三,較新的 Node 版本支援 fs.readdir(path, { withFileTypes: true }, cb),回傳的會是 Dirent 物件陣列,可以直接呼叫 isDirectory() 等方法,省下一輪 stat 的 I/O,在目錄項目眾多時差異明顯。
第四,若要遞迴遍歷整棵目錄樹,Node 20 起提供了 { recursive: true } 選項;在更早的版本上則需要自己寫遞迴。