Node.js Http2ServerResponse.finished 方法

在 Node.js 的 Http2ServerResponse 对象中，finished 方法被用来检查响应是否已被完成，并返回一个布尔值。这个方法通常被用来检测是否需要继续操作响应流。

语法

http2Response.finished

返回值

如果响应已被完成，返回 true；否则返回 false。

用法

基本用法

下面是一个例子，演示如何使用 Http2ServerResponse 对象的 finished 方法来检查响应是否已经完成：

const http2 = require('http2');
const server = http2.createSecureServer();

server.on('stream', (stream, headers) => {
  // setup response
  const responseHeaders = {
    ':status': 200,
    'content-type': 'text/plain'
  };
  stream.respond(responseHeaders);

  // write to stream
  stream.write('Hello, ');
  stream.write('World!');
  
  // check if response is finished
  if (stream.finished) {
    console.log('Response is already finished.');
  }

  // end response
  stream.end();
});

server.listen(8443);

在这个例子中，我们创建了一个基于 HTTP/2 的服务器，并设置一个响应流（stream）。接着，我们检查响应是否已经完成，并根据结果输出相应的信息。

结合其他属性和方法使用

Http2ServerResponse.finished 方法常常与其他属性和方法一起使用，以实现更为复杂的功能。比如，我们可以使用 writableEnded 属性先检查 writableEnded 是否已经被设为 true，以避免重复调用 write 或 end 等方法。

stream.on('end', () => {
  if (!stream.finished) {
    stream.end();
  }
});

另外，我们也可以使用 end 方法的回调函数来检查 finished 是否为 true。

stream.end(() => {
  if (stream.finished) {
    console.log('Response is already finished.');
  }
});

注意事项

Http2ServerResponse.finished 方法只能在响应流结束后被调用。因此，在使用该方法时，我们必须保证所有的 write 方法和 end 方法都已经被调用。

参考文献

• Node.js v14.17.6 Documentation - Http2ServerResponse.finished