安装Nginx+Lua+OpenResty开发环境配置全过程实例

一时失言乱红尘 2022-06-02 12:25 125阅读 0赞

非常感谢[ https://www.cnblogs.com/zdz8207/p/Nginx-Lua-OpenResty.html][https_www.cnblogs.com_zdz8207_p_Nginx-Lua-OpenResty.html]

OpenResty由Nginx核心加很多第三方模块组成，默认集成了Lua开发环境，使得Nginx可以作为一个Web Server使用。  
借助于Nginx的事件驱动模型和非阻塞IO，可以实现高性能的Web应用程序。  
而且OpenResty提供了大量组件如Mysql、Redis、Memcached等等，使在Nginx上开发Web应用更方便更简单。  
目前在京东如实时价格、秒杀、动态服务、单品页、列表页等都在使用Nginx+Lua架构，其他公司如淘宝、去哪儿网等。

以下是本人整理的Nginx+Lua架构思维导图：

![47685-20160605030224789-905696292.png][]

一、安装环境,安装步骤可以参考[http://openresty.org/\#Installation][http_openresty.org_Installation]

1、创建目录/usr/servers，以后我们把所有软件安装在此目录  
user@user:~$ sudo su  
root@user:/home/user\# mkdir -p /usr/servers  
root@user:/home/user\# cd /usr/servers/

2、安装依赖（我的环境是ubuntu，可以使用如下命令安装，其他的可以参考openresty安装步骤）  
root@user:/usr/servers\# apt-get install libreadline-dev libncurses5-dev libpcre3-dev libssl-dev perl   
root@user:/usr/servers\# apt-get install make

3、下载ngx\_openresty-xxx.tar.gz并解压(ngx\_openresty-xxx/bundle目录里存放着nginx核心和很多第三方模块，比如有我们需要的Lua和LuaJIT。)  
root@user:/usr/servers\# wget https://openresty.org/download/ngx\_openresty-1.9.7.1.tar.gz  
root@user:/usr/servers\# tar xvf ngx\_openresty-1.9.7.1.tar.gz  
root@user:/usr/servers\# cd ngx\_openresty-1.9.7.1

4、安装LuaJIT  
root@user:/usr/servers/ngx\_openresty-1.9.7.1\# cd bundle/LuaJIT-2.1-20151219/  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle/LuaJIT-2.1-20151219\# make clean && make && make install  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle/LuaJIT-2.1-20151219\# ln -sf luajit-2.1.0-alpha /usr/local/bin/luajit

5、下载ngx\_cache\_purge模块，该模块用于清理nginx缓存  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle\# wget https://github.com/FRiCKLE/ngx\_cache\_purge/archive/2.3.tar.gz  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle\# tar -xvf 2.3.tar.gz

6、下载nginx\_upstream\_check\_module模块，该模块用于ustream健康检查  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle\# wget https://github.com/yaoweibin/nginx\_upstream\_check\_module/archive/v0.3.0.tar.gz  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle\# tar -xvf v0.3.0.tar.gz

7、安装ngx\_openresty  
root@user:/usr/servers/ngx\_openresty-1.9.7.1/bundle\# cd ..   
root@user:/usr/servers/ngx\_openresty-1.9.7.1\# ./configure --prefix=/usr/servers --with-http\_realip\_module --with-pcre --with-luajit --add-module=./bundle/ngx\_cache\_purge-2.3/ --add-module=./bundle/nginx\_upstream\_check\_module-0.3.0/ -j2   
root@user:/usr/servers/ngx\_openresty-1.9.7.1\# make && make install  
参数说明：  
\--with\*\*\* 安装一些内置/集成的模块  
\--with-http\_realip\_module 取用户真实ip模块  
\-with-pcre Perl兼容的达式模块  
\--with-luajit 集成luajit模块  
\--add-module 添加自定义的第三方模块，如此次的ngx\_che\_purge

8、到/usr/servers目录下用ll命令查看，会发现多出来了如下目录，说明安装成功  
root@user:/usr/servers/ngx\_openresty-1.9.7.1\# cd /usr/servers/   
root@user:/usr/servers\# ll  
total 3496  
drwxr-xr-x 7 root root 4096 Jan 11 18:09 ./  
drwxr-xr-x 11 root root 4096 Jan 11 17:14 ../  
drwxr-xr-x 2 root root 4096 Jan 11 18:09 bin/  
drwxr-xr-x 6 root root 4096 Jan 11 18:09 luajit/  
drwxr-xr-x 5 root root 4096 Jan 11 18:09 lualib/  
drwxr-xr-x 6 root root 4096 Jan 11 18:09 nginx/  
drwxrwxr-x 5 user user 4096 Jan 11 18:08 ngx\_openresty-1.9.7.1/  
\-rw-r--r-- 1 root root 3548444 Jan 1 06:15 ngx\_openresty-1.9.7.1.tar.gz  
root@user:/usr/servers\#   
说明：  
/usr/servers/luajit ：luajit环境，luajit类似于java的jit，即即时编译，lua是一种解释语言，通过luajit可以即时编译lua代码到机器代码，得到很好的性能；  
/usr/servers/lualib：要使用的lua库，里边提供了一些默认的lua库，如redis，json库等，也可以把一些自己开发的或第三方的放在这；  
/usr/servers/nginx ：安装的nginx，通过/usr/servers/nginx/sbin/nginx -V 查看nginx版本和安装的模块  
root@user:/usr/servers\# /usr/servers/nginx/sbin/nginx -V  
nginx version: openresty/1.9.7.1  
built by gcc 4.6.3 (Ubuntu/Linaro 4.6.3-1ubuntu5)   
built with OpenSSL 1.0.1 14 Mar 2012  
TLS SNI support enabled  
configure arguments: --prefix=/usr/servers/nginx --with-cc-opt=-O2 --add-module=../ngx\_devel\_kit-0.2.19 --add-module=../echo-nginx-module-0.58 --add-module=../xss-nginx-module-0.05 --add-module=../ngx\_coolkit-0.2rc3 --add-module=../set-misc-nginx-module-0.29 --add-module=../form-input-nginx-module-0.11 --add-module=../encrypted-session-nginx-module-0.04 --add-module=../srcache-nginx-module-0.30 --add-module=../ngx\_lua-0.9.20 --add-module=../ngx\_lua\_upstream-0.04 --add-module=../headers-more-nginx-module-0.29 --add-module=../array-var-nginx-module-0.04 --add-module=../memc-nginx-module-0.16 --add-module=../redis2-nginx-module-0.12 --add-module=../redis-nginx-module-0.3.7 --add-module=../rds-json-nginx-module-0.14 --add-module=../rds-csv-nginx-module-0.07 --with-ld-opt=-Wl,-rpath,/usr/servers/luajit/lib --with-http\_realip\_module --with-pcre --add-module=/usr/servers/ngx\_openresty-1.9.7.1/bundle/ngx\_cache\_purge-2.3 --add-module=/usr/servers/ngx\_openresty-1.9.7.1/bundle/nginx\_upstream\_check\_module-0.3.0 --with-http\_ssl\_module  
root@user:/usr/servers\#

7、启动nginx  
root@user:/usr/servers\# /usr/servers/nginx/sbin/nginx  
检测配置是否正确（需要先切换到root用户）：  
root@user:/usr/servers\# /usr/servers/nginx/sbin/nginx -t  
重启nginx：  
root@user:/usr/servers\# /usr/servers/nginx/sbin/nginx -s reload

\--------------------------------------  
二、配置nginx+lua开发环境  
配置及Nginx HttpLuaModule文档在可以查看http://wiki.nginx.org/HttpLuaModule

1、为了方便开发我们在/usr/servers/nginx/conf目录下创建一个lua.conf   
root@user:/home/user\# cd /usr/servers/nginx/conf  
root@user:/usr/servers/nginx/conf\# vim lua.conf  
server \{   
listen 80;   
server\_name \_;  
\#HelloWorld  
location /lua \{   
default\_type 'text/html';   
content\_by\_lua 'ngx.say("hello world")';   
\}  
\}

2、编辑nginx.conf配置文件   
vim /usr/servers/nginx/conf/nginx.conf   
在http部分添加如下配置   
lua\_package\_path "/usr/servers/lualib/?.lua;;"; \#lua 模块   
lua\_package\_cpath "/usr/servers/lualib/?.so;;"; \#c模块   
include lua.conf; \#单独lua配置

\#lua模块路径，多个之间”;”分隔，其中”;;”表示默认搜索路径，默认到/usr/servers/nginx下找  
例如：  
http \{  
include mime.types;  
default\_type application/octet-stream;  
//.....  
lua\_package\_path "/usr/servers/lualib/?.lua;;";  
lua\_package\_cpath "/usr/servers/lualib/?.so;;";  
include lua.conf;  
\}

3、测试是否正常  
root@user:/usr/servers/nginx/conf\# /usr/servers/nginx/sbin/nginx -t   
如果显示如下内容说明配置成功  
nginx: the configuration file /usr/servers/nginx/conf/nginx.conf syntax is ok  
nginx: configuration file /usr/servers/nginx/conf/nginx.conf test is successful

4、重启nginx  
/usr/servers/nginx/sbin/nginx -s reload

5、访问如http://10.0.2.81/lua（自己的机器根据实际情况换ip），可以看到如下内容   
hello world  
说明配置成功。

\--------------------------------------  
三、lua代码文件和缓存  
1、lua\_code\_cache   
默认情况下lua\_code\_cache 是开启的，即缓存lua代码，即每次lua代码变更必须reload nginx才生效，  
如果在开发阶段可以通过lua\_code\_cache off;关闭缓存，这样调试时每次修改lua代码不需要reload nginx；但是正式环境一定记得开启缓存。

2、lua代码文件  
我们把lua代码放在nginx配置中会随着lua的代码的增加导致配置文件太长不好维护，因此我们应该把lua代码移到外部文件中存储。   
root@user:/home/user\# cd /usr/servers/  
root@user:/usr/servers\# mkdir lua  
root@user:/usr/servers\# cd lua  
root@user:/usr/servers\# vim test.lua   
\#添加如下内容   
ngx.say("hello world by lua!");

然后lua.conf修改为：  
location /lua \{   
default\_type 'text/html';  
lua\_code\_cache off;  
content\_by\_lua\_file /usr/servers/lua/test.lua;   
\}

3、重启nginx  
/usr/servers/nginx/sbin/nginx -s reload   
关闭缓存后会看到如下报警（忽略不管）  
nginx: \[alert\] lua\_code\_cache is off; this will hurt performance in /usr/servers/nginx/conf/lua.conf:7

4、再次访问如http://10.0.2.81/lua（自己的机器根据实际情况换ip），可以看到如下内容：  
hello world by lua!

5、错误日志  
如果运行过程中出现错误，请不要忘记查看错误日志。  
tail -f /usr/servers/nginx/logs/error.log

到此nginx+lua基本环境搭建完毕。

\--------------------------------------  
四、nginx+lua项目构建

把nginx lua开发文件其项目化方便开发。项目目录结构如下所示：  
servers  
lua.conf ---该项目的nginx 配置文件  
lua ---我们自己的lua代码  
test.lua  
lualib ---lua依赖库/第三方依赖  
\*.lua  
\*.so  
其中把lualib放到项目中以后可以一起部署，防止有的服务器忘记复制依赖而造成缺少依赖的情况。

将项目放到/usr/servers/目录下。  
/usr/servers/nginx/conf/nginx.conf配置文件如下(此处我们最小化了配置文件)  
\#user nobody;   
worker\_processes 2;   
error\_log logs/error.log;   
events \{  
worker\_connections 1024;   
\}  
http \{  
include mime.types;   
default\_type text/html;

\#lua模块路径，其中”;;”表示默认搜索路径，默认到/usr/servers/nginx下找   
lua\_package\_path "/usr/servers/lualib/?.lua;;"; \#lua 模块   
lua\_package\_cpath "/usr/servers/lualib/?.so;;"; \#c模块   
include /usr/servers/lua.conf;   
\}   
通过绝对路径包含我们的lua依赖库和nginx项目配置文件。  
  
/usr/servers/lua.conf配置文件如下（可以直接把上面配置的文件移动过来，root@user:/usr/servers/nginx/conf\# mv lua.conf /usr/servers/）  
server \{   
listen 80;   
server\_name \_;   
  
location /lua \{   
default\_type 'text/html';   
lua\_code\_cache off;   
content\_by\_lua\_file /usr/servers/lua/test.lua;   
\}   
\}   
lua文件我们使用绝对路径/usr/servers/lua/test.lua。

[https_www.cnblogs.com_zdz8207_p_Nginx-Lua-OpenResty.html]: https://www.cnblogs.com/zdz8207/p/Nginx-Lua-OpenResty.html
[47685-20160605030224789-905696292.png]: /images/20220602/6db98c5e6e6c47668bd6f3e529cecec7.png
[http_openresty.org_Installation]: http://openresty.org/#Installation