本教程将逐步演示如何在 OpenResty 应用程序服务的不同 HTTP 请求中共享数据。

1
2
3
4
5
cd ~/
mkdir data-share
cd data-share/
mkdir conf logs lua
tree

截图 1

我们首先准备测试应用程序的目录树。

在请求之间共享数据的简单方法是使用一个名为 lua/my-module.lua 的自定义 Lua 模块。

我们进行以下编辑:

  1. 我们在这个模块的顶层增加一个全局计数器变量。
  2. 然后我们总是在一个名为 main 的模块函数中递增这个计数器。
  3. 并返回新的计数器值。
1
2
3
4
5
6
7
8
9
10
local _M = {}

local counter = 0

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

return _M

截图 6

现在让我们快速制作 nginx 配置文件,conf/nginx.conf

我们进行以下编辑:

  1. 在这里,我们指定在哪里寻找我们的 Lua 模块。
  2. 然后在本地 8080 端口上定义一个监听服务器。
  3. 而根位置下有 content_by_lua_block
  4. 加载我们的 Lua 模块并调用它的 main 函数。
  5. 并将返回的计数器值作为响应体输出。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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)
}
}
}
}

截图 13

我们再来检查一下目录树。

1
tree .

截图 15

看起来不错。

在没有 sudo 的情况下启动这个 OpenResty 应用程序。

1
openresty -p $PWD/

截图 17

在这里,我们只启用一个工作进程。

1
ps aux|grep nginx|grep -v tmp

截图 18

使用 curl 向服务器发送 HTTP 请求。

1
curl 'http://127.0.0.1:8080/'

截图 19

计数器的值是 1。

再来一次:

截图 21

酷,现在是 2。

它只会不断增长。

截图 23

这个 counter Lua变量是共享的,因为它是 Lua 模块函数的 “up value”(upvalue)。

1
cat lua/my-module.lua

截图 24

而 Lua 模块在全局 LuaJIT 虚拟机中被缓存和共享。

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

截图 25

看到了吗?我们也可以直接访问缓存的 Lua 模块。

package.load全局表保存了所有加载的 Lua 模块。

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

截图 27

在这里,大部分的模块都是那些标准的模块。

但是有一个限制。这些数据不能在不同的 nginx 工作进程之间共享。

截图 29

这里没有问题,因为只配置了 1 个工作进程。

但通常我们会通过启用多个工作进程来利用多个 CPU 核心。

1
worker_processes 4;

截图 31

那么每个工作进程都会有自己的计数器。

让我们测试配置,然后重新加载服务器。

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

截图 33

现在我们应该有 4 个工作进程。

1
ps aux|grep nginx|grep -v tmp

截图 34

所以这种 Lua 模块数据共享的方式主要是用于 Lua 级别的数据缓存。

与 OpenResty 一起提供的 resty.lucache Lua 模块就是为这样的场景设计的。

1
restydoc resty.lrucache

截图 36

我们将在以后的教程中介绍这个模块。

如果我们想在所有工作进程中共享数据,我们应该使用 Lua 共享内存字典来代替。

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

截图 38

我们将在另一个专门的教程中介绍这个话题。

今天我想介绍的就这么多。祝编程愉快! 如果你喜欢这个教程,请订阅这个博客网站和我们的 YouTube 频道B 站频道。谢谢!

关于本文和关联视频

本文和相关联的视频都是完全由我们的 OpenResty Demo 系统从一个极简单的剧本文件自动生成的。

关于作者

章亦春是开源项目 OpenResty® 的创始人,同时也是 OpenResty Inc. 公司的创始人和 CEO。他贡献了许多 Nginx 的第三方模块,相当多 Nginx 和 LuaJIT 核心补丁,并且设计了 OpenResty XRay 等产品。

关注我们

如果您喜欢本文,欢迎关注我们 OpenResty Inc. 公司的博客网站 。也欢迎扫码关注我们的微信公众号:

我们的微信公众号

翻译

我们提供了英文版原文和中译版(本文) 。我们也欢迎读者提供其他语言的翻译版本,只要是全文翻译不带省略,我们都将会考虑采用,非常感谢!