插件窝干货文章文件系统：Nodejs `fs` 模块

文件系统：Nodejs `fs` 模块

文件 class console div 494 来源： 2024-10-21

node.js 中的 fs（文件系统）模块是一个用于处理文件系统的强大工具，允许您与服务器上的文件和目录进行交互。它内置于 node.js 中，因此您无需安装任何额外的东西即可使用它。让我们来探讨一下 fs 的工作原理及其关键功能。

1.什么是fs模块？

fs 模块提供了一个 api，用于以紧密围绕标准 posix 函数建模的方式与文件系统进行交互。该模块用于读取和写入文件、创建目录等任务。

2. 基本设置

要使用 fs 模块，您需要在 node.js 脚本的开头引入它：

const fs = require('fs');

3. 读取文件

读取文件主要有两种方式：异步和同步。

异步读取

此方法是非阻塞的，这意味着它在读取文件时不会停止程序的执行。

fs.readfile('example.txt', 'utf8', (err, data) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log(data);
});

'example.txt'：您要读取的文件。
'utf8'：指定要使用的编码。
回调函数：处理错误和文件数据。

同步读取

此方法是阻塞的，这意味着它将停止执行程序，直到读取文件。

try {
    const data = fs.readfilesync('example.txt', 'utf8');
    console.log(data);
} catch (err) {
    console.error(err);
}

4. 写入文件

与读取文件类似，写入也可以异步或同步进行。

异步写入

fs.writefile('example.txt', 'hello, world!', (err) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('file has been saved!');
});

同步写入

try {
    fs.writefilesync('example.txt', 'hello, world!');
    console.log('file has been saved!');
} catch (err) {
    console.error(err);
}

5. 附加到文件

如果你想向现有文件添加内容而不覆盖它，请使用appendfile方法。

异步追加

fs.appendfile('example.txt', '\nappended content', (err) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('content has been appended!');
});

同步追加

try {
    fs.appendfilesync('example.txt', '\nappended content');
    console.log('content has been appended!');
} catch (err) {
    console.error(err);
}

6. 删除文件

要删除文件，请使用 unlink 方法。

异步删除

fs.unlink('example.txt', (err) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('file deleted!');
});

同步删除

try {
    fs.unlinksync('example.txt');
    console.log('file deleted!');
} catch (err) {
    console.error(err);
}

7. 使用目录

创建目录

fs.mkdir('newdir', { recursive: true }, (err) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('directory created!');
});

读取目录

fs.readdir('newdir', (err, files) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('files in directory:', files);
});

删除目录

fs.rmdir('newdir', { recursive: true }, (err) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('directory deleted!');
});

8.查看文件

您可以使用 fs.watch 方法监视文件中的更改：

fs.watch('example.txt', (eventtype, filename) =&gt; {
    if (filename) {
        console.log(`${filename} file changed!`);
    }
});

9. 使用流

node.js 提供了 fs 流来处理可能无法放入内存的大文件。

使用流阅读

const readstream = fs.createreadstream('example.txt', 'utf8');
readstream.on('data', (chunk) =&gt; {
    console.log(chunk);
});

用流写作

const writestream = fs.createwritestream('example.txt');
writestream.write('hello, ');
writestream.write('world!');
writestream.end();

10. 复制文件

node.js 提供了一种简单的复制文件的方法：

fs.copyfile('source.txt', 'destination.txt', (err) =&gt; {
    if (err) {
        console.error(err);
        return;
    }
    console.log('file copied successfully!');
});

11.承诺的fs

fs 模块还具有基于 promise 的方法，可以更轻松地使用 async/await 等现代 javascript 功能。

const fsPromises = require('fs').promises;

async function readFile() {
    try {
        const data = await fsPromises.readFile('example.txt', 'utf8');
        console.log(data);
    } catch (err) {
        console.error(err);
    }
}

readFile();

12. 实际用例

配置文件：读取或写入配置文件（例如 json 文件）以存储设置。
日志文件：附加到日志文件以跟踪应用程序事件。
文件上传：存储和检索上传的文件。
数据处理：使用流高效地读取、处理和写入大型数据集。

13. 错误处理和最佳实践

始终处理回调函数中的错误或使用带有同步代码的 try-catch 块。
大多数情况下使用异步方法可以获得更好的性能。
考虑使用 fs.promises 来获得更干净、更现代的代码。
谨慎使用同步方法，因为它们可能会阻塞事件循环。
使用 fs.constants 作为文件系统标志（例如，fs.constants.o_rdonly 用于只读访问）。

14. 安全考虑

验证和清理文件路径以防止目录遍历攻击。
使用用户提供的文件名或路径时要小心。
创建或修改文件和目录时使用适当的文件权限。

15. 结论

fs 模块用途广泛，对于任何需要与文件系统交互的 node.js 应用程序来说都是必不可少的。通过了解其各种方法、有效处理流并采用最佳实践，您将能够有效、安全地管理 node.js 中的文件操作。

记得查阅 node.js 官方文档，了解 fs 模块的最新信息和附加功能。

上一篇：#daysofMiva 编码挑战日：将 JavaScript 链接到 HTML 文件

下一篇：Algolia 与 Elasticsearch：选择正确的搜索解决方案