掌握 Node.js 文件模块，玩转文件处理

2023-10-07 04:12:08

文件模块：掌握 Node.js 文件系统的强大工具

在 Node.js 开发中，文件模块是处理文件系统操作的利器。它提供了一系列强大且灵活的方法，让开发者能够轻松高效地读写、创建、重命名和删除文件及目录。本文将深入探讨文件模块的各个方面，帮助你掌握其功能，提升项目开发效率。

文件系统对象

文件模块的核心是 fs 对象，它充当了开发者与文件系统交互的桥梁。fs 对象提供了各种方法，遵循异步编程范式，让你可以在执行 I/O 操作时避免阻塞主线程。

同步与异步 I/O

文件模块支持同步和异步两种 I/O 模式。同步 I/O 方法带有 Sync 后缀，如 readFileSync 和 writeFileSync。它们会阻塞主线程，直到 I/O 操作完成。异步 I/O 方法则采用回调或 Promise 形式，允许你在 I/O 操作进行时继续执行其他任务。

文件流

文件流提供了对文件的字节级访问。你可以使用 createReadStream 和 createWriteStream 创建文件流，并通过 read(), write() 和 pipe() 等方法进行读写操作。文件流通常用于处理大文件或流式传输数据。

读写文件

读写文件是文件模块最基本的功能。你可以使用 readFile 和 writeFile 方法进行异步读写，或使用 readFileSync 和 writeFileSync 方法进行同步读写。

const fs = require('fs');

// 异步读写
fs.readFile('file.txt', 'utf-8', (err, data) => {
  if (err) throw err;
  console.log(data);
});

// 同步读写
const data = fs.readFileSync('file.txt', 'utf-8');
console.log(data);

创建和删除目录

文件模块还提供了创建和删除目录的功能。你可以使用 mkdir 和 rmdir 方法进行异步创建和删除，或使用 mkdirSync 和 rmdirSync 方法进行同步创建和删除。

const fs = require('fs');

// 异步创建和删除目录
fs.mkdir('newdir', (err) => {
  if (err) throw err;
  console.log('Directory created');
});

// 同步创建和删除目录
fs.mkdirSync('newdir');
fs.rmdirSync('newdir');

文件信息和属性

文件模块允许你获取有关文件和目录的详细信息，例如文件大小、修改时间和文件类型。你可以使用 stat 和 statSync 方法进行异步和同步获取。

const fs = require('fs');

// 异步获取文件信息
fs.stat('file.txt', (err, stats) => {
  if (err) throw err;
  console.log(`File size: ${stats.size} bytes`);
});

// 同步获取文件信息
const stats = fs.statSync('file.txt');
console.log(`File size: ${stats.size} bytes`);

最佳实践

错误处理： 使用 try...catch 块或回调函数中的错误处理机制仔细处理文件 I/O 操作的错误情况。
流式处理大文件： 对于大文件，使用文件流进行分块读写，避免一次性加载整个文件到内存中。
文件系统监视： 使用 fs.watch() 方法监视文件或目录的更改，并在文件系统发生更改时触发事件。这对于实时文件更新或自动重新加载等场景非常有用。

常见问题解答