Node.js中文件I/O的执行优先级：同步与异步操作解析-js教程-PHP中文网

Node.js中文件I/O的执行优先级：同步与异步操作解析

本教程深入探讨node.js中文件i/o操作的执行优先级，特别是同步与异步方法对代码流程的影响。通过分析`fs.readfile`的异步特性导致变量初始化顺序异常，并对比`fs.readfilesync`的同步行为如何确保按预期加载配置。文章还将介绍如何利用`fs.promises`实现现代异步编程模式，帮助开发者根据场景选择最适合的文件读取方式，避免常见的执行顺序问题。

引言：理解Node.js中的I/O执行模型

Node.js以其非阻塞I/O模型而闻名，这使得它在处理高并发请求时表现出色。然而，对于初学者来说，这种异步特性有时会导致对代码执行顺序的误解，尤其是在涉及文件读取等I/O操作时。当我们需要从文件中加载配置或初始化全局变量时，如果未能正确处理异步操作，可能会发现变量并未按照预期的时间点被赋值。

案例分析：fs.readFile的异步行为

让我们通过一个具体的例子来理解这个问题。假设我们有一个cfg.json文件，内容如下：

{
  "serverAddr": "https://google.com/"
}

登录后复制

我们的目标是在程序启动时读取这个文件，并将serverAddr的值赋给一个全局变量。以下是尝试实现此功能的代码片段：

const fs = require('fs');

async function loadData() {
    fs.readFile('cfg.json', 'utf8', (err, data) => {
        if (err) {
            console.error("文件读取错误:", err);
            return;
        }
        const map = JSON.parse(data);
        console.log("1: 内部回调 - 当前serverAddr:", serverAddr); // 预期：此时为"NOT INIT"
        serverAddr = map.serverAddr;
        console.log("2: 内部回调 - 更新后serverAddr:", serverAddr); // 预期：此时为"https://google.com/"
    });
    console.log("3: loadData函数内部 - 当前serverAddr:", serverAddr);
    console.log("4: loadData函数内部 - 当前serverAddr:", serverAddr);
}

var serverAddr = "NOT INIT";
console.log("5: 全局作用域 - 初始serverAddr:", serverAddr);
loadData();
console.log("6: 全局作用域 - loadData调用后serverAddr:", serverAddr);

登录后复制

运行这段代码，我们得到的输出是：

5: 全局作用域 - 初始serverAddr: NOT INIT
3: loadData函数内部 - 当前serverAddr: NOT INIT
4: loadData函数内部 - 当前serverAddr: NOT INIT
6: 全局作用域 - loadData调用后serverAddr: NOT INIT
1: 内部回调 - 当前serverAddr: NOT INIT
2: 内部回调 - 更新后serverAddr: https://google.com/

登录后复制

输出结果解析：为何顺序不符预期

从输出可以看出，console.log语句1和2（位于fs.readFile的回调函数内部）在3、4、5、6之后才执行。这正是Node.js异步I/O的体现：

当fs.readFile被调用时，它会发起一个文件读取操作，并将一个回调函数注册到事件循环中。
fs.readFile本身是非阻塞的，它会立即返回，而不会等待文件读取完成。
因此，loadData函数中的console.log("3: ...")和console.log("4: ...")会立即执行。
紧接着，全局作用域中的console.log("6: ...")也会立即执行。
只有当文件读取操作实际完成，并且Node.js的事件循环空闲时，之前注册的回调函数才会被执行，此时console.log("1: ...")和console.log("2: ...")才会打印，并且serverAddr变量才会被更新。

async/await与回调函数：为什么对fs.readFile无效

用户尝试在fs.readFile前添加await，但VS Code提示'await' has no effect on the type of this expression.ts(80007)。这是因为await关键字只能用于等待一个Promise对象。而fs.readFile是一个基于回调函数的API，它不返回Promise。因此，直接在它前面使用await是无效的。要使用async/await，我们需要一个返回Promise的异步函数。

解决方案：使用fs.readFileSync实现同步加载

在某些特定场景下，例如程序启动时初始化配置，我们可能确实需要确保文件读取是同步的，即在文件内容加载完成并赋值给变量之前，程序的后续代码不应该执行。这时，Node.js提供了fs.readFileSync方法。

fs.readFileSync是一个同步的文件读取方法，它会阻塞Node.js事件循环，直到文件读取完成并返回内容。

修改后的代码示例：

const fs = require('fs');

function loadDataSync() {
    try {
        const data = fs.readFileSync('cfg.json', 'utf8');
        const map = JSON.parse(data);
        console.log("1: loadDataSync内部 - 读取到serverAddr:", map.serverAddr);
        serverAddr = map.serverAddr;
        console.log("2: loadDataSync内部 - 更新后serverAddr:", serverAddr);
    } catch (err) {
        console.error("同步文件读取错误:", err);
        // 根据实际情况处理错误，例如退出程序或使用默认值
        process.exit(1); 
    }
}

var serverAddr = "NOT INIT";
console.log("3: 全局作用域 - 初始serverAddr:", serverAddr);
loadDataSync(); // 调用同步加载函数
console.log("4: 全局作用域 - loadDataSync调用后serverAddr:", serverAddr);
console.log("5: 全局作用域 - 最终serverAddr:", serverAddr);

登录后复制

执行顺序与预期结果：

使用fs.readFileSync后，输出将变为：

3: 全局作用域 - 初始serverAddr: NOT INIT
1: loadDataSync内部 - 读取到serverAddr: https://google.com/
2: loadDataSync内部 - 更新后serverAddr: https://google.com/
4: 全局作用域 - loadDataSync调用后serverAddr: https://google.com/
5: 全局作用域 - 最终serverAddr: https://google.com/

