Nginx添加Lua模块

发表于 分类于 本文字数： 4.1k 阅读时长 ≈ 4 分钟

最近在学习如何在Nginx或基于Nginx开发的组件中通过Lua进行定制化的开发，完成自己的需求。一起看看吧😊

安装LuaJIT2

为Nginx添加Lua模块的前提需要安装LuaJIT，这里使用的是openresty的luajit2。

1
2
3
4
$ git clone https://github.com/openresty/luajit2
$ cd luajit2
$ make
$ make install PREFIX=/usr/local/src/LuaJIT

完成后看到如下内容就代表安装成功了😃

1
2
3
==== Successfully built LuaJIT 2.1.0-beta3 ====
......
==== Successfully installed LuaJIT 2.1.0-beta3 to /usr/local ====

此外，需要对环境变量、链接库进行配置:

1
2
3
4
5
$ export LUAJIT_LIB=/usr/local/src/LuaJIT/lib
$ export LUAJIT_INC=/usr/local/src/LuaJIT/include/luajit-2.1

$ source /etc/profile
$ ln -s /usr/local/src/LuaJIT/lib/libluajit-5.1.so.2 /lib64/libluajit-5.1.so.2

注意: 此处使用的是luajit2，并不是luajit，网上很多文章用的是从luajit中下载的LuaJIT-2.0.5.tar.gz，我在用LuaJIT-2.0.5测试过程中，遇到了问题:

nginx: [alert] detected a LuaJIT version which is not OpenResty’s; many optimizations will be disabled and performance will be compromised (see https://github.com/openresty/luajit2 for OpenResty’s LuaJIT or, even better, consider using the OpenResty releases from https://openresty.org/en/download.html)

Nginx Module

准备两个模块:

  • ngx_devel_kit: NDK(nginx development kit)模块是一个拓展nginx服务器核心功能的模块，第三方模块开发可以基于它来快速实现。NDK提供函数和宏处理一些基本任务，减轻第三方模块开发的代码量。
  • lua-nginx-module: 将Lua的功能嵌入到Nginx HTTP服务器中。
1
2
3
4
5
6
$ mkdir ngx_module
$ wget https://github.com/vision5/ngx_devel_kit/archive/v0.3.1.tar.gz
$ tar -xvf v0.3.1.tar.gz

$ wget https://github.com/openresty/lua-nginx-module/archive/v0.10.14.tar.gz
$ tar -xvf v0.10.14.tar.gz

目前lua-nginx-module的最新release版本是v0.10.19，使用该版本在测试过程中遇到报错如下: 

1
2
3
4
5
6
7
8
9
10
11
12
nginx: [alert] failed to load the 'resty.core' module (https://github.com/openresty/lua-resty-core); ensure you are using an OpenResty release from https://openresty.org/en/download.html (reason: module 'resty.core' not found:
	no field package.preload['resty.core']
	no file './resty/core.lua'
	no file '/usr/local/share/luajit-2.1.0-beta3/resty/core.lua'
	no file '/usr/local/share/lua/5.1/resty/core.lua'
	no file '/usr/local/share/lua/5.1/resty/core/init.lua'
	no file './resty/core.so'
	no file '/usr/local/lib/lua/5.1/resty/core.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'
	no file './resty.so'
	no file '/usr/local/lib/lua/5.1/resty.so'
	no file '/usr/local/lib/lua/5.1/loadall.so') in /usr/local/src/nginx/conf/nginx.conf:117

在下面的链接中找到了答案，使用v0.10.14版本即可:

1
https://github.com/openresty/lua-resty-core/issues/248

编译Nginx

1
2
3
4
5
6
7
$ https://nginx.org/download/nginx-1.18.0.tar.gz
$ tar -xvf nginx-1.18.0.tar.gz
$ sudo apt install libpcre3-dev zlib1g-dev libssl-dev
$ cd /usr/local/src/nginx-1.18.0
$ ./configure --prefix=/usr/local/src/nginx --with-http_stub_status_module --with-http_ssl_module --with-http_realip_module --with-http_sub_module --with-http_gzip_static_module --with-http_v2_module --with-pcre --with-ld-opt=-Wl,-rpath,/usr/local/src/LuaJIT/lib --add-module=/usr/local/src/ngx_module/ngx_devel_kit-0.3.1 --add-module=/usr/local/src/ngx_module/lua-nginx-module-0.10.14
$ make
$ make install

访问测试

在nginx.conf中server代码块里加入如下代码: 

1
2
3
location /hello_lua {
    content_by_lua 'ngx.say("hello, lua!")';
}

启动Nginx(此处有需要可以做软链接、系统启动等，我这里只是做测试用): 

1
2
$ /usr/local/src/nginx/sbin
$ ./nginx

通过curl进行测试: 

1
2
$ curl http://127.0.0.1/hello_lua
hello, lua!

动态加载

编译模块

Nginx 1.9.11开始增加了加载动态模块支持，可以通过修改配置文件reload增加、卸载模块。这里测试下动态加载，使用add-dynamic-module选项。

1
2
3
$ ./configure --prefix=/usr/local/src/nginx --with-http_stub_status_module --with-http_ssl_module --with-http_realip_module --with-http_sub_module --with-http_gzip_static_module --with-http_v2_module --with-pcre --with-ld-opt=-Wl,-rpath,/usr/local/src/LuaJIT/lib --add-dynamic-module=/usr/local/src/ngx_module/ngx_devel_kit-0.3.1 --add-dynamic-module=/usr/local/src/ngx_module/lua-nginx-module-0.10.14
$ make
$ make install

编译安装以后，可以看到modules中的so库: 

1
2
3
4
$ ls -lrt modules/
total 4460
-rwxr-xr-x 1 root root  147992 3月   6 15:16 ndk_http_module.so
-rwxr-xr-x 1 root root 4413672 3月   6 15:16 ngx_http_lua_module.so

编辑配置

在nginx.conf文件的main context中增加以下两行: 

1
2
load_module /usr/local/src/nginx/modules/ndk_http_module.so; 
load_module /usr/local/src/nginx/modules/ngx_http_lua_module.so;

并在server块添加访问测试中的测试配置后，启动Nginx，效果一致。

参考

1、http://nginx.org/en/docs/ngx_core_module.html#load_module
2、https://github.com/openresty/lua-nginx-module#building-as-a-dynamic-module