← 返回

在 OpenResty 中跨請求共享資料

章亦春釋出於 Dec 1, 2020 更新於 Jul 13, 2026

預計閱讀 5 分鐘

閱讀次數

本教程將逐步演示如何在 OpenResty 應用程式服務的不同 HTTP 請求中共享資料。我們會介紹兩種方法：用於在單個工作程序內共享資料的 Lua 模組級變數，以及用於在所有工作程序間共享資料的 lua_shared_dict。本文是 OpenResty 教程系列的一部分——如果你剛接觸 OpenResty，請先從 Hello World HTTP 示例開始。

搭建專案

cd ~/
mkdir data-share
cd data-share/
mkdir conf logs lua
tree

我們首先準備測試應用程式的目錄樹。

方法一：Lua 模組級變數

在請求之間共享資料的最簡單方法是使用一個名為 lua/my-module.lua 的自定義 Lua 模組。

我們進行以下編輯：

我們在這個模組的頂層增加一個全域性計數器變數。
然後我們總是在一個名為 main 的模組函式中遞增這個計數器。
並返回新的計數器值。

local _M = {}

local counter = 0

function _M.main()
    counter = counter + 1
    return counter
end

return _M

配置 Nginx

現在讓我們快速製作 nginx 配置檔案，conf/nginx.conf。

我們進行以下編輯：

在這裡，我們指定在哪裡尋找我們的 Lua 模組。
然後在本地 8080 埠上定義一個監聽伺服器。
而根位置下有 content_by_lua_block。
載入我們的 Lua 模組並呼叫它的 main 函式。
並將返回的計數器值作為響應體輸出。

worker_processes 1;

events {
    worker_connections 1024;
}

http {
    lua_package_path "$prefix/lua/?.lua;;";

    server {
        listen 8080;

        location / {
            default_type text/plain;
            content_by_lua_block {
                local mod = require "my-module"
                local cnt = mod.main()
                ngx.say("counter = ", cnt)
            }
        }
    }
}

我們再來檢查一下目錄樹。

tree .

看起來不錯。

啟動與測試

在沒有 sudo 的情況下啟動這個 OpenResty 應用程式。

openresty -p $PWD/

在這裡，我們只啟用一個工作程序。

ps aux|grep nginx|grep -v tmp

使用 curl 向伺服器傳送 HTTP 請求。

curl 'http://127.0.0.1:8080/'

計數器的值是 1。

再來一次：

酷，現在是 2。

立即試用 OpenResty XRay，實時分析你正在執行的應用

它只會不斷增長。

工作原理：upvalue 與 LuaJIT 虛擬機器

這個 counter Lua 變數是共享的，因為它是 Lua 模組函式的 upvalue（上值）。

cat lua/my-module.lua

而 Lua 模組在全域性 LuaJIT 虛擬機器中被快取和共享。

resty -Ilua -e 'require "my-module" print(package.loaded["my-module"].main)'

看到了嗎？我們也可以直接訪問快取的 Lua 模組。

package.loaded 全域性表儲存了所有載入的 Lua 模組。

resty -e 'for k, v in pairs(package.loaded) do print(k) end'

在這裡，大部分的模組都是那些標準的模組。

侷限：資料無法跨工作程序共享

這些資料不能在不同的 nginx 工作程序之間共享。

這裡沒有問題，因為只配置了 1 個工作程序。

但通常我們會透過啟用多個工作程序來利用多個 CPU 核心。

worker_processes 4;

那麼每個工作程序都會有自己的計數器。

讓我們測試配置，然後重新載入伺服器。

openresty -p $PWD/ -t
kill -HUP `cat logs/nginx.pid`

現在我們應該有 4 個工作程序。

ps aux|grep nginx|grep -v tmp

如何選擇合適的方案

這兩種共享機制適用於不同的場景：

	Lua 模組變數	`lua_shared_dict`
作用域	單個工作程序	所有工作程序
值型別	任意 Lua 型別	字串、數字、布林值
典型用途	配置快取、單程序 LRU 快取	計數器、限流、共享標誌位
HUP 過載後是否保留	否	是
重啟後是否保留	否	否
原子操作	不適用	支援（`incr`、`add`、`set`）

Lua 模組的方式主要用於 Lua 級別的資料快取。與 OpenResty 一起提供的 resty.lrucache Lua 模組就是為這樣的場景設計的。

restydoc resty.lrucache

我們將在以後的教程中介紹這個模組。

方法二：使用 lua_shared_dict 跨工作程序共享資料

要在所有工作程序間共享一個計數器，需要在 http 塊中用 lua_shared_dict 宣告一塊共享記憶體區域，並透過 ngx.shared.DICT 訪問它（想深入瞭解這些共享記憶體區域在底層是如何佔用記憶體的，請參閱 OpenResty 和 Nginx 共享記憶體區是如何消耗記憶體的）：

http {
    lua_shared_dict my_counter 1m;

    server {
        listen 8080;

        location / {
            default_type text/plain;
            content_by_lua_block {
                local dict = ngx.shared.my_counter
                local newval, err = dict:incr("counter", 1)
                if not newval then
                    dict:add("counter", 0)
                    newval = dict:incr("counter", 1)
                end
                ngx.say("counter = ", newval)
            }
        }
    }
}

無論執行多少個工作程序，這個計數器都能正確地遞增，並且它的值在 HUP 過載後依然保留。完整的 ngx.shared.DICT API——包括過期時間（ttl）、淘汰行為以及列表操作——我們將在專門的教程中介紹。

restydoc -s lua_shared_dict
restydoc -s ngx.shared.DICT

今天我想介紹的就這麼多。祝程式設計愉快！如果你喜歡這個教程，請訂閱這個部落格網站和我們的 YouTube 頻道或 B 站頻道。謝謝！

立即申請 OpenResty XRay 試用

本文是 OpenResty 教程系列的一部分，該系列是一份從安裝到生產可用技巧的循序漸進的指南。接下來請繼續閱讀在 OpenResty 中流式輸出 HTTP 響應。

關於作者

章亦春是開源 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 多個開源軟體庫。