您在 Node 中如何使用文件系统?

Question

您在 Node 中如何使用文件系统?

Accepted Answer

内置的 **`fs`** 模块读取和写入文件和目录。它提供三种 API 风格 — **promises**（现代，推荐）、**callbacks**（原始异步）和 **sync**（阻塞）— 因此您可以为情况选择正确的。

## Promise API（推荐）

```js
import { readFile, writeFile, mkdir, readdir } from "fs/promises";

async function work() {
  const data = await readFile("input.txt", "utf8");     // read (utf8 → string)
  await writeFile("output.txt", "Hello");                // write (overwrites)
  await mkdir("new-dir", { recursive: true });           // create dirs (recursive = mkdir -p)
  const files = await readdir("./");                      // list directory contents
}
```

`fs/promises` API 与 async/await 配合干净利落 — 文件 I/O 的现代标准。

## Callback 和 sync 变体

```js
import fs from "fs";

fs.readFile("file.txt", "utf8", (err, data) => { ... }); // async callback
const data = fs.readFileSync("file.txt", "utf8");         // SYNC — blocks the event loop!
```

**注意:** `*Sync` 方法**阻止整个事件循环**直到操作完成。它们在启动时（加载配置一次）很好，但应避免在请求处理程序中使用 — 阻塞读取会冻结所有并发请求。

## 常见操作

```js
await fs.promises.appendFile("log.txt", "new line
"); // append
await fs.promises.unlink("old.txt");                    // delete a file
await fs.promises.rename("a.txt", "b.txt");             // rename/move
const stats = await fs.promises.stat("file.txt");       // metadata (size, mtime)
const exists = fs.existsSync("file.txt");               // check existence
```

## 对于大文件：使用流

```js
// ❌ readFile loads the WHOLE file into memory — bad for huge files
const huge = await readFile("10gb.txt"); // could exhaust memory

// ✅ stream it in chunks (constant memory)
fs.createReadStream("10gb.txt").pipe(fs.createWriteStream("copy.txt"));
```

对于大文件，`readFile` 一次性将所有内容加载到内存中；**流**以恒定内存按块处理数据。

## 为什么这很重要

文件 I/O 是 Node 的核心功能，用于配置加载、日志记录、文件上传/下载和工具。

了解三种 API 风格 — 最重要的是，**sync 方法阻止事件循环**（避免在服务器中使用它们）并且**大文件需要流**（而不是 `readFile`）— 对于编写既正确又在并发下高性能的文件处理代码至关重要。

带 async/await 的 Promise API 是日常使用的干净默认值。