文件系统操作：Node.js 中的 fs 模块完全指南

文件系统操作：Node.js 中的 fs 模块完全指南

Node.js 是一个强大的服务器端 JavaScript 环境，它不仅能够处理 HTTP 请求，还能够与操作系统进行紧密的交互，处理文件、目录等文件系统操作。在 Node.js 中，文件系统操作是通过 fs（文件系统）模块来完成的。通过这个模块，开发者可以执行多种操作，如读取、写入、删除文件等。

本文将深入探讨 fs 模块的功能，提供从基础到高级的实用技巧和示例，帮助你更好地理解如何使用 fs 进行文件系统操作。

目录

1. 介绍 fs 模块
2. fs 模块的常用 API
3. 同步与异步操作
4. 读取文件
5. 写入文件
6. 删除文件与重命名文件
7. 文件夹操作：创建与删除目录
8. 文件路径与权限管理
9. 流式操作：文件读取与写入流
10. 常见问题与最佳实践
11. 总结

---

1. 介绍 fs 模块

fs 模块是 Node.js 内置的一个模块，它提供了与文件系统交互的 API，支持对文件和目录的读取、写入、修改、删除等操作。fs 模块可以操作本地文件系统，并且支持同步和异步两种工作方式。通常，我们会优先使用异步操作，因为它能够提高应用的性能，避免阻塞事件循环。

引入 fs 模块

在使用 fs 模块之前，我们需要通过 require() 引入它：

const fs = require('fs');

2. fs 模块的常用 API

fs 模块提供了大量的 API，常用的 API 包括：

• fs.readFile(): 读取文件内容。
• fs.writeFile(): 写入文件内容。
• fs.appendFile(): 追加内容到文件。
• fs.unlink(): 删除文件。
• fs.rename(): 重命名文件或目录。
• fs.mkdir(): 创建目录。
• fs.rmdir(): 删除目录。
• fs.readdir(): 读取目录内容。
• fs.existsSync(): 检查文件或目录是否存在。

这些 API 大多提供同步和异步两种方式，适用于不同的场景。

3. 同步与异步操作

Node.js 中的文件系统操作支持同步和异步两种方式：

• 同步操作：会阻塞程序，直到文件操作完成，适用于简单脚本或脚本运行时不要求并发的场景。
• 异步操作：不会阻塞程序，适用于高并发的应用，推荐在大多数场景下使用。

同步操作示例

const data = fs.readFileSync('example.txt', 'utf8');
console.log(data);

异步操作示例

fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) throw err;
  console.log(data);
});

异步方法的优点在于它不会阻塞事件循环，允许 Node.js 同时处理多个文件操作，因此它更适用于处理大量文件的高并发环境。

4. 读取文件

fs 模块提供了多种方式来读取文件。最常用的有两种：

使用 fs.readFile()（异步）

fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error('Error reading file:', err);
    return;
  }
  console.log(data);
});

使用 fs.readFileSync()（同步）

try {
  const data = fs.readFileSync('example.txt', 'utf8');
  console.log(data);
} catch (err) {
  console.error('Error reading file:', err);
}

5. 写入文件

Node.js 提供了 fs.writeFile() 和 fs.writeFileSync() 用于写入文件。

使用 fs.writeFile()（异步）

fs.writeFile('output.txt', 'Hello, Node.js!', (err) => {
  if (err) {
    console.error('Error writing file:', err);
    return;
  }
  console.log('File has been written!');
});

使用 fs.writeFileSync()（同步）

try {
  fs.writeFileSync('output.txt', 'Hello, Node.js!');
  console.log('File has been written!');
} catch (err) {
  console.error('Error writing file:', err);
}

6. 删除文件与重命名文件

删除文件

fs.unlink() 和 fs.unlinkSync() 用于删除文件。

fs.unlink('output.txt', (err) => {
  if (err) throw err;
  console.log('File deleted');
});

重命名文件

fs.rename() 和 fs.renameSync() 用于重命名文件或目录。

fs.rename('oldname.txt', 'newname.txt', (err) => {
  if (err) throw err;
  console.log('File renamed');
});

7. 文件夹操作：创建与删除目录

Node.js 中创建和删除目录的 API 也非常简单。

创建目录

fs.mkdir('newDir', { recursive: true }, (err) => {
  if (err) throw err;
  console.log('Directory created');
});

删除目录

fs.rmdir('oldDir', (err) => {
  if (err) throw err;
  console.log('Directory removed');
});

如果目录不为空，使用 rmdir 删除会抛出错误。为了递归删除所有文件和子目录，可以使用 rimraf 等第三方库。

8. 文件路径与权限管理

检查文件或目录是否存在

fs.exists('example.txt', (exists) => {
  console.log(exists ? 'File exists' : 'File does not exist');
});

改变文件权限

使用 fs.chmod() 和 fs.chmodSync() 修改文件权限：

fs.chmod('example.txt', 0o755, (err) => {
  if (err) throw err;
  console.log('File permissions changed');
});

9. 流式操作：文件读取与写入流

当处理大文件时，使用流（Stream）操作文件更加高效。fs.createReadStream() 和 fs.createWriteStream() 提供了流的方式来读取和写入文件。

创建读取流

const readStream = fs.createReadStream('largefile.txt', 'utf8');
readStream.on('data', (chunk) => {
  console.log('Received chunk:', chunk);
});

创建写入流

const writeStream = fs.createWriteStream('output.txt');
writeStream.write('Hello, world!');
writeStream.end();

10. 常见问题与最佳实践

异常处理

在进行文件操作时，始终要处理错误，以避免应用崩溃。最好在异步操作的回调函数中使用错误处理逻辑，或者在同步操作中使用 try...catch。

性能优化

• 对于大文件操作，使用流（Stream）是最有效的方式，避免一次性加载整个文件到内存。
• 使用异步 API 来处理文件操作，以防止阻塞事件循环。

11. 总结

fs 模块是 Node.js 中非常重要的模块，它提供了对文件系统的多种操作接口。通过掌握 fs 模块的基本用法，你可以轻松地进行文件读写、删除、重命名、目录操作等任务。在实践中，尽量使用异步 API 来提升性能，并善于使用流来处理大文件。希望本文能帮助你深入理解 fs 模块，并在实际开发中灵活运用这些操作。