Node.js 之 fs 模块深入解析与实践

在 Node.js 的生态系统中，fs模块（文件系统模块）犹如一把瑞士军刀，承担着与文件系统进行交互的重任。无论是读取文件内容、写入新数据，还是创建目录、删除文件等操作，fs模块都能提供简洁高效的解决方案，使开发者能够轻松驾驭服务器端的文件管理工作。

fs 模块概述

fs模块是 Node.js 内置模块，无需额外安装即可直接使用。它提供了一系列的方法来处理文件和目录，这些方法分为同步和异步两种形式。异步方法以非阻塞的方式执行，这意味着在执行文件操作时，Node.js 不会等待操作完成，而是继续执行后续代码，大大提高了应用程序的性能和响应能力，特别适用于处理 I/O 密集型任务。同步方法则会阻塞程序的执行，直到操作完成，一般在对性能要求不高且需要确保操作顺序的场景中使用。

核心 API 详解

读取文件

流式读取：fs.createReadStream方法在处理大文件时非常高效，它以流的形式逐块读取文件，避免一次性将整个文件加载到内存中。语法为fs.createReadStream(path[, options])，path是文件路径，options可配置读取的缓冲区大小、编码等。通过监听data事件来处理读取的数据块，end事件表示文件读取结束。

js 复制代码

const fs = require('fs');
const readableStream = fs.createReadStream('largeFile.txt', { encoding: 'utf8' });
readableStream.on('data', (chunk) => {
    console.log('Received a chunk:', chunk.length);
});
readableStream.on('end', () => {
    console.log('File reading completed');
});

读取文件描述符：fs.read方法使用文件描述符进行读取操作，更为底层和灵活。先通过fs.open获取文件描述符，再使用fs.read读取。语法为fs.read(fd, buffer, offset, length, position, callback)，fd是文件描述符，buffer是存储读取数据的缓冲区，offset是缓冲区写入偏移量，length是读取的字节数，position是文件读取位置（null表示从当前位置读取），callback包含err和读取的字节数。

js 复制代码

const fs = require('fs');
fs.open('example.txt', 'r', (err, fd) => {
    if (err) {
        console.error(err);
        return;
    }
    const buffer = Buffer.alloc(1024);
    fs.read(fd, buffer, 0, 1024, null, (err, bytesRead) => {
        if (err) {
            console.error(err);
        } else {
            const data = buffer.toString('utf8', 0, bytesRead);
            console.log('Read data:', data);
        }
        fs.close(fd, (err) => {
            if (err) {
                console.error(err);
            }
        });
    });
});

写入文件

流式写入：fs.createWriteStream用于以流的方式写入文件，适用于写入大量数据。语法为fs.createWriteStream(path[, options])。可以通过write方法写入数据块，并在写入完成后调用end方法。

js 复制代码

const fs = require('fs');
const writableStream = fs.createWriteStream('newData.txt');
const dataChunks = ['First chunk', 'Second chunk', 'Third chunk'];
dataChunks.forEach((chunk) => {
    writableStream.write(chunk);
});
writableStream.end();
writableStream.on('finish', () => {
    console.log('All data written successfully');
});

追加写入：fs.appendFile方法可在文件末尾追加内容。语法为fs.appendFile(file, data[, options], callback)，file是目标文件，data是追加的数据，options可选，callback在追加完成后执行。

js 复制代码

const fs = require('fs');
const newContent = '\nThis is appended data';
fs.appendFile('existingFile.txt', newContent, (err) => {
    if (err) {
        console.error(err);
    } else {
        console.log('Data appended successfully');
    }
});

目录操作

读取目录内容并过滤：fs.readdir结合数据过滤操作，能更精准地获取所需文件或目录。fs.readdir异步读取目录内容，语法为fs.readdir(path[, options], callback)。在回调函数中对读取的文件列表进行过滤。

js 复制代码

const fs = require('fs');
fs.readdir('.', (err, files) => {
    if (err) {
        console.error(err);
        return;
    }
    const jsFiles = files.filter(file => file.endsWith('.js'));
    console.log('JavaScript files:', jsFiles);
});

递归创建目录：fs.mkdirSync在创建多级目录时，若父目录不存在会报错。使用自定义递归函数结合fs.mkdirSync可实现递归创建。

js 复制代码

const fs = require('fs');
function recursiveMkdirSync(dirPath) {
    try {
        fs.mkdirSync(dirPath);
    } catch (err) {
        if (err.code === 'ENOENT') {
            recursiveMkdirSync(path.dirname(dirPath));
            fs.mkdirSync(dirPath);
        } else {
            throw err;
        }
    }
}
const newDir = 'parent/child/grandchild';
recursiveMkdirSync(newDir);

综合示例：构建增强型文件处理器

下面通过一个综合示例展示fs模块在数据处理方面更复杂的应用，我们将创建一个工具，能够读取特定目录下的所有文本文件，将文件内容合并并写入到一个新文件中，同时记录处理的文件数量。

js 复制代码

const fs = require('fs');
const path = require('path');
// 读取指定目录下的所有文本文件内容
function readTextFilesInDir(dir) {
    return new Promise((resolve, reject) => {
        fs.readdir(dir, (err, files) => {
            if (err) {
                reject(err);
                return;
            }
            const textFiles = files.filter(file => file.endsWith('.txt'));
            const promises = textFiles.map(file => {
                const filePath = path.join(dir, file);
                return new Promise((resolve, reject) => {
                    fs.readFile(filePath, 'utf8', (err, data) => {
                        if (err) {
                            reject(err);
                        } else {
                            resolve(data);
                        }
                    });
                });
            });
            Promise.all(promises).then(dataArray => {
                resolve(dataArray.join('\n'));
            }).catch(err => {
                reject(err);
            });
        });
    });
}
// 将合并后的内容写入新文件
function writeMergedDataToFile(data, outputFile) {
    return new Promise((resolve, reject) => {
        fs.writeFile(outputFile, data, err => {
            if (err) {
                reject(err);
            } else {
                resolve();
            }
        });
    });
}
// 主处理流程
async function processFiles() {
    try {
        const mergedData = await readTextFilesInDir('.');
        await writeMergedDataToFile(mergedData,'mergedOutput.txt');
        console.log('Files processed and merged successfully');
    } catch (err) {
        console.error(err);
    }
}
processFiles();

在这个示例中，readTextFilesInDir函数读取指定目录下的所有文本文件内容，并通过Promise.all将读取操作并行化。writeMergedDataToFile函数将合并后的内容写入新文件。通过async/await语法，使异步操作的流程更加清晰易读。

通过对 Node.js 中fs模块这些数据处理相关 API 的深入学习，从高效的流式读写到灵活的目录操作，再到复杂场景下的综合应用，我们能够更全面、更强大地操作文件系统，为构建高性能、功能丰富的服务器端应用程序提供有力支持。无论是日常的数据处理脚本，还是大型项目中的文件管理模块，fs模块都将持续发挥重要作用。