Nodejs实现读写文件和文件流

在Nodejs中，文件操作是非常常见的任务之一。它允许我们读取和写入文件，以及处理大型文件而不会消耗太多内存。本篇博文将会首先介绍一下文件和文件流的区别，然后全面介绍如何在Nodejs中实现文件操作和读写，包括使用文件系统模块（fs）和文件流（streams）。

在讨论如何读取文件和文件流之前，我们先讨论一下文件和文件流的区别。

公众号：Code程序人生，个人网站：https://creatorblog.cn

文件和文件流的区别

文件

一个文件是一组有序的字节数据，存储在存储介质（如硬盘、SSD等）上，每个文件都有一个唯一的文件名和路径。文件可以是文本文件、图像文件、音频文件、视频文件等。

文件的读写操作通常涉及将整个文件的内容一次性加载到内存中，然后进行操作。在文件操作期间，可能会将整个文件加载到内存中，因此处理大型文件可能会导致内存消耗过高。

文件流

文件流是一种逐块处理文件数据的方式，它允许我们按块（或一小部分一小部分）读取或写入文件数据，而不需要将整个文件加载到内存中。这对于处理大型文件或需要逐步处理数据的情况非常有用，因为它能够降低内存消耗并提高性能。

文件流将文件数据分为多个数据块（或缓冲区），并以逐块的方式进行读取或写入。这种流式处理的方式使得可以在不等待整个文件读取或写入完成的情况下，逐步处理文件数据。

读写文件

读取

在Nodejs中，可以使用文件系统模块（fs）来读取文件。最常见的方式是通过fs.readFile()方法实现异步读取文件内容，fs也提供了同步读取文件的方法fs.readFileSync()，大家可以根据实际业务来自行使用对应的方法。

// example.txt
我是文件内容我是文件内容我是文件内容我是文件内容我是文件内容我是文件内容


// file.js
const fs = require('fs');

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

在上面的代码中，我们使用fs.readFile()方法异步地读取名为example.txt的文件。'utf8'参数指定编码格式，以便正确解析文本文件。

运行代码后，结果如下：

写入

要写入文件，我们可以使用fs.writeFile()方法。该方法用于异步地将数据写入文件。fs同样提供同步写入文件的方法fs.writeFileSync()。如果文件不存在，则会创建一个新文件；如果文件已经存在，则会覆盖其内容。

// file.js
const fs = require('fs');

const fileContent = '这是我准备写入的文件内容';

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

在上面的代码中，我们使用fs.writeFile()方法异步地将fileContent的内容写入名为output.txt的文件。

运行代码后，结果如下：

读写文件流

文件流是Nodejs中处理大型文件的一种有效方式。它们允许我们在读取或写入文件时，分块处理数据，避免将整个文件加载到内存中。

在Nodejs中，对于流式读取和写入文件，通常只提供异步的方法，而没有同步的方法。这是因为流操作通常涉及大量的数据处理，如果使用同步的方式，可能会阻塞主线程，导致应用性能下降。

读取

使用文件流进行文件读取的一种方法是使用fs.createReadStream()方法。这允许我们逐块读取文件数据。

// file.js
const fs = require('fs');

const readStream = fs.createReadStream('largefile.txt', 'utf8');

readStream.on('data', (chunk) => {
  console.log('接收到一块数据:', chunk);
});

readStream.on('end', () => {
  console.log('文件读取完成.');
});

readStream.on('error', (err) => {
  console.error('文件读取失败:', err);
});

largefile.txt文件内容如下：

在上面的代码中，我们使用fs.createReadStream()方法创建一个文件读取流，然后监听'data'事件来处理每个数据块，'end'事件表示文件读取结束，'error'事件处理可能出现的错误。

运行代码后，结果如下：

写入

类似地，可以使用fs.createWriteStream()方法创建文件写入流，将数据分块写入文件。

// file.js
const fs = require('fs');

const writeStream = fs.createWriteStream('output_large.txt', 'utf8');

writeStream.write('文件块1 1 ');
writeStream.write('文件块2 2 ');
writeStream.write('文件块3 3 ');

writeStream.end();

writeStream.on('finish', () => {
  console.log('写入文件结束.');
});

writeStream.on('error', (err) => {
  console.error('写入文件异常:', err);
});

在上面的代码中，我们使用fs.createWriteStream()方法创建一个文件写入流，并使用write()方法写入文件的不同数据块，最后通过调用end()方法来完成写入操作。'finish'事件表示文件写入完成，'error'事件处理可能出现的错误。

运行代码后，结果如下：

总结

本文全面介绍了如何在Nodejs中实现文件操作和读写，包括使用文件系统模块和文件流。文件操作是Nodejs中常见且重要的任务，希望本文提供的代码示例和解释能够帮助读者深入了解如何在Nodejs中处理文件操作，同时避免一些常见的错误。使用文件流可以有效地处理大型文件，避免内存溢出等问题，因此在处理大文件时，推荐使用文件流的方式。

记得在使用文件操作时，要考虑异常处理和错误处理，确保代码的健壮性和可靠性。