如何在 OpenResty Edge 中透過 Edgelang 建立並呼叫 Lua 模組

在 OpenResty Edge 中，您可以先在 Admin Web 控制檯中建立一個全域性 Lua 模組（上傳 .lua 檔案或在編輯框中線上編寫），再透過 Edgelang 在頁面規則中呼叫它。儲存後，模組會自動分發到每臺閘道器伺服器，無需過載或重啟即可在 Edgelang 程式碼中引用。

本影片教程將演示如何建立全域性 Lua 模組、透過 Edgelang 在頁面規則中呼叫它，並用 curl 驗證結果——讓您輕鬆完成極其複雜的閘道器操作和計算。Edge 語言是由 OpenResty Inc. 開發的一種簡潔而強大的小語言。

如何在 OpenResty Edge 中建立全域性 Lua 模組

讓我們進入 OpenResty Edge 的 Admin Web 控制檯。這是我們控制檯的樣例部署。每個使用者都有自己的本地部署。

首先，我們需要建立一個 Lua 模組。

進入到全域性配置頁面。

選擇 “全域性 Lua 模組”。

我們在這裡建立的 Lua 模組可以被頁面規則呼叫，並且可以儘可能地滿足我們複雜的需求。

我們可以直接上傳一個 Lua 檔案。

或者在編輯框中編寫程式碼。

在這裡，我們建立了一個名為 output-md5.lua 的 Lua 檔案，它可以計算輸入引數的 md5 值。

宣告 Lua 模組表 _M。

現在向該 Lua 模組新增一個名為 calc 的函式，該函式可以計算輸入引數的 md5 值。

最後，不要忘記在結尾處返回模組表。

編輯並儲存後，Lua 模組將自動分發到每個閘道器伺服器，並且可以由 Edgelang 程式碼引用。

這些全域性 Lua 模組可在多個頁面規則間複用。若需事件驅動的邏輯，OpenResty Edge 還支援響應閘道器伺服器下線事件的 Lua 擴充套件。

如何透過 Edgelang 在頁面規則中呼叫 Lua 模組

現在，我們嘗試在 OpenResty Edge 的 HTTP 應用程式中呼叫 Lua 模組。

我們可以繼續使用之前的示例應用，test-edge.com。

進入該應用。

我們已經定義了一個頁面規則。

該頁面規則設定了一個反向代理到預定義的上游。

現在讓我們新增一個新的頁面規則來呼叫 Lua 模組。

啟用一個規則條件來檢查 URI /test-md5。

看看我們可以選擇哪些變數。

選擇 “URI”。

我們選擇字串相等運算子。

輸入值 /test-md5，僅匹配根位置。

然後新增一個新動作。

您可以在此處搜尋要新增的動作。

搜尋 “使用 EdgeLang”。

選擇它。

將我們用於呼叫 Lua 模組的 Edgelang 程式碼新增到編輯框中，注意我們使用 URI 引數 “value” 作為輸入引數。

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

確保在匹配此規則時跳過所有後續規則。

這對於此規則並不是必需的。但是，當我們想立即停止處理請求時，最好明確指定。

現在建立這個規則。

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

點選這個按鈕。

釋出!

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

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

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

如何用 curl 驗證 Lua 模組的輸出

接下來，我們將驗證呼叫 Lua 模組的效果。

在終端上，我們透過 “curl” 命令列工具向此閘道器伺服器傳送 HTTP 請求。

這裡我們傳送一個帶有 URI 引數 value=test1 的請求。請注意 value=test1 URI 引數。

執行命令。我們可以獲得返回的 md5 值。

現在我們更改 URI 引數。請注意 value=test2 URI 引數。

執行它！可以看到返回的 md5 值已更改。

我們還可以在頁面規則開頭呼叫 Lua 模組。

在此處新增 Edgelang 程式碼。

點選 “編輯” 按鈕。

在編輯框中編寫 Edgelang 程式碼。

這跟我們剛才新加的頁面規則效果一樣。

關於 OpenResty Edge

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

常見問題

如何在 OpenResty Edge 中建立 Lua 模組？

進入 Admin Web 控制檯，開啟全域性配置 → 全域性 Lua 模組，上傳一個 .lua 檔案或在編輯框中線上編寫。宣告模組表 _M，新增函式（示例中定義了一個計算輸入 md5 值的 calc 函式），並在結尾返回 _M。儲存後，模組會自動分發到每臺閘道器伺服器。

如何透過 Edgelang 呼叫 Lua 模組？

在頁面規則中新增動作並搜尋 “使用 EdgeLang”，然後編寫呼叫模組函式的 Edgelang 程式碼。示例中，規則匹配 URI /test-md5，並把 value URI 引數作為輸入傳給模組。您也可以在頁面規則的最開頭呼叫該模組。

修改 Lua 模組後需要過載或重啟 OpenResty Edge 嗎？

不需要。儲存全域性 Lua 模組會將其分發到每臺閘道器伺服器，釋出新版本會把頁面規則同步到所有閘道器叢集。配置變更無需伺服器過載、重啟或二進位制升級。

可以在頁面規則的開頭呼叫 Lua 模組嗎？

可以。除了在匹配的規則內呼叫外，您還可以新增 Edgelang 程式碼，在頁面規則的最開頭呼叫模組；其效果與上文的專用規則相同。

如果你喜歡這個教程，請訂閱這個部落格網站和我們的 YouTube 頻道 或 B 站頻道。謝謝！

關於作者

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

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

關注我們

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

翻譯

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