安裝Nginx+Lua+OpenResty開發環境配置全過程實例

OpenResty由Nginx核心加很多第三方模塊組成，默認集成了Lua開發環境，使得Nginx可以作為一個Web Server使用。
借助于Nginx的事件驅動模型和非阻塞IO，可以實現高性能的Web應用程序。
而且OpenResty提供了大量組件如Mysql、Redis、Memcached等等，使在Nginx上開發Web應用更方便更簡單。
目前在京東如實時價格、秒殺、動態服務、單品頁、列表頁等都在使用Nginx+Lua架構，其他公司如淘寶、去哪兒網等。

以下是本人整理的Nginx+Lua架構思維導圖：

一、安裝環境,安裝步驟可以參考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。