Nginx 集成 lua 模块扩展功能，以及遇到的一些问题

时间 2021-11-18

一、准备环境

• 一台linux 能系统的服务

• 带上一双灵巧的手和聪明的脑子

二、开始安装软件

文章中使用的服务器环境为 CentOS 7.6阿里云的镜像，nginx 为 yum 安装的1.20.1版本，luajit 这个是lua 的编译器 版本为 2.0.2，lua-nginx-module版本为0.10.15

1. 安装 luajit 选择一个你喜欢的目录 我这选择的是/home，执行以下内容，来编译安装luajit

   wget http://luajit.org/download/LuaJIT-2.0.2.tar.gz
   tar -xzvf LuaJIT-2.0.2.tar.gz
   cd LuaJIT-2.0.2/
   make
   OK        Successfully built LuaJIT
   make[1]: Leaving directory `/home/LuaJIT-2.0.2/src'
   ==== Successfully built LuaJIT 2.0.2 ====
   #出现以上为编译成功
   make install
   ==== Successfully installed LuaJIT 2.0.2 to /usr/local ====
   #出现以上为安装成功
   

   验证是否安装成功，打印出luajit 版本为安装成功

   luajit -v
   LuaJIT 2.0.2 -- Copyright (C) 2005-2013 Mike Pall. http://luajit.org/
   

   配置环境变量，这个环境变量应该是编译nginx 的时候只用一次所以说配置一个临时的就够了。

   #配置临时环境变量
   export LUAJIT_LIB=/usr/local/lib
   export LUAJIT_INC=/usr/local/include/luajit-2.0
   echo ${xxx} #输出刚才配置的变量
   

2. 再次选择一个你喜欢的目录，这次我选择的为 /usr/local/src/，执行以下内容下载lua-nginx-module

   wget https://github.com/openresty/lua-nginx-module/archive/v0.10.15.tar.gz
   tar -zxvf v0.10.15.tar.gz
   

3. 环境基本都准备完毕，现在开始编译nginx，还是要选择一个你喜欢的文件夹，这次我选择的依旧是/home

   #未安装过nginx的可以跳过此代码段
   nginx -V
   nginx version: nginx/1.20.1
   built by gcc 4.8.5 20150623 (Red Hat 4.8.5-44) (GCC)
   #这边会显示nginx的版本信息
   

   #去官网现在nginx的预编译文件，本次使用1.20.1版本
   wget http://nginx.org/download/nginx-1.20.1.tar.gz
   tar -zxvf nginx-1.20.1.tar.gz
   cd nginx-1.20.1/
   #确保当前服务器已经安装gcc等编译c的环境，如果缺少相关依赖需要自行补全，执行
   ./configure --prefix=/usr/share/nginx --add-module=/usr/local/src/lua-nginx-module-0.10.15
   #注意已经安装过nginx预编译版本的小伙伴需要把 --prefix的目录指向你已安装nginx的目录，使用yum安装的小伙伴需要把--prefix的目录指向/usr/share/nginx
   #未安装过的自己指定一个自己喜欢的目录执行
   #--add-module 这个可是设置多个 例如     --add-module=1   --add-module=2  --add-module=3 会同时添加 1，2，3 进入nginx
   #已经安装过的小伙伴到make执行完后一定要停下，否则回影响正在运行的nginx
   make
   #未安装过的小伙伴可以继续执行
   make install
   

   至此未安装过的小伙伴nginx + lua就已经安装完成了，可以直接跳转到下一个小标题，已安装的小伙伴继续往下看。

   #进入当前目录的objs
   cd objs/
   #可以看到当前目录中有一个shell的文件，这个就是我们已经集成好lua后编译的nginx执行程序
   #注意，备份原nginx可执行程序，yum方式安装的nginx在下面的目录，其他方式安装的在nginx的主目录
   cd /usr/sbin 
   cp -p nginx nginx.bak
   #把刚才编译好的可执行文件直接拿过来，直接覆盖当前nginx可执行程序
   mv /home/mginx-1.20.1/objs/nginx ./
   

4. 安装nginx + lua 完成，启动测试

   #启动nginx ，yum方式安装的nginx会自动注册到系统服务管理中，其他方式需要手动注册文件
   systemctl start nginx
   #查看状态
   systemctl status nginx
   #报错
   error while loading shared libraries: libluajit-5.1.so.2: cannot open shared object file: No such file or directory
   #libluajit-5.1.so.2 这个文件找不到。直接给这个文件添加一个软连接
   ln -s /usr/local/lib/libluajit-5.1.so.2 /lib64/
   #重启查看状态
   systemctl restart nginx
   systemctl status nginx 
   #无报错 启动成功
   

5. 关于yum安装的小伙伴留步，yum安装的nginx会将配置文件地址指向/etc/nginx日志会指向/var/log/nginx，编译后的nginx会把配置文件的路径指回安装目录，导致启动失败。只需要执行以下命令把给目录创建软连接就可以恢复使用。

   #注意软连接后面的路径千万不要加/，添加错误后千万不要使用 rm -rf 来删除错误的软连接！！！！！！！！！！！！！！！！！！！！！！！！！
   ln -s /etc/nginx/ /usr/share/nginx/conf
   ln -s /var/log/nginx/ /usr/share/nginx/logs
   

三、开始快乐的使用lua，体验带来的便捷

#在conf目录下的default目录下新建 xxx.conf，注意看自己的nginx.conf，在server中会有一句 include /etc/nginx/default.d/*.conf;在这个目录下的任意.conf文件都会被引用到nginx.conf 的 server 节点下，使用 content_by_lua 引入lua脚本，在后面的以字符串的形式编写。更多指令参考https://www.nginx.com/resources/wiki/modules/lua/#set-by-lua nginx 的wiki。
 location ^~ /test {
     default_type text/plan;
     content_by_lua 'ngx.say("hello word")';
 }

成功打印hello word

image.png

四、总结

nginx + lua 可以直接把nginx的可扩展性拉上了一个不敢想象的层次，你可以使用各种lua的模块来实现一些复杂的功能，使nginx成为一个可以都独当一面的存在。喜欢折腾而且nginx已经运行一段时间的可以使用以上的方法，如果初次接触nginx就有这方面的需求的话建议直接使用OpenResty® - 中文官方站 国人大佬开发的一个基于nginx + lua 的web平台，可以省去折腾的麻烦。