快捷導航

Node.js?中?fs?模塊的高級用法實例詳解

更新時間：2025年02月25日 11:38:23 作者：小灰灰學編程

文章介紹了Node.js中fs模塊的高級用法,包括流式讀寫、文件監(jiān)視、PromiseAPI、遞歸目錄操作等,這些功能有助于更好地處理復雜文件操作場景,提升代碼性能和可維護性,感興趣的朋友跟隨小編一起看看吧

1. 流式讀寫

流（Stream）是 Node.js 中處理大文件或連續(xù)數(shù)據(jù)的核心概念。fs 模塊提供了 fs.createReadStream 和 fs.createWriteStream 方法，用于以流的方式讀寫文件。

1.1 流式讀取文件

const fs = require('fs');
// 創(chuàng)建可讀流
const readStream = fs.createReadStream('largeFile.txt', 'utf8');
// 監(jiān)聽數(shù)據(jù)事件
readStream.on('data', (chunk) => {
  console.log('Received chunk:', chunk.length);
});
// 監(jiān)聽結(jié)束事件
readStream.on('end', () => {
  console.log('File reading completed');
});
// 監(jiān)聽錯誤事件
readStream.on('error', (err) => {
  console.error('Error reading file:', err);
});

說明：

fs.createReadStream 創(chuàng)建一個可讀流，逐塊讀取文件內(nèi)容。
data 事件：每次讀取到數(shù)據(jù)塊時觸發(fā)。
end 事件：文件讀取完成時觸發(fā)。
error 事件：讀取過程中發(fā)生錯誤時觸發(fā)。

1.2 流式寫入文件

const fs = require('fs');
// 創(chuàng)建可寫流
const writeStream = fs.createWriteStream('output.txt');
// 寫入數(shù)據(jù)
writeStream.write('Hello, world!\n');
writeStream.write('This is a stream example.\n');
// 結(jié)束寫入
writeStream.end();
// 監(jiān)聽完成事件
writeStream.on('finish', () => {
  console.log('File writing completed');
});
// 監(jiān)聽錯誤事件
writeStream.on('error', (err) => {
  console.error('Error writing file:', err);
});

說明：

fs.createWriteStream 創(chuàng)建一個可寫流，逐塊寫入文件內(nèi)容。
write 方法：寫入數(shù)據(jù)。
end 方法：結(jié)束寫入。
finish 事件：寫入完成時觸發(fā)。
error 事件：寫入過程中發(fā)生錯誤時觸發(fā)。

1.3 管道操作

管道（Pipe）是將可讀流和可寫流連接起來的便捷方式，常用于文件復制。

const fs = require('fs');
// 創(chuàng)建可讀流和可寫流
const readStream = fs.createReadStream('source.txt');
const writeStream = fs.createWriteStream('destination.txt');
// 使用管道復制文件
readStream.pipe(writeStream);
// 監(jiān)聽完成事件
writeStream.on('finish', () => {
  console.log('File copied successfully');
});
// 監(jiān)聽錯誤事件
readStream.on('error', (err) => {
  console.error('Error reading file:', err);
});
writeStream.on('error', (err) => {
  console.error('Error writing file:', err);
});

2. 文件監(jiān)視

fs 模塊提供了 fs.watch 和 fs.watchFile 方法，用于監(jiān)視文件或目錄的變化。

2.1 使用 fs.watch

const fs = require('fs');
// 監(jiān)視文件變化
const watcher = fs.watch('example.txt', (eventType, filename) => {
  console.log(`Event type: ${eventType}`);
  if (filename) {
    console.log(`File changed: ${filename}`);
  }
});
// 關(guān)閉監(jiān)視器
setTimeout(() => {
  watcher.close();
  console.log('Watcher closed');
}, 10000); // 10 秒后關(guān)閉

說明：

fs.watch 監(jiān)視文件或目錄的變化。
eventType：事件類型（如 change、rename）。
filename：發(fā)生變化的文件名。

2.2 使用 fs.watchFile

const fs = require('fs');
// 監(jiān)視文件變化
fs.watchFile('example.txt', { interval: 1000 }, (curr, prev) => {
  if (curr.mtime !== prev.mtime) {
    console.log('File modified');
  }
});
// 停止監(jiān)視
setTimeout(() => {
  fs.unwatchFile('example.txt');
  console.log('Stopped watching file');
}, 10000); // 10 秒后停止

說明：

fs.watchFile 定期檢查文件狀態(tài)。
curr 和 prev：當前和之前的文件狀態(tài)對象。
interval：檢查間隔（毫秒）。

3. Promise API

Node.js 從 v10 開始提供了 fs.promises API，支持基于 Promise 的文件操作。

3.1 使用 fs.promises 讀取文件

const fs = require('fs').promises;
async function readFile() {
  try {
    const data = await fs.readFile('example.txt', 'utf8');
    console.log('File content:', data);
  } catch (err) {
    console.error('Failed to read file:', err);
  }
}
readFile();

3.2 使用 fs.promises 寫入文件

const fs = require('fs').promises;
async function writeFile() {
  try {
    await fs.writeFile('example.txt', 'Hello, world!', 'utf8');
    console.log('File written successfully');
  } catch (err) {
    console.error('Failed to write file:', err);
  }
}
writeFile();

4. 遞歸目錄操作

4.1 遞歸讀取目錄

const fs = require('fs');
const path = require('path');
async function readDirRecursive(dir) {
  const files = await fs.promises.readdir(dir);
  for (const file of files) {
    const filePath = path.join(dir, file);
    const stats = await fs.promises.stat(filePath);
    if (stats.isDirectory()) {
      await readDirRecursive(filePath); // 遞歸讀取子目錄
    } else {
      console.log('File:', filePath);
    }
  }
}
readDirRecursive('./').catch((err) => {
  console.error('Failed to read directory:', err);
});

4.2 遞歸刪除目錄

const fs = require('fs');
const path = require('path');
async function deleteDirRecursive(dir) {
  const files = await fs.promises.readdir(dir);
  for (const file of files) {
    const filePath = path.join(dir, file);
    const stats = await fs.promises.stat(filePath);
    if (stats.isDirectory()) {
      await deleteDirRecursive(filePath); // 遞歸刪除子目錄
    } else {
      await fs.promises.unlink(filePath); // 刪除文件
      console.log('Deleted file:', filePath);
    }
  }
  await fs.promises.rmdir(dir); // 刪除空目錄
  console.log('Deleted directory:', dir);
}
deleteDirRecursive('./temp').catch((err) => {
  console.error('Failed to delete directory:', err);
});