Node.js 中的 http2stream.respondWithFile(path[,headers[,options]]) 函数

2025年3月13日 | 阅读 4 分钟

在本文中，我们将讨论 Node.js 中 http2stream.respondWithFile(path[, headers[, options]]) 函数的语法、参数和示例。

Node.js 中的 http2stream.respondWithFile(path[, headers[, options]]) 函数是什么？

Node.js 的 Node.js HTTP/2 模块提供了 http2stream.respondWithFile(path[, headers[, options]]) 函数，用于在 HTTP/2 流上完成文件传输。当将文件从服务器的文件系统发送到客户端时，流式传输文件的最大优势在于获得可达到的最快传输速度。它可能包括诸如 start、stop 和响应头决策之类的选项，用于提供文件的部分内容（例如媒体文件）。它提高了可伸缩性，并且在使 HTTP/2 应用程序中的静态内容提供更加容易时，它对内存更负责。

语法

它具有以下语法：

参数

Path: 我们希望传输到客户端本地文件路径的文件（字符串）。
Headers: 一个对象，包含我们希望与响应一起发送的可选标头，例如 Content-Type、Content-Length 和 Cache-Control。
Options: 提供更多对文件服务机制控制的其他功能是可选的，包括 statCheck、start 和 end。

关键概念

高效的文件服务：它直接从文件系统读取文件内容，并将内容传递给流，从而无需先将内容读入内存并进行缓冲。
标头支持：可以在实际传输文件之前设置 Content Type 和 Cache-Control 的响应标头。
流式传输：文件会被流式传输到客户端，这使得这种方法非常适合大文件。它适用于控制内存消耗，并避免将整个文件加载到内存中。
范围请求：可以使用 start 和 finish 等参数指定要服务的文件的字节范围，以支持范围请求，例如视频流的请求。

命令

使用以下命令生成证书

 
openssl genrsa -out server-key.pem 2048
openssl req -new -key server-key.pem -out server-csr.pem
openssl x509 -req -in server-csr.pem -signkey server-key.pem -out server-cert.pem   

上面的命令将生成两个证书

 
Server-key.pem (private key)
Server-cert.pem (certificate)   

确保 server-key.pem 和 server-cert.pem 文件位于脚本的同一目录中，或者在脚本本身中包含这些文件的正确路径。

示例 1

让我们举一个例子来说明 Node.js 中的 http2stream.responseWithFile() 函数。

 
const http2 = require('http2');
const fs = require('fs');
const path = require('path');

// Read the SSL certificate and key
const serverKey = fs.readFileSync('server-key.pem');
const serverCert = fs.readFileSync('server-cert.pem');

// Create HTTP/2 secure server
const server = http2.createSecureServer({
  key: serverKey,
  cert: serverCert
});

server.on('stream', (stream, headers) => {
  const reqPath = headers[':path'];

  // Serve HTML file
  if (reqPath === '/') {
    stream.respondWithFile('index.html', {
      'content-type': 'text/html'
    });
  }
  // Serve an image file
  else if (reqPath === '/image') {
    const imagePath = path.join(__dirname, 'image.jpg');
    stream.respondWithFile(imagePath, {
      'content-type': 'image/jpeg'
    });
  }
  // Handle 404 for other paths
  else {
    stream.respond({ ':status': 404 });
    stream.end('404 Not Found');
  }
});

// Start server
server.listen(8443, () => {
  console.log('Server is running on https://:8443');
});   

输出

 
Server is running on https://:8443

说明

创建 SSL 证书： OpenSSL 生成的私钥和自签名证书通过 server-key.pem 和 server-cert.pem 命令提供。
如何获得证书：检查代码是否正确引用了 server-key.pem 和 server-cert.pem 文件。为此，只需将它们放在同一个目录中。

示例 2

让我们再举一个例子来说明 Node.js 中的 http2stream.responseWithFile() 函数。

 
const http2 = require('http2');
const fs = require('fs');
const path = require('path');

// Read SSL certificate and key for secure connection
const privateKey = fs.readFileSync('private-key.pem');
const certificate = fs.readFileSync('certificate.pem');

// Create a secure HTTP/2 server
const secureServer = http2.createSecureServer({
  key: privateKey,
  cert: certificate
});

// Listen for requests on streams
secureServer.on('stream', (stream, headers) => {
  const requestedPath = headers[':path'];

  // Serve main HTML page
  if (requestedPath === '/') {
    stream.respondWithFile('home.html', {
      'content-type': 'text/html'
    });
  }
  // Serve CSS styles
  else if (requestedPath === '/main.css') {
    const cssFilePath = path.join(__dirname, 'main.css');
    stream.respondWithFile(cssFilePath, {
      'content-type': 'text/css'
    });
  }
  // Serve JavaScript file
  else if (requestedPath === '/app.js') {
    const jsFilePath = path.join(__dirname, 'app.js');
    stream.respondWithFile(jsFilePath, {
      'content-type': 'application/javascript'
    });
  }
  // Respond with 404 for other paths
  else {
    stream.respond({ ':status': 404 });
    stream.end('Resource Not Found');
  }
});

// Start the server on a different port
secureServer.listen(9443, () => {
  console.log('Secure HTTP/2 server is running on https://:9443');
});   

输出

 
Secure HTTP/2 server is running on https://:9443

说明

在此示例中，将 HTML 文件 index.html 作为对路由 / 的响应返回。它应该是一个文件。
当 URL 中提供的路径不包含 / 或 /styles.css 时，我们的服务器将仅返回“未找到” 错误 (404)。对于名为 styles.css 的文件，回复的内容类型为 text/css。
之后，所有与 URL 路径的批准都已完成，它会正确处理所有其他事情。确保这些文件与我们的脚本位于同一目录中。
index.html，它充当一个基本的 HTML 页面，将 CSS 文件链接在一起。
我们 CSS 库中的 styles.css 文件。
您的 SSL 证书可以在 server-key.pem 和 server-cert.pem 文件中找到。

结论

总之，这是一个 Node.js 函数，它有助于响应一个文件，http2stream.respondWithFile(path[, headers[, options]])，它通过服务通过 HTTP/2 的静态文件来工作，其中文件直接从服务器的文件系统流式传输到客户端。它通过有效地简化数据并消除了将整个文件加载到内存中的需求，从而提高了性能，尤其是在处理大文件时。它还支持部分文件服务和响应头修改，这对于使用范围请求和流式传输视频至关重要。通过与 HTTP/2 的高级多路复用功能相结合，它在加速最新 Web 应用程序中的文件交付方面非常有效。

下一个主题基于Node.js的图书管理系统

Node.js 中的 http2stream.respondWithFile(path[,headers[,options]]) 函数