fs-读取文件内容

目录

1. fs 模块简介

2. 示例一：异步读取文件内容

文件说明

文件：sample.txt

文件：readFile.js

运行步骤及结果

3. 示例二：同步读取文件内容

文件说明

文件：readFileSync.js

运行步骤及结果

4. 小结

---

下面提供一个详细的教程，介绍如何使用 Node.js 的 fs 模块读取文件内容，包含同步与异步两种方式。文章中会详细标注文件名和代码类型（如 JavaScript 文件、文本文件等），便于你直接复制使用并验证运行效果。

---

1. fs 模块简介

Node.js 内置的 fs（File System）模块 提供了与文件系统交互的方法。通过 fs 模块，你可以读取、写入、更新和删除文件。本教程主要介绍如何读取文件内容，演示异步和同步两种读取方式。

---

2. 示例一：异步读取文件内容

文件说明

• sample.txt
  类型：文本文件（.txt）
  内容：存放测试文本数据。

• readFile.js
  类型：JavaScript 文件（Node.js 程序）
  功能：使用 fs.readFile() 异步读取 sample.txt 的内容，并在控制台输出。

文件：sample.txt

请创建一个名为 sample.txt 的文本文件，内容如下：

这是一个测试文件。
这里包含一些示例文本，用于演示 Node.js fs 模块的异步读取功能。

文件：readFile.js

创建 readFile.js 文件，并复制以下代码：

// readFile.js (JavaScript 文件)
// 使用 Node.js fs 模块异步读取文件内容

// 引入 fs 模块
const fs = require('fs');

// 定义要读取的文件路径
const filePath = 'sample.txt';

// 异步读取文件内容，指定编码为 utf8
fs.readFile(filePath, 'utf8', (err, data) => {
  if (err) {
    // 如果读取文件出错，则输出错误信息
    console.error('读取文件出错：', err);
    return;
  }
  // 输出读取到的文件内容
  console.log('文件内容如下：\n', data);
});

运行步骤及结果

1. 确保 sample.txt 和 readFile.js 文件位于同一目录下。
2. 打开命令行（或终端），进入该目录。
3. 执行以下命令启动程序：

   node readFile.js
   

4. 运行后，在控制台中会输出类似如下内容：

   文件内容如下：
   这是一个测试文件。
   这里包含一些示例文本，用于演示 Node.js fs 模块的异步读取功能。
   

---

3. 示例二：同步读取文件内容

文件说明

• sample.txt
  同上。

• readFileSync.js
  类型：JavaScript 文件
  功能：使用 fs.readFileSync() 同步读取 sample.txt 的内容，并在控制台输出。

文件：readFileSync.js

创建 readFileSync.js 文件，并复制以下代码：

// readFileSync.js (JavaScript 文件)
// 使用 Node.js fs 模块同步读取文件内容

// 引入 fs 模块
const fs = require('fs');

// 定义要读取的文件路径
const filePath = 'sample.txt';

try {
  // 同步读取文件内容，指定编码为 utf8
  const data = fs.readFileSync(filePath, 'utf8');
  console.log('文件内容如下：\n', data);
} catch (err) {
  // 捕获并输出可能出现的错误
  console.error('读取文件出错：', err);
}

运行步骤及结果

1. 确保 sample.txt 和 readFileSync.js 文件位于同一目录下。
2. 打开命令行（或终端），进入该目录。
3. 执行以下命令启动程序：

   node readFileSync.js
   

4. 运行后，在控制台中会输出类似如下内容：

   文件内容如下：
   这是一个测试文件。
   这里包含一些示例文本，用于演示 Node.js fs 模块的异步读取功能。
   

---

4. 小结

• 异步读取（fs.readFile）：
  优点是不会阻塞主线程，适用于需要同时处理多个任务的场景。缺点是需要通过回调函数处理结果。

• 同步读取（fs.readFileSync）：
  代码逻辑简单，但会阻塞主线程，适合在启动时读取配置信息或在脚本中进行简单读取操作。

通过以上示例，你可以直观地了解如何使用 Node.js 的 fs 模块读取文件内容，并选择合适的方式应用于实际项目。希望这份详细教程能帮助你更深入地理解和掌握 Node.js 文件操作。