Node.js 文件操作：读取与写入文件

---

Node.js 文件操作：读取与写入文件 🚀📂

在 Web 开发和服务器端编程中，处理文件是非常常见的任务。Node.js 提供了丰富的文件系统模块（fs），使得我们可以轻松地进行文件的读取、写入、删除等操作。本文将详细讲解如何在 Node.js 中读取和写入文件，包括同步和异步两种方式，并提供实际的代码示例。

---

一、Node.js 文件系统模块（fs）

Node.js 中的 fs 模块提供了对文件系统的访问能力，可以让我们读取、写入、更新文件内容，甚至修改文件权限。fs 模块有两种主要的文件操作方式：同步 和 异步。

• 同步操作：代码会阻塞，直到文件操作完成。适用于简单的脚本或小规模应用。
• 异步操作：代码不会阻塞，文件操作完成后通过回调函数返回结果。适用于大多数生产环境中的文件操作。

二、读取文件的操作 📖

1. 异步读取文件

使用 fs.readFile() 方法可以异步地读取文件内容。该方法的第一个参数是文件路径，第二个参数是文件的编码格式（如果不指定编码格式，返回的是原始的二进制数据）。回调函数的第一个参数是错误对象（如果出错），第二个参数是文件内容。

const fs = require('fs');

// 异步读取文件
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error('读取文件失败:', err);
    return;
  }
  console.log('文件内容:', data);
});

在这个例子中，example.txt 文件的内容将以 utf8 编码格式读取并打印到控制台。如果发生错误（如文件不存在），err 对象将会捕获错误信息。

2. 同步读取文件

如果你想要阻塞代码执行直到文件读取完成，可以使用 fs.readFileSync() 方法。这个方法会同步读取文件并返回文件的内容。

const fs = require('fs');

// 同步读取文件
try {
  const data = fs.readFileSync('example.txt', 'utf8');
  console.log('文件内容:', data);
} catch (err) {
  console.error('读取文件失败:', err);
}

注意：同步方法会阻塞主线程，因此在处理大文件或高并发请求时，最好使用异步方法。

三、写入文件的操作 ✍️

1. 异步写入文件

使用 fs.writeFile() 方法可以异步地将数据写入到指定文件。如果文件不存在，fs.writeFile() 会自动创建一个新文件。如果文件已存在，它将覆盖原有的内容。

const fs = require('fs');

// 异步写入文件
const content = '这是写入到文件中的内容！';

fs.writeFile('output.txt', content, 'utf8', (err) => {
  if (err) {
    console.error('写入文件失败:', err);
    return;
  }
  console.log('文件已成功写入！');
});

在这个例子中，output.txt 文件将被写入 content 变量的内容。如果文件已经存在，它的内容会被覆盖。

2. 同步写入文件

fs.writeFileSync() 方法是同步版本的文件写入方法，类似于同步读取方法，会阻塞代码直到写入操作完成。

const fs = require('fs');

// 同步写入文件
const content = '这是同步写入到文件中的内容！';

try {
  fs.writeFileSync('output.txt', content, 'utf8');
  console.log('文件已成功写入！');
} catch (err) {
  console.error('写入文件失败:', err);
}

同步方法适用于那些不涉及并发的简单任务，确保在写入完成后才执行后续代码。

四、追加内容到文件 ✒️

有时候我们需要向一个已存在的文件中追加内容而不是覆盖它。可以使用 fs.appendFile() 或 fs.appendFileSync() 方法来实现。

1. 异步追加内容

const fs = require('fs');

// 异步追加内容
const content = '这是追加到文件中的内容！\n';

fs.appendFile('output.txt', content, 'utf8', (err) => {
  if (err) {
    console.error('追加内容失败:', err);
    return;
  }
  console.log('内容已成功追加！');
});

2. 同步追加内容

const fs = require('fs');

// 同步追加内容
const content = '这是同步追加到文件中的内容！\n';

try {
  fs.appendFileSync('output.txt', content, 'utf8');
  console.log('内容已成功追加！');
} catch (err) {
  console.error('追加内容失败:', err);
}

五、读取文件状态 📊

我们还可以使用 fs.stat() 或 fs.statSync() 来获取文件的状态信息，比如文件大小、文件创建时间、文件权限等。

1. 异步获取文件状态

const fs = require('fs');

fs.stat('example.txt', (err, stats) => {
  if (err) {
    console.error('获取文件状态失败:', err);
    return;
  }
  console.log('文件状态:', stats);
});

2. 同步获取文件状态

const fs = require('fs');

try {
  const stats = fs.statSync('example.txt');
  console.log('文件状态:', stats);
} catch (err) {
  console.error('获取文件状态失败:', err);
}

stats 对象包含了文件的详细信息，比如文件的大小（stats.size），文件是否是目录（stats.isDirectory()）等。

六、删除文件 🗑️

有时候我们可能需要删除文件，Node.js 提供了 fs.unlink()（异步）和 fs.unlinkSync()（同步）来删除文件。

1. 异步删除文件

const fs = require('fs');

// 异步删除文件
fs.unlink('output.txt', (err) => {
  if (err) {
    console.error('删除文件失败:', err);
    return;
  }
  console.log('文件已成功删除！');
});

2. 同步删除文件

const fs = require('fs');

// 同步删除文件
try {
  fs.unlinkSync('output.txt');
  console.log('文件已成功删除！');
} catch (err) {
  console.error('删除文件失败:', err);
}

---

七、总结 📝

在 Node.js 中，文件操作是非常常见的需求，fs 模块提供了丰富的 API 来实现文件的读取、写入、删除等操作。通过选择合适的同步或异步方法，我们可以高效地完成文件操作。

• 异步方法：适用于大多数生产环境中，避免阻塞主线程，提高应用性能。
• 同步方法：适用于简单的脚本或处理较小文件的场景，确保操作顺序执行。
• 文件操作方法：
  • fs.readFile() / fs.readFileSync()：读取文件
  • fs.writeFile() / fs.writeFileSync()：写入文件
  • fs.appendFile() / fs.appendFileSync()：追加文件内容
  • fs.stat() / fs.statSync()：获取文件状态
  • fs.unlink() / fs.unlinkSync()：删除文件

掌握这些文件操作技巧，可以让你在 Node.js 中轻松处理文件相关的任务。