Node中的setHeader和writeHead怎么用

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應用程序的性能和用戶體驗。