Node中的setHeader和writeHead怎么用

在Node.js中，处理HTTP请求和响应是开发Web应用程序的核心部分。setHeader和writeHead是http模块中用于设置HTTP响应头的方法。本文将详细介绍这两个方法的用法、区别以及在实际开发中的应用场景。

1. setHeader方法

1.1 基本用法

setHeader方法用于设置HTTP响应头。它允许你为响应设置单个头字段。你可以多次调用setHeader来设置多个头字段。

const http = require('http');

const server = http.createServer((req, res) => {
  res.setHeader('Content-Type', 'text/plain');
  res.setHeader('X-Custom-Header', 'CustomValue');
  res.end('Hello, World!');
});

server.listen(3000, () => {
  console.log('Server is running on port 3000');
});

在上面的例子中，我们设置了两个响应头：Content-Type和X-Custom-Header。Content-Type头告诉客户端响应的内容类型是纯文本，而X-Custom-Header是一个自定义的头字段。

1.2 多次设置同一个头字段

如果你多次调用setHeader来设置同一个头字段，后面的调用会覆盖前面的值。

res.setHeader('Content-Type', 'text/plain');
res.setHeader('Content-Type', 'application/json');

在这个例子中，最终的Content-Type头字段的值是application/json。

1.3 设置多个值

你可以通过传递一个数组来为一个头字段设置多个值。

res.setHeader('Set-Cookie', ['name=value', 'anotherName=anotherValue']);

在这个例子中，Set-Cookie头字段将包含两个值。

2. writeHead方法

2.1 基本用法

writeHead方法用于设置HTTP响应的状态码和头字段。与setHeader不同，writeHead允许你一次性设置状态码和多个头字段。

const http = require('http');

const server = http.createServer((req, res) => {
  res.writeHead(200, {
    'Content-Type': 'text/plain',
    'X-Custom-Header': 'CustomValue'
  });
  res.end('Hello, World!');
});

server.listen(3000, () => {
  console.log('Server is running on port 3000');
});

在这个例子中，我们使用writeHead设置了状态码200和两个头字段：Content-Type和X-Custom-Header。

2.2 状态码和状态消息

writeHead的第一个参数是状态码，第二个参数是头字段对象。你还可以传递第三个参数作为状态消息。

res.writeHead(404, 'Not Found', {
  'Content-Type': 'text/plain'
});

在这个例子中，状态码是404，状态消息是Not Found。

2.3 与setHeader的结合使用

你可以在调用writeHead之前使用setHeader来设置头字段。writeHead会将这些头字段与它自己的头字段合并。

res.setHeader('Content-Type', 'text/plain');
res.writeHead(200, {
  'X-Custom-Header': 'CustomValue'
});

在这个例子中，最终的响应头将包含Content-Type和X-Custom-Header。

3. setHeader和writeHead的区别

3.1 调用时机

• setHeader可以在任何时候调用，甚至在调用write或end之前。
• writeHead必须在调用write或end之前调用，因为它会发送响应头。

3.2 功能

• setHeader只能设置单个头字段。
• writeHead可以一次性设置状态码和多个头字段。

3.3 覆盖行为

• 如果你在调用writeHead之前使用setHeader设置了头字段，writeHead会将这些头字段与它自己的头字段合并。如果有冲突，writeHead的头字段会覆盖setHeader的头字段。

4. 实际应用场景

4.1 设置内容类型

在大多数Web应用程序中，设置Content-Type头字段是非常重要的。它告诉客户端响应的内容类型，以便客户端能够正确解析响应。

res.setHeader('Content-Type', 'application/json');

4.2 设置缓存控制

你可以使用Cache-Control头字段来控制客户端缓存行为。

res.setHeader('Cache-Control', 'max-age=3600');

4.3 重定向

你可以使用writeHead来设置重定向。

res.writeHead(302, {
  'Location': 'https://example.com'
});
res.end();

4.4 设置自定义头字段

你可以使用setHeader或writeHead来设置自定义头字段。

res.setHeader('X-Custom-Header', 'CustomValue');

5. 注意事项

5.1 头字段名称

头字段名称是大小写不敏感的，但通常使用首字母大写的格式。

5.2 头字段值

头字段值必须是字符串或字符串数组。如果传递了非字符串值，Node.js会尝试将其转换为字符串。

5.3 重复头字段

某些头字段（如Set-Cookie）可以多次设置。你可以通过传递数组来设置多个值。

res.setHeader('Set-Cookie', ['name=value', 'anotherName=anotherValue']);

5.4 头字段的顺序

头字段的顺序在HTTP/1.1中通常不重要，但在某些情况下（如Set-Cookie）顺序可能会影响客户端行为。

6. 总结

setHeader和writeHead是Node.js中用于设置HTTP响应头的重要方法。setHeader允许你逐个设置头字段，而writeHead允许你一次性设置状态码和多个头字段。在实际开发中，你可以根据需求选择使用哪种方法，或者结合使用它们来设置响应头。

理解这两个方法的用法和区别，可以帮助你更好地控制HTTP响应，提升Web应用程序的性能和用户体验。