在本教程中,我們將展示如何在 OpenResty Edge 中新增自定義響應頭,且無需重啟或重新載入伺服器程序。

在 OpenResty Edge 中新增自定義響應頭的步驟:

  1. 開啟 OpenResty Edge 的 Admin Web 控制檯,進入你的應用。
  2. 進入 “Page Rules”(頁面規則),新增一條新規則。
  3. 新增 “Add response header”(新增響應頭) 動作。
  4. 填寫響應頭的名稱(如 X-TEST-EXTRA-HEADER)和——值可以是靜態字串,也可以是內建變數System Hostname 或指定名稱的 Request Header)。
  5. 釋出一個新版本,規則即同步推送到所有閘道器叢集。

整個過程無需重新載入、重啟伺服器或二進位制升級。若你還需要改寫發往上游的請求頭,可參閱《在 OpenResty Edge 中為上游請求設定不同的 Host 頭》

下面是帶截圖的完整操作演示。

將字串作為值新增新的響應頭

讓我們進入 OpenResty Edge 的 Admin Web 控制檯。這就是我們控制檯的樣例部署。每個使用者都有自己的本地部署。我們可以繼續使用之前的示例應用,“test-edge.com”。

Screenshot

進入該應用。

Screenshot

首先進入 “Page Rules” 頁面。

Screenshot

點選此處新增新的頁面規則。

Screenshot

新增一個動作。

Screenshot

我們選擇 “Add response header”。

Screenshot

響應頭有兩個部分,它的名稱和對應的值。

Screenshot

將響應頭命名為 “X-TEST-EXTRA-HEADER”。

Screenshot

對於此處的值,您可以選擇使用字串或內建變數,我們先用字串進行測試。

Screenshot

輸入 “hello world”。

Screenshot

確保這個規則在任何現有的正常規則之前執行。

Screenshot

儲存這個頁面規則。

Screenshot

像往常一樣,需要釋出一個新的版本來推送我們剛才的改動。

Screenshot

釋出!

Screenshot

新版本現在已經同步到所有的閘道器伺服器上了。

Screenshot

現在,新的頁面規則已推送到所有閘道器叢集和伺服器了。

Embeded video

這些配置的變化,不需要伺服器重新載入、重啟,或二進位制升級。所以它是非常高效和可擴充套件的。

Embeded image

讓我們在閘道器伺服器上測試一下。

Screenshot

我們複製這個舊金山閘道器伺服器的 IP 地址。

Screenshot

然後在終端上進行測試。

Screenshot

這裡有我們新增的 “X-TEST-EXTRA-HEADER” 響應頭。

Screenshot

以 “System Hostname” 作為值的內建變數

接下來,讓我們試一下使用內建變數作為響應頭的值。

Screenshot

編輯這個頁面規則。

Screenshot

選擇內建變數作為響應頭的值。

Screenshot

目前我們為內建變數提供了兩種選項。一種是 “Request Header”,這意味著您可以檢索請求資訊。您需要按名稱指定 “Request Header”,例如 “Origin”、“Referer” 等。

Screenshot

另外一種是 “System Hostname”,它是我們之前設定好的閘道器伺服器的名稱。

Screenshot

我們來試試 “System Hostname”。

Screenshot

儲存它。

Screenshot

和剛剛一樣,我們需要釋出來推送這個新的頁面規則。

Screenshot

釋出!

Screenshot

現在它已經被推送到所有的閘道器叢集和伺服器。

Screenshot

首先,我們可以檢查之前伺服器的主機名。

Screenshot

此閘道器伺服器的主機名如下。

Screenshot

然後切換到終端。

Screenshot

“X-TEST-EXTRA-HEADER” 響應頭的值,已更改為我們剛剛看到的主機名。

Screenshot

讓我們測試另一個閘道器伺服器,例如這個位於法蘭克福的伺服器,其主機名如下。

Screenshot

再次切回到終端。

Screenshot

現在響應頭的值,是法蘭克福伺服器的主機名。

Screenshot

FAQ:OpenResty Edge 新增響應頭常見問題

在 OpenResty Edge 中新增響應頭需要重啟伺服器嗎?

不需要。OpenResty Edge 將頁面規則同步推送到所有閘道器叢集,全程無需重新載入、重啟或二進位制升級,配置即時生效。

OpenResty Edge 的響應頭值可以是動態的嗎?

可以。除靜態字串外,還可使用內建變數作為響應頭的值:System Hostname(閘道器伺服器的主機名)或按名稱指定的 Request Header(如 OriginReferer)。

如何讓同一個響應頭在 OpenResty Edge 的所有閘道器伺服器上生效?

在 OpenResty Edge 控制檯釋出一個新版本即可,頁面規則會自動同步到所有閘道器叢集和伺服器,無需逐臺配置。

OpenResty Edge 中 “Add response header” 和 “Set response header” 有甚麼區別?

Add response header 會追加一個響應頭,同名的已有響應頭會被保留;Set response header 則會覆蓋同名的已有響應頭。需要新增時用前者,需要強制改寫時用後者。完整的動作說明可參閱官方文件 Response Header Actions

關於 OpenResty Edge

OpenResty Edge 是一款專為微服務和分散式流量架構設計的全能型閘道器軟體,由我們自主研發。它集流量管理、私有 CDN 構建、API 閘道器、安全防護等功能於一體,幫助您輕鬆構建、管理和保護現代應用程式。OpenResty Edge 擁有業界領先的效能和可擴充套件性,能夠滿足高併發、高負載場景下的苛刻需求。它支援排程 K8s 等容器應用流量,並可管理海量域名,輕鬆滿足大型網站和複雜應用的需求。

如果您喜歡這個教程,請訂閱這個部落格網站和我們的 YouTube 頻道B 站頻道。謝謝!

關於作者

章亦春是開源 OpenResty® 專案創始人兼 OpenResty Inc. 公司 CEO 和創始人。

章亦春(Github ID: agentzh),生於中國江蘇,現定居美國灣區。他是中國早期開源技術和文化的倡導者和領軍人物,曾供職於多家國際知名的高科技企業,如 Cloudflare、雅虎、阿里巴巴, 是 “邊緣計算“、”動態追蹤 “和 “機器程式設計 “的先驅,擁有超過 22 年的程式設計及 16 年的開源經驗。作為擁有超過 4000 萬全球域名使用者的開源專案的領導者。他基於其 OpenResty® 開源專案打造的高科技企業 OpenResty Inc. 位於美國矽谷中心。其主打的兩個產品 OpenResty XRay(利用動態追蹤技術的非侵入式的故障剖析和排除工具)和 OpenResty Edge(最適合微服務和分散式流量的全能型閘道器軟體),廣受全球眾多上市及大型企業青睞。在 OpenResty 以外,章亦春為多個開源專案貢獻了累計超過百萬行程式碼,其中包括,Linux 核心、Nginx、LuaJITGDBSystemTapLLVM、Perl 等,並編寫過 60 多個開源軟體庫。

關注我們

如果您喜歡本文,歡迎關注我們 OpenResty Inc. 公司的部落格網站 。也歡迎掃碼關注我們的微信公眾號:

我們的微信公眾號

翻譯

我們提供了英文版 原文和中譯版(本文) 。我們也歡迎讀者提供其他語言的翻譯版本,只要是全文翻譯不帶省略,我們都將會考慮採用,非常感謝!