Node.js 中 fs 模块的高级用法实例详解_Node.js

fs 模块不仅提供了基本的文件读写操作，还支持一些高级功能，如流式读写、文件监视、promise api 等。这些高级用法可以更好地满足复杂场景的需求，如大文件处理、实时监控等。

1. 流式读写

流（stream）是 node.js 中处理大文件或连续数据的核心概念。fs 模块提供了 fs.createreadstream 和 fs.createwritestream 方法，用于以流的方式读写文件。

1.1 流式读取文件

const fs = require('fs');
// 创建可读流
const readstream = fs.createreadstream('largefile.txt', 'utf8');
// 监听数据事件
readstream.on('data', (chunk) => {
  console.log('received chunk:', chunk.length);
});
// 监听结束事件
readstream.on('end', () => {
  console.log('file reading completed');
});
// 监听错误事件
readstream.on('error', (err) => {
  console.error('error reading file:', err);
});

说明：

fs.createreadstream 创建一个可读流，逐块读取文件内容。
data 事件：每次读取到数据块时触发。
end 事件：文件读取完成时触发。
error 事件：读取过程中发生错误时触发。

1.2 流式写入文件

const fs = require('fs');
// 创建可写流
const writestream = fs.createwritestream('output.txt');
// 写入数据
writestream.write('hello, world!\n');
writestream.write('this is a stream example.\n');
// 结束写入
writestream.end();
// 监听完成事件
writestream.on('finish', () => {
  console.log('file writing completed');
});
// 监听错误事件
writestream.on('error', (err) => {
  console.error('error writing file:', err);
});

说明：

fs.createwritestream 创建一个可写流，逐块写入文件内容。
write 方法：写入数据。
end 方法：结束写入。
finish 事件：写入完成时触发。
error 事件：写入过程中发生错误时触发。

1.3 管道操作

管道（pipe）是将可读流和可写流连接起来的便捷方式，常用于文件复制。

const fs = require('fs');
// 创建可读流和可写流
const readstream = fs.createreadstream('source.txt');
const writestream = fs.createwritestream('destination.txt');
// 使用管道复制文件
readstream.pipe(writestream);
// 监听完成事件
writestream.on('finish', () => {
  console.log('file copied successfully');
});
// 监听错误事件
readstream.on('error', (err) => {
  console.error('error reading file:', err);
});
writestream.on('error', (err) => {
  console.error('error writing file:', err);
});

2. 文件监视

fs 模块提供了 fs.watch 和 fs.watchfile 方法，用于监视文件或目录的变化。

2.1 使用 fs.watch

const fs = require('fs');
// 监视文件变化
const watcher = fs.watch('example.txt', (eventtype, filename) => {
  console.log(`event type: ${eventtype}`);
  if (filename) {
    console.log(`file changed: ${filename}`);
  }
});
// 关闭监视器
settimeout(() => {
  watcher.close();
  console.log('watcher closed');
}, 10000); // 10 秒后关闭

说明：

fs.watch 监视文件或目录的变化。
eventtype：事件类型（如 change、rename）。
filename：发生变化的文件名。

2.2 使用 fs.watchfile

const fs = require('fs');
// 监视文件变化
fs.watchfile('example.txt', { interval: 1000 }, (curr, prev) => {
  if (curr.mtime !== prev.mtime) {
    console.log('file modified');
  }
});
// 停止监视
settimeout(() => {
  fs.unwatchfile('example.txt');
  console.log('stopped watching file');
}, 10000); // 10 秒后停止

说明：

fs.watchfile 定期检查文件状态。
curr 和 prev：当前和之前的文件状态对象。
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);
});