在 Node.js 中，fs 模块提供了异步读取文件的方法（如 fs.readFile），默认是基于回调函数的。为了更方便地使用，我们可以将其封装为返回 Promise 或使用 async/await 的形式。以下是几种常见的封装方式：

一、常见处理方式

1. 使用 util.promisify 封装

Node.js 内置的 util.promisify 工具可以直接将基于回调的函数转换为返回 Promise 的函数。

示例：

const fs = require("fs");
const util = require("util");

// 将 fs.readFile 转换为 Promise 版本
const readFileAsync = util.promisify(fs.readFile);

// 使用
async function readFile() {
  try {
    const data = await readFileAsync("file.txt", "utf8");
    console.log("File content:", data);
  } catch (err) {
    console.error("Error reading file:", err);
  }
}

readFile();

优点：

• 简单直接，无需手动封装。
• 适用于所有符合 Node.js 回调风格的函数。

2. 手动封装为 Promise

如果不依赖 util.promisify，可以手动将 fs.readFile 封装为返回 Promise 的函数。

示例：

const fs = require("fs");

function readFileAsync(path, encoding) {
  return new Promise((resolve, reject) => {
    fs.readFile(path, encoding, (err, data) => {
      if (err) {
        reject(err);
      } else {
        resolve(data);
      }
    });
  });
}

// 使用
async function readFile() {
  try {
    const data = await readFileAsync("file.txt", "utf8");
    console.log("File content:", data);
  } catch (err) {
    console.error("Error reading file:", err);
  }
}

readFile();

优点：

• 完全控制 Promise 的逻辑。
• 适用于需要自定义封装的场景。

3. 直接使用 fs.promises

Node.js 从 v10.0.0 开始，fs 模块提供了基于 Promise 的 API（fs.promises），可以直接使用。

示例：

const fs = require("fs").promises;

async function readFile() {
  try {
    const data = await fs.readFile("file.txt", "utf8");
    console.log("File content:", data);
  } catch (err) {
    console.error("Error reading file:", err);
  }
}

readFile();

优点：

• 官方支持，无需额外封装。
• 代码更简洁。

4. 封装为通用工具函数

如果需要频繁读取文件，可以将其封装为一个通用的工具函数。

示例：

const fs = require("fs").promises;

async function readFile(path, encoding = "utf8") {
  try {
    const data = await fs.readFile(path, encoding);
    return data;
  } catch (err) {
    console.error(`Error reading file ${path}:`, err);
    throw err; // 抛出错误以便外部处理
  }
}

// 使用
(async () => {
  try {
    const content = await readFile("file.txt");
    console.log("File content:", content);
  } catch (err) {
    console.error("Failed to read file:", err);
  }
})();

优点：

• 可复用性高。
• 统一错误处理逻辑。

5. 使用事件触发器（EventEmitter）

如果需要更复杂的异步逻辑，可以使用事件触发器封装。

示例：

const fs = require("fs");
const EventEmitter = require("events");

class FileReader extends EventEmitter {
  readFile(path, encoding = "utf8") {
    fs.readFile(path, encoding, (err, data) => {
      if (err) {
        this.emit("error", err);
      } else {
        this.emit("data", data);
      }
    });
  }
}

// 使用
const reader = new FileReader();

reader.on("data", (data) => {
  console.log("File content:", data);
});

reader.on("error", (err) => {
  console.error("Error reading file:", err);
});

reader.readFile("file.txt");

适用场景：

• 需要处理多个异步事件的场景。
• 例如同时读取多个文件。

二、总结

封装方式	优点	适用场景
util.promisify	简单直接，无需手动封装	快速将回调函数转为 Promise
手动封装为 Promise	完全控制逻辑，灵活性强	需要自定义封装的场景
fs.promises	官方支持，代码简洁	Node.js v10.0.0 及以上版本
通用工具函数	可复用性高，统一错误处理	需要频繁读取文件的场景
事件触发器	适合复杂异步逻辑，支持多事件监听	需要处理多个异步事件的场景

根据具体需求选择合适的封装方式。对于大多数场景，推荐使用 fs.promises 或 util.promisify，因为它们简单且高效。

更新日志

2025/8/24 08:17

查看所有更新日志

• e7112-1于 2025/8/24