Node.js http.ServerResponse.writableFinished 属性

2025 年 2 月 21 日 | 阅读 5 分钟

在本文中，我们将讨论 Node.js 中的 httpServerResponse.writableFinished() 方法，包括其语法、参数、示例和优点。

Node.js 中的 httpServerResponse.writableFinished() 方法是什么？

http 模块中 ServerResponse 类的集成应用程序编程接口，httpServerResponse.writableFinished，用于确定所有数据是否已刷新。

语法

它具有以下语法：

参数

此属性不接受任何参数。

返回值

此属性仅当所有数据已刷新时才返回 true。

示例 1

让我们举一个例子来说明 Node.js http.ServerResponse.writableFinished() 属性。

 
const http = require('http');
const PORT = process.env.PORT || 3000;
const httpServer = http.createServer(
function (request, response) {
const value = response.writableFinished;
response.end("Data has flushed : "+ value, 'utf8', () => {
console.log("Showing the result...");
httpServer.close(() => {
console.log("Server is closed")
})
});
});
httpServer.listen(PORT, () => {
console.log("Server is running at port 3000...");
});   

输出

 
Server is running at port 3000...
Showing the result...
Showing the result...
Server is closed
Server is closed

浏览器输出

在浏览器搜索框中复制并粘贴 https://:3000/ 作为 localhost 地址。

示例 2

让我们再举一个例子来说明 Node.js http.ServerResponse.writableFinished() 属性。

 
const http = require('http');
const http2Handlers = (request, response) => {
const value = response.writableFinished;
response.end("Data has flushed : "+ value, 'utf8', () => {
console.log("Showing the result...");
const value1 = response.writableFinished;
console.log("Data has flushed " + value1);
httpServer.close(() => {
console.log("Server is closed")
})
});
};
const httpServer = http.createServer(
http2Handlers).listen(3000, () => {
console.log("Server is running at port 3000...");
});   

输出

 
Server is running at port 3000...
Showing the result...
Data has flushed true.

浏览器输出：在浏览器搜索栏中粘贴 localhost 地址 https://:3000/。

Node.js 提供了一个布尔属性 http.ServerResponse.writableFinished，用于指示响应是否已完全传输且不再可编辑。此功能对于需要检查响应对象状态的开发人员尤其有用，以确保在响应完成后不再写入数据。

writableFinished 的关键点

http.ServerResponse.writableFinished() 方法的几个关键点如下：

1. 属性类型

这是一个布尔属性。

2. 状态指示

True：表示响应已发送完毕，所有关联资源均已释放。
False：表示响应仍在发送过程中或等待发送。

3. 用例

在需要验证在响应完成后执行操作是否安全或避免不必要写入的情况下很有用。
Node.js 中的 http.ServerResponse.writableFinished 属性是一个布尔值，指示响应是否已完全发送并且不再可写。此属性对于需要检查响应对象状态以确保在响应完成后不再写入数据的开发人员特别有用。

示例 3

让我们举一个例子来说明 Node.js 中的 http.ServerResponse.writableFinished 属性。

 
const http = require('http');
const server = http.createServer((req, res) => {
res.write('Hello, world!');
setTimeout(() => {
if (!res.writableFinished) {
res.end(' Goodbye, world!');
} else {
console.log('Response has already been finished.');
}
}, 1000);
});
server.listen(3000, () => {
console.log('Server is listening on port 3000');
});   

输出

 
Server is listening on port 3000

说明

创建了一个易于使用的 HTTP 服务器。
服务器通过将“Hello, world!”附加到响应来开始处理请求。
服务器等待一秒钟，然后确定响应是否仍然可读。
如果响应尚未完成 (!res.writableFinished)，它将使用“Goodbye, world!”结束响应。
如果响应已完成，它会向控制台记录一条消息。

重要注意事项

时机：当输出被发送时，writableFinished 的值会被修改。它最初将为 false，但在调用 res.end() 并完全刷新数据后将变为 true。
错误处理：处理可能的错误并确保响应被正确关闭至关重要。验证 writableFinished 可以帮助防止因尝试写入已完成的响应而产生的错误。

附加上下文

与其他属性的关系：此属性与 writable、writableEnded 和 finished 属性有关，这些属性提供了关于响应可写状态的不同程度的详细信息。
Writable：显示响应流是否仍可写入。
WritableEnded：表示调用了 end()。
Finished：显示响应是否已完全传输到底层系统。
Node.js 版本：在继续之前，请验证我们使用的 Node.js 版本是否支持此属性。较新版本已对其进行了维护和扩展。
通过更熟练地管理响应流并适当使用 writableFinished 属性，开发人员可以提高其 Node.js 应用程序的效率和可靠性。