登录后复制

现在，serverAddr变量在loadDataSync函数执行完毕后，就已经被正确地更新了，后续的console.log语句也反映了这一变化。

注意事项：阻塞主线程

腾讯交互翻译

腾讯AI Lab发布的一款AI辅助翻译产品

183

查看详情

尽管fs.readFileSync解决了同步加载的问题，但需要注意：它会阻塞Node.js的事件循环。这意味着在文件读取完成之前，Node.js无法处理任何其他请求或事件。因此，fs.readFileSync通常只推荐用于以下场景：

程序启动时的配置加载： 在应用程序初始化阶段，少量、关键的配置数据加载。
命令行工具： 不需要处理并发请求的简单脚本。

对于服务器端应用程序，如果需要在运行时频繁进行文件I/O，或者文件可能很大，使用同步方法会导致性能瓶颈和响应延迟。

现代异步实践：fs.promises.readFile

Node.js的fs模块从v10版本开始提供了基于Promise的API，位于fs.promises命名空间下。这使得我们可以结合async/await来编写更简洁、更易读的异步代码，同时避免阻塞主线程。

引入fs.promises模块：

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

登录后复制

基于Promise的异步文件读取示例：

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

async function loadDataAsync() {
    try {
        console.log("1: loadDataAsync内部 - 开始读取文件...");
        const data = await fsPromises.readFile('cfg.json', 'utf8');
        const map = JSON.parse(data);
        console.log("2: loadDataAsync内部 - 读取到serverAddr:", map.serverAddr);
        serverAddr = map.serverAddr;
        console.log("3: loadDataAsync内部 - 更新后serverAddr:", serverAddr);
    } catch (err) {
        console.error("异步文件读取错误:", err);
        // 根据实际情况处理错误
    }
}

var serverAddr = "NOT INIT";
console.log("4: 全局作用域 - 初始serverAddr:", serverAddr);

// 调用异步加载函数
// 注意：顶层await在Node.js v14.8.0+中才被完全支持
// 对于早期版本或模块类型为'commonjs'的情况，需要封装在async IIFE中
(async () => {
    await loadDataAsync();
    console.log("5: 全局作用域 (IIFE) - loadDataAsync调用后serverAddr:", serverAddr);
    console.log("6: 全局作用域 (IIFE) - 最终serverAddr:", serverAddr);
})();

console.log("7: 全局作用域 - IIFE调用后，但可能在IIFE内部完成前执行:", serverAddr);

登录后复制

执行顺序解析：

在上述Promise/async/await的例子中，await fsPromises.readFile('cfg.json', 'utf8')会暂停loadDataAsync函数的执行，等待文件读取Promise解决。在此期间，事件循环是不被阻塞的，可以处理其他任务。当Promise解决后，loadDataAsync会恢复执行。

输出大致会是：

4: 全局作用域 - 初始serverAddr: NOT INIT
7: 全局作用域 - IIFE调用后，但可能在IIFE内部完成前执行: NOT INIT
1: loadDataAsync内部 - 开始读取文件...
2: loadDataAsync内部 - 读取到serverAddr: https://google.com/
3: loadDataAsync内部 - 更新后serverAddr: https://google.com/
5: 全局作用域 (IIFE) - loadDataAsync调用后serverAddr: https://google.com/
6: 全局作用域 (IIFE) - 最终serverAddr: https://google.com/

登录后复制

请注意，console.log("7: ...")可能会在IIFE内部的await完成之前执行，因为它位于IIFE的外部，且IIFE本身是异步启动的。如果需要确保serverAddr在所有后续全局代码中使用前被初始化，那么整个程序逻辑可能需要封装在一个async函数中，或者在顶层使用await（如果环境支持）。

选择策略与最佳实践

在Node.js中处理文件I/O时，选择同步还是异步方法取决于具体的应用场景和需求：

何时使用同步fs.readFileSync：
- 程序启动初始化： 当应用程序必须在继续执行之前加载关键配置或数据时。
- 简单的脚本或命令行工具： 性能不是主要瓶颈，且不需要处理并发请求。
- 优点： 代码逻辑直观，执行顺序明确。
- 缺点： 阻塞事件循环，可能导致应用程序无响应。
何时使用异步fs.promises.readFile (或基于回调的fs.readFile)：
- 服务器端应用程序： 需要处理并发请求，保持非阻塞特性以确保高吞吐量和低延迟。
- 大型文件读取： 避免长时间阻塞。
- 优点： 非阻塞，保持应用程序响应性，适合高并发环境。
- 缺点： 代码逻辑可能需要更多地考虑异步流（Promise链、async/await、回调地狱）。
错误处理：
- 同步方法： 使用try...catch块来捕获文件读取过程中可能发生的错误（如文件不存在、权限不足、JSON解析失败）。
- 异步方法： Promise链使用.catch()，async/await使用try...catch块来处理Promise拒绝（rejection）。

总结

理解Node.js中同步与异步I/O的执行机制是编写高效、健壮应用程序的关键。fs.readFile是异步的，适合大多数场景以保持非阻塞特性；而fs.readFileSync是同步的，适用于程序启动时的关键资源加载，但需谨慎使用以避免阻塞主线程。对于现代Node.js开发，推荐使用fs.promises结合async/await，它提供了兼顾非阻塞性能与代码可读性的最佳实践。通过根据具体需求选择合适的文件读取方法，开发者可以有效地管理代码执行顺序，确保变量按预期初始化，从而构建出更加可靠的应用程序。

以上就是Node.js中文件I/O的执行优先级：同步与异步操作解析的详细内容，更多请关注php中文网其它相关文章！