node.js - createreadstream 是异步的吗？

Question

https://nodejs.org/api/fs.html#fs_fs_createreadstream_path_options .我还有一个一般性问题。

我可以假设除非文档中另有说明，否则提到的任何函数都是异步的吗？

Answer 1

Is createreadstream asynchronous?

是也不是。这个问题实际上更多的是语义问题，因为它在看起来同步的界面下隐藏了异步操作。 fs.createReadStream() 似乎有一个同步接口(interface)。它不返回 promise 或接受回调以在完成时进行通信或发回某些结果。因此，它从界面上看起来是同步的。而且，我们通过使用它知道您无需等待即可开始使用该流。因此，您可以像使用同步接口(interface)一样使用它。

这是 fs.createReadStream() 的签名:

fs.createReadStream(path[, options])

而且，在选项对象中，没有回调选项，也没有提及返回的 promise 。这不是典型的异步接口(interface)。

---

另一方面，如果您查看 fs.rename() 的签名:

fs.rename(oldPath, newPath, callback)

您会看到它需要一个在文档中称为“完成回调”的回调。这个函数显然是异步的。

---

但是，fs.createReadStream() 确实会打开一个文件，并且它会异步打开该文件而不会阻塞。

如果您想知道 fs.createReadStream() 在必须异步打开文件时如何同步，那是因为 fs.createReadStream() 还没有返回时打开文件。

在流的正常使用中，您可以立即开始从流中读取。但是，在流内部，如果文件尚未打开，它将等到文件打开后再真正尝试从中读取。因此，打开文件的过程对流的用户是隐藏的(这通常是一件好事)。

如果您想知道文件实际打开的时间，流上有一个 open 事件。而且，如果打开文件时出错，流中将出现 error 事件。所以，如果你想了解技术，你可以说 fs.readStream() 实际上是一个异步操作，异步操作的完成是通过 open 或 错误事件。

let rstream = fs.createReadStream("temp.txt");
rstream.on('open', (fd) => {
    // file opened now
});
rstream.on('error', (err) => {
    // error on the stream
});

但是，在 fs.createReadStream() 的正常使用中，程序员不必监视文件打开事件，因为它对用户隐藏并在下一次读取流时自动处理.当您创建一个读取流并立即要求从中读取(这是一个异步接口(interface))时，流对象在内部等待文件完成打开，然后从中读取一些字节，等待文件读取完成然后通知读操作完成。因此，他们只是将文件打开完成与第一次读取结合起来，从而为程序员节省了在发出第一次读取操作之前等待文件打开完成的额外步骤。

因此，从技术上讲，fs.createReadStream() 是一个具有完成事件的异步操作。但是，由于它与从文件读取相结合的方式，您通常不必像异步一样使用它，因为它的异步行为与从文件的异步读取相结合。