fs模块: Node.js 文件系统操作指南

前端

2023-12-12 11:37:51

Node.js 的文件系统 (fs) 模块：与文件系统交互

简介

Node.js 的 fs（文件系统）模块提供了一套丰富的 API，使我们能够轻松地与文件系统进行交互。在本指南中，我们将深入探讨 fs 模块，学习如何在 Node.js 应用程序中使用它来执行各种文件操作。

安装 fs 模块

fs 模块是 Node.js 的核心模块，因此无需单独安装。

文件操作

读取文件

要读取文件，我们可以使用 fs.readFile 方法。此方法需要以下参数：

文件路径（字符串）
字符编码（可选，默认为 UTF-8）
回调函数

fs.readFile('./data.txt', 'utf8', (err, data) => {
  if (err) {
    console.error('读取文件失败:', err);
  } else {
    console.log('读取文件成功:', data);
  }
});

写入文件

要写入文件，我们可以使用 fs.writeFile 方法。此方法需要以下参数：

文件路径（字符串）
写入文件的内容（字符串或缓冲区）
回调函数

fs.writeFile('./data.txt', '新的文件内容', (err) => {
  if (err) {
    console.error('写入文件失败:', err);
  } else {
    console.log('写入文件成功');
  }
});

创建目录

要创建目录，我们可以使用 fs.mkdir 方法。此方法需要以下参数：

目录路径（字符串）
回调函数

fs.mkdir('./new_directory', (err) => {
  if (err) {
    console.error('创建目录失败:', err);
  } else {
    console.log('创建目录成功');
  }
});

删除文件

要删除文件，我们可以使用 fs.unlink 方法。此方法需要以下参数：

文件路径（字符串）
回调函数

fs.unlink('./data.txt', (err) => {
  if (err) {
    console.error('删除文件失败:', err);
  } else {
    console.log('删除文件成功');
  }
});

重命名文件

要重命名文件，我们可以使用 fs.rename 方法。此方法需要以下参数：

旧文件路径（字符串）
新文件路径（字符串）
回调函数

fs.rename('./old_file.txt', './new_file.txt', (err) => {
  if (err) {
    console.error('重命名文件失败:', err);
  } else {
    console.log('重命名文件成功');
  }
});

高级用法

除了基本的文件操作外，fs 模块还提供了更高级的功能，包括：

流文件操作： 使用流读取和写入文件，实现更好的内存管理和性能优化。
异步文件操作： 使用 Promise 或回调函数实现异步文件操作，提高代码的可读性和并发性。
监视文件更改： 使用 fs.watch 或 fs.watchFile 方法监视文件或目录的更改，并相应地采取措施。

有关高级用法的更多信息，请参阅 Node.js 文档。

常见问题解答

如何读取文件的内容并将其保存到变量中？

const data = fs.readFileSync('./data.txt', 'utf8');

如何写入一个包含 JSON 数据的对象到文件中？

const data = { name: 'John Doe', age: 30 };
fs.writeFileSync('./data.json', JSON.stringify(data));

fs.mkdir('./directory1/directory2', { recursive: true }, (err) => {});

如何检查文件是否存在？

fs.exists('./data.txt', (exists) => {
  if (exists) {
    // 文件存在
  }
});

如何获取文件的统计信息（例如大小、修改日期等）？

fs.stat('./data.txt', (err, stats) => {
  if (err) {
    console.error('获取文件统计信息失败:', err);
  } else {
    console.log('文件大小：', stats.size);
    console.log('文件修改日期：', stats.mtime);
  }
});

结论

Node.js 的 fs 模块是一个强大的工具，使我们能够轻松高效地与文件系统进行交互。通过掌握 fs 模块的各种 API，我们可以构建各种与文件相关的功能，包括数据存储、日志记录和文件管理。本指南提供了对 fs 模块的基础知识的全面概述，并通过示例和高级技巧指导您进行文件操作。通过利用 fs 模块的力量，您可以创建更加健壮且功能丰富的 Node.js 应用程序。