node.js - FileStream Promise 尽早解决

Question

我在nodeJS中遇到了一个相当奇怪的问题，我不太明白为什么。

考虑以下代码:

(async () => {
    console.log ("1");

    await new Promise ((resolve, reject) => {
        setTimeout (() => {
            console.log ("2");
            resolve ();
        }, 1000);
    });

    console.log ("3");
    process.exit ();
})();

这段代码完全完成了它应该做的事情。它按顺序打印 123。打印 1 后，等待大约一秒钟。完美的。现在让我们看看下面的例子:

const fs = require ("fs");

(async () => {
    const stream = fs.createWriteStream ("file.txt");
    stream.write ("Test");

    console.log ("1");

    await new Promise ((resolve, reject) => {
        stream.on ("finish", () => {
            console.log ("2");
            resolve ();
        });
    });

    console.log ("3");
    process.exit ();
})();

根据我的理解，这段代码应该完成，或者 - 如果 finish 事件永远不会被触发 - 无限运行。发生的情况恰恰相反:它打印 1，然后退出。既然这是脚本的结尾，它在退出之前不应该至少打印另一个3吗？

重要:我知道 promise 不会解析，因为 .end() 没有在流上调用。我想知道为什么脚本无论如何都会完成。

谁能给我解释一下这种行为吗？

Answer 1

最好的解释可能是在不使用 async/await 关键字的情况下编写此代码，并且让您了解它们不会做任何“神奇”的事情，而只是解决 Promise 的不同方式的“糖”，而不是 .then()。

const fs = require ("mz/fs");

const stream = fs.createWriteStream("file.txt");
stream.write("Test");

console.log("1");

new Promise ((resolve, reject) => {
    stream.on ("finish", () => {
        console.log("2");
        resolve();
    });
}).then(() => {
   console.log("2");
   process.exit();
});

这是完全相同的事情!那么问题在哪里。

您真正缺少的事情是，当您打开文件时，“没有任何内容”表明它“必须”在程序退出之前显式关闭。因此，“没有什么可等待的”，程序会完成，但不会“分支”到仍在等待 Promise 到 resolve() 的部分。

它只记录“1”的原因是因为剩余的分支“正在”等待Promise解析，但在程序完成之前它永远不会到达那里。

当然，当您在write之后立即实际调用stream.end()时，或者理想情况下通过“等待”任何可能挂起的写入请求时，所有情况都会发生变化:

const fs = require ("mz/fs");

(async () => {
    const stream = fs.createWriteStream ("file.txt");
    await stream.write ("Test");          // await here before continuing
    stream.end()
    console.log ("1");

    await new Promise ((resolve, reject) => {
        stream.on ("finish", () => {
            console.log ("2");
            //resolve ();
        });
    });

    console.log ("3");
    //process.exit ();
})();

这当然会记录列表中的每个输出，您应该很清楚。

因此，如果您希望在日志中看到 "3" ，那么它不会出现的原因是因为 await 我们永远不会关闭流。再次，最好的证明可能是摆脱 await:

const fs = require ("mz/fs");

(async () => {
    const stream = fs.createWriteStream ("file.txt");
    await stream.write ("Test");
    stream.end()
    console.log ("1");

    new Promise ((resolve, reject) => {    // remove await - execution hoisted
        stream.on ("finish", () => {
            console.log ("2");
            //resolve ();
        });
    });

    console.log ("3");
    //process.exit ();
})();

那么你“应该”看到:

1
3
2

至少在大多数系统上，除非你有“极端”的延迟。但通常，在“等待”write 之后到达下一行之前，应该触发“finish”。

<小时/>

NOTE: Just using the mz library here for demonstration of an an await on the write() method without wrapping a callback. Generally speaking the callback execution should resolve just the same.