在当代 node.js 开发中，fspromises api 比传统的 fs 模块越来越受到青睐。这种偏好源于它与现代 javascript 功能的卓越集成，特别是 async/await，这增强了代码的可读性和可维护性，尤其是在复杂的场景中。
为什么 fspromises 是首选
1. 异步/等待兼容性
fspromises 与 async/await 无缝集成，允许以更同步、直观的方式构建异步代码。
const fs = require('fs').promises;
async function readandprocessfile() {
try {
const data = await fs.readfile('input.txt', 'utf8');
const processeddata = data.touppercase();
await fs.writefile('output.txt', processeddata);
console.log('file processed successfully');
} catch (err) {
console.error('error processing file:', err);
}
}
readandprocessfile();
2. 简化的错误处理
借助 async/await 和 fspromises，使用 try/catch 块、镜像同步代码结构，错误处理变得更加简单。
const fs = require('fs').promises;
async function copyfile(source, destination) {
try {
await fs.copyfile(source, destination);
console.log(`${source} was copied to ${destination}`);
} catch (err) {
console.error('error copying file:', err);
}
}
copyfile('source.txt', 'destination.txt');
3. 避免回调地狱
传统的 fs 方法依赖于回调，这在处理多个异步操作时可能会导致深度嵌套、难以阅读的代码。 fspromises 通过返回 promise 解决了这个问题，它可以通过 async/await 链接或管理。
// traditional fs (callback hell)
fs.readdir('directory', (err, files) => {
if (err) throw err;
files.foreach((file) => {
fs.readfile(`directory/${file}`, 'utf8', (err, content) => {
if (err) throw err;
fs.writefile(`processed/${file}`, content.touppercase(), (err) => {
if (err) throw err;
console.log(`processed ${file}`);
});
});
});
});
// using fspromises
const fs = require('fs').promises;
async function processdirectory() {
try {
const files = await fs.readdir('directory');
for (const file of files) {
const content = await fs.readfile(`directory/${file}`, 'utf8');
await fs.writefile(`processed/${file}`, content.touppercase());
console.log(`processed ${file}`);
}
} catch (err) {
console.error('error processing directory:', err);
}
}
processdirectory();
4. 提高代码一致性
利用 fspromises 可以提高代码库的一致性，特别是在广泛使用 promise 或 async/await 进行其他异步操作的项目中。
5. 某些场景下性能更好
虽然性能差异通常可以忽略不计，但 fspromises 可以在涉及多个异步操作的场景中提高代码执行效率，因为它避免了管理大量回调的开销。
fs 什么时候仍然相关？
尽管 fspromises 具有优势，但在某些情况下传统 fs 模块仍然适用：
旧代码库：尚未更新的旧项目可能仍然依赖基于回调的 fs 方法。
简单脚本：对于不需要额外抽象承诺的快速一次性脚本，fs 可能更简单。
具体的流式操作：一些高级的流式操作仍然主要通过传统的 fs 模块来支持。
性能关键的低级操作：在需要绝对最小开销的极少数情况下，传统的 fs 方法可能是首选。
与旧版 node.js 版本的兼容性：如果需要支持旧版 node.js 版本，传统的 fs 模块可确保更广泛的兼容性。
最佳实践
一致的 api 使用：为项目选择 fspromises 或 fs 并始终坚持使用以保持代码一致性。
错误处理：无论您使用哪个 api，始终实施正确的错误处理。
异步操作：优先选择异步方法而不是同步方法，以避免阻塞事件循环，特别是在服务器环境中。
promisification：如果需要使用传统的 fs 模块，可以考虑使用 util.promisify() 将基于回调的方法转换为基于 promise 的方法。
const fs = require('fs');
const util = require('util');
const readFile = util.promisify(fs.readFile);
async function readFileContent() {
try {
const content = await readFile('example.txt', 'utf8');
console.log(content);
} catch (err) {
console.error('Error reading file:', err);
}
}
结论
对于大多数现代 node.js 应用程序，fspromises 是推荐的选择，因为它与 async/await 兼容，提高了可读性，并且更容易处理错误。然而，传统的 fs 模块仍然占有一席之地，特别是在遗留系统、简单脚本或需要低级控制的特定用例中。当开始一个新项目或重构现有项目时，请考虑采用 fspromises 在文件系统操作中充分利用现代 javascript 功能的全部功能。
