Node.js 读取文件

Node.js 提供了一个名为 fs 的模块，用于处理文件系统操作。本章将详细介绍如何使用 fs 模块来读取文件。

异步读取文件

fs.readFile()

fs.readFile() 方法允许异步读取文件内容。这种方法非常适合处理大文件或需要快速响应的场景，因为它不会阻塞事件循环。

示例代码

// www.javascriptcn.com code example
const fs = require('fs');

fs.readFile('./example.txt', 'utf8', (err, data) => {
    if (err) {
        console.error('读取文件时发生错误:', err);
        return;
    }
    console.log('文件内容:', data);
});

参数说明

• path: 要读取的文件路径。
• encoding: 可选参数，指定文件的编码格式，默认为 'utf8'。
• callback: 回调函数，接受两个参数：err 和 data。err 是错误对象，data 包含文件内容。

fs.readFileSync()

如果你更喜欢同步的方式，可以使用 fs.readFileSync() 方法。不过需要注意的是，这种做法可能会阻塞事件循环，因此不适合长时间运行的操作。

示例代码

const fs = require('fs');

try {
    const data = fs.readFileSync('./example.txt', 'utf8');
    console.log('文件内容:', data);
} catch (err) {
    console.error('读取文件时发生错误:', err);
}

参数说明

• path: 要读取的文件路径。
• encoding: 可选参数，指定文件的编码格式，默认为 'utf8'。

使用流读取文件

除了以上两种方法，还可以使用流来读取文件。这种方式适用于处理大文件或者需要逐行处理文件内容的情况。

fs.createReadStream()

fs.createReadStream() 创建一个可读流，通过监听数据事件来逐块读取文件内容。

示例代码

// www.javascriptcn.com code example
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);
});

参数说明

• path: 要读取的文件路径。
• options: 可选参数，包含各种选项如 flags, encoding, fd, mode, autoClose, start, end 等。

高级选项与配置

文件读取的高级选项

在实际应用中，可能需要一些额外的配置来优化文件读取过程。例如，你可以设置文件的起始位置和结束位置来读取部分内容。

示例代码

// www.javascriptcn.com code example
const fs = require('fs');

// 从第10个字节开始读取，最多读取100个字节
const readStream = fs.createReadStream('./example.txt', { start: 10, end: 109 });

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

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

readStream.on('error', (err) => {
    console.error('读取文件时发生错误:', err);
});

处理大文件

对于非常大的文件，使用流式读取是最佳选择。这样可以避免一次性加载整个文件到内存中，从而提高性能并减少资源消耗。

示例代码

// www.javascriptcn.com code example
const fs = require('fs');
const zlib = require('zlib'); // 用于压缩文件

const readStream = fs.createReadStream('./largefile.zip');
const unzipStream = zlib.createGunzip();

readStream.pipe(unzipStream);

unzipStream.on('data', (chunk) => {
    console.log('解压后数据:', chunk);
});

unzipStream.on('end', () => {
    console.log('文件解压完成');
});

unzipStream.on('error', (err) => {
    console.error('解压文件时发生错误:', err);
});

通过这些示例和解释，你应该对如何使用 Node.js 的 fs 模块来读取文件有了深入的理解。无论是异步读取、同步读取还是使用流进行读取，都有多种方式可供选择，可以根据具体需求进行灵活运用。