第一二章(Nginx+Lua)开发环境

第一章安装OpenResty(Nginx+Lua)开发环境

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

Mac OS X 平台安装

从包管理安装

通过 Homebrew，OpenResty 提供了 OSX 上的官方包。你只需运行下面的命令：

brew install openresty/brew/openresty

如果你之前是从 homebrew/nginx 安装的 OpenResty，请先执行：

brew untap homebrew/nginx

如果一切顺利，OpenResty 应该已经安装好了。接下来，我们就可以进入到后面的章节 HelloWorld 学习。

如果你想了解更多 OpenResty 上的细节，且不介意弄脏双手；抑或有自定义 OpenResty 安装的需求，可以往下看从源码安装的方式。

源码包准备

我们首先要在官网下载OpenResty的源码包。官网上会提供很多的版本，各个版本有什么不同也会有说明，我们可以按需选择下载。笔者选择下载的源码包 ngx_openresty-1.9.7.1.tar.gz。

OpenResty 安装

在命令行中切换到源码包所在目录。
输入命令tar xzvf ngx_openresty-1.9.7.1.tar.gz，按回车键解压源码包。若你下载的源码包版本不一样，将相应的版本号改为你所下载的即可，或者直接拷贝源码包的名字到命令中。此时当前目录下会出现一个ngx_openresty-1.9.7.1文件夹。
在命令行中切换工作目录到ngx_openresty-1.9.7.1。输入命令cd ngx_openresty-1.9.7.1。
配置安装目录及需要激活的组件。使用选项 --prefix=install_path ，指定其安装目录（默认为/usr/local/openresty）。使用选项 --with-Components 激活组件， --without 则是禁止组件，你可以根据自己实际需要选择 with 及 without 。输入如下命令，OpenResty 将配置安装在 /opt/openresty 目录下（注意使用root用户），激活 LuaJIT、HTTP_iconv_module 并禁止 http_redis2_module 组件。
```
./configure --prefix=/opt/openresty\ 
            --with-cc-opt="-I/usr/local/include"\ 
            --with-luajit\ 
            --without-http_redis2_module \ 
            --with-ld-opt="-L/usr/local/lib"
```
在上一步中，最后没有什么error的提示就是最好的。若有错误，最后会显示error字样，具体原因可以看源码包目录下的 build/nginx-VERSION/objs/autoconf.err 文件查看。若没有错误，则会出现如下信息，提示下一步操作：
```
Type the following commands to build and install: 
make sudo 
make install
```
编译。根据上一步命令提示，输入make。
安装。输入sudo make install，这里可能需要输入你的管理员密码。
上面的步骤顺利完成之后，安装已经完成。可以在你指定的安装目录下看到一些相关目录及文件。

设置环境变量

为了后面启动OpenResty的命令简单一些，不用在OpenResty的安装目录下进行启动，我们通过设置环境变量来简化操作。将OpenResty目录下的 nginx/sbin 目录添加到 PATH 中。

2.1 下载并上传tar包（简易源码安装方式）

（1）https://openresty.org/download/openresty-1.15.8.1.tar.gz

openresty-1.15.8.1.tar.gz 4.7MB PGP 变更列表 - 2019年5月16日

（2）ftp将tar包上传到服务器opt下面，软件老王

2.2 安装执行命令

[root@ruanjianlaowang ~]# cd opt/
[root@ruanjianlaowang ~]# tar -zxvf openresty-1.15.8.1.tar.gz
[root@ruanjianlaowang ~]# cd /opt/openresty-1.15.8.1

[root@ruanjianlaowang ~]#./configure --prefix=/opt/openresty --with-luajit --without-http_redis2_module --with-http_iconv_module

[root@ruanjianlaowang ~]# make
[root@ruanjianlaowang ~]# make install 
[root@ruanjianlaowang ~]#rm -rf openresty-1.15.8.1
[root@ruanjianlaowang ~]#rm -rf openresty-1.15.8.1.tar.gz

2.3 启动nginx并测试

[root@ruanjianlaowang ~]#cd /opt/openresty/nginx/sbin
[root@ruanjianlaowang ~]#./nginx

[root@ruanjianlaowang ~]#ps -ef|grep nginx

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，以后我们把所有软件安装在此目录

Java代码

mkdir -p /usr/servers
cd /usr/servers/

2、安装依赖（我的环境是ubuntu，可以使用如下命令安装，其他的可以参考openresty安装步骤）

Java代码

apt-get install libreadline-dev libncurses5-dev libpcre3-dev libssl-dev perl

3、下载ngx_openresty-1.7.7.2.tar.gz并解压

Java代码

wget http://openresty.org/download/ngx_openresty-1.7.7.2.tar.gz
tar -xzvf ngx_openresty-1.7.7.2.tar.gz

ngx_openresty-1.7.7.2/bundle目录里存放着nginx核心和很多第三方模块，比如有我们需要的Lua和LuaJIT。

3、安装LuaJIT

Java代码

cd bundle/LuaJIT-2.1-20150120/
make clean && make && make install
ln -sf luajit-2.1.0-alpha /usr/local/bin/luajit

4、下载ngx_cache_purge模块，该模块用于清理nginx缓存

Java代码

cd /usr/servers/ngx_openresty-1.7.7.2/bundle
wget https://github.com/FRiCKLE/ngx_cache_purge/archive/2.3.tar.gz
tar -xvf 2.3.tar.gz

5、下载nginx_upstream_check_module模块，该模块用于ustream健康检查

Java代码

cd /usr/servers/ngx_openresty-1.7.7.2/bundle
wget https://github.com/yaoweibin/nginx_upstream_check_module/archive/v0.3.0.tar.gz
tar -xvf v0.3.0.tar.gz

6、安装ngx_openresty

Java代码

cd /usr/servers/ngx_openresty-1.7.7.2
./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
make && make install

--with*** 安装一些内置/集成的模块

--with-http_realip_module 取用户真实ip模块

-with-pcre Perl兼容的达式模块

--with-luajit 集成luajit模块

--add-module 添加自定义的第三方模块，如此次的ngx_che_purge

8、到/usr/servers目录下

Java代码

cd /usr/servers/
ll

会发现多出来了如下目录，说明安装成功

/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版本和安装的模块

7、启动nginx

/usr/servers/nginx/sbin/nginx

接下来该配置nginx+lua开发环境了

配置环境

配置及Nginx HttpLuaModule文档在可以查看http://wiki.nginx.org/HttpLuaModule。

1、编辑nginx.conf配置文件

Java代码

vim /usr/servers/nginx/conf/nginx.conf

2、在http部分添加如下配置

Java代码

#lua模块路径，多个之间”;”分隔，其中”;;”表示默认搜索路径，默认到/usr/servers/nginx下找
lua_package_path "/usr/servers/lualib/?.lua;;"; #lua 模块
lua_package_cpath "/usr/servers/lualib/?.so;;"; #c模块

3、为了方便开发我们在/usr/servers/nginx/conf目录下创建一个lua.conf

Java代码

#lua.conf
server {
listen 80;
server_name _;
}

4、在nginx.conf中的http部分添加include lua.conf包含此文件片段

Java代码

include lua.conf;

5、测试是否正常

Java代码

/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

HelloWorld

1、在lua.conf中server部分添加如下配置

Java代码

location /lua {
default_type 'text/html';
content_by_lua 'ngx.say("hello world")';
}

2、测试配置是否正确

Java代码

/usr/servers/nginx/sbin/nginx -t

3、重启nginx

Java代码

/usr/servers/nginx/sbin/nginx -s reload

4、访问如http://192.168.1.6/lua（自己的机器根据实际情况换ip），可以看到如下内容

hello world

5、lua代码文件

我们把lua代码放在nginx配置中会随着lua的代码的增加导致配置文件太长不好维护，因此我们应该把lua代码移到外部文件中存储。

Java代码

vim /usr/servers/nginx/conf/lua/test.lua

Java代码

#添加如下内容
ngx.say("hello world");

然后lua.conf修改为

Java代码

location /lua {
default_type 'text/html';
content_by_lua_file conf/lua/test.lua; #相对于nginx安装目录
}

此处conf/lua/test.lua也可以使用绝对路径/usr/servers/nginx/conf/lua/test.lua。

6、lua_code_cache

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

Java代码

location /lua {
default_type 'text/html';
lua_code_cache off;
content_by_lua_file conf/lua/test.lua;
}

开启后reload nginx会看到如下报警

nginx: [alert] lua_code_cache is off; this will hurt performance in /usr/servers/nginx/conf/lua.conf:8

7、错误日志

如果运行过程中出现错误，请不要忘记查看错误日志。

Java代码

tail -f /usr/servers/nginx/logs/error.log

到此我们的基本环境搭建完毕。

nginx+lua项目构建

以后我们的nginx lua开发文件会越来越多，我们应该把其项目化，已方便开发。项目目录结构如下所示：

example

example.conf ---该项目的nginx 配置文件

lua ---我们自己的lua代码

test.lua

lualib ---lua依赖库/第三方依赖

*.lua

*.so

其中我们把lualib也放到项目中的好处就是以后部署的时候可以一起部署，防止有的服务器忘记复制依赖而造成缺少依赖的情况。

我们将项目放到到/usr/example目录下。

/usr/servers/nginx/conf/nginx.conf配置文件如下(此处我们最小化了配置文件)

Java代码

#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/example/lualib/?.lua;;"; #lua 模块
lua_package_cpath "/usr/example/lualib/?.so;;"; #c模块
include /usr/example/example.conf;
}

通过绝对路径包含我们的lua依赖库和nginx项目配置文件。

/usr/example/example.conf配置文件如下

Java代码

server {
listen 80;
server_name _;
location /lua {
default_type 'text/html';
lua_code_cache off;
content_by_lua_file /usr/example/lua/test.lua;
}
}

lua文件我们使用绝对路径/usr/example/lua/test.lua。

第二章 OpenResty(Nginx+Lua)开发入门

Nginx入门

本文目的是学习Nginx+Lua开发，对于Nginx基本知识可以参考如下文章：

nginx启动、关闭、重启

http://www.cnblogs.com/derekchen/archive/2011/02/17/1957209.html

agentzh 的 Nginx 教程

http://openresty.org/download/agentzh-nginx-tutorials-zhcn.html

Nginx+Lua入门

http://17173ops.com/2013/11/01/17173-ngx-lua-manual.shtml

nginx 配置指令的执行顺序

http://zhongfox.github.io/blog/server/2013/05/15/nginx-exec-order/

nginx与lua的执行顺序和步骤说明

http://www.mrhaoting.com/?p=157

Nginx配置文件nginx.conf中文详解

http://www.ha97.com/5194.html

Tengine的Nginx开发从入门到精通

http://tengine.taobao.org/book/

官方文档

http://wiki.nginx.org/Configuration

Lua入门

本文目的是学习Nginx+Lua开发，对于Lua基本知识可以参考如下文章：

Lua简明教程

http://coolshell.cn/articles/10739.html

lua在线lua学习教程

http://book.luaer.cn/

Lua 5.1 参考手册

http://www.codingnow.com/2000/download/lua_manual.html

Lua5.3 参考手册

http://cloudwu.github.io/lua53doc/

Nginx Lua API

和一般的Web Server类似，我们需要接收请求、处理并输出响应。而对于请求我们需要获取如请求参数、请求头、Body体等信息；而对于处理就是调用相应的Lua代码即可；输出响应需要进行响应状态码、响应头和响应内容体的输出。因此我们从如上几个点出发即可。

接收请求

1、example.conf配置文件

Java代码

location ~ /lua_request/(\d+)/(\d+) {
#设置nginx变量
set $a $1;
set $b $host;
default_type "text/html";
#nginx内容处理
content_by_lua_file /usr/example/lua/test_request.lua;
#内容体处理完成后调用
echo_after_body "ngx.var.b $b";
}

2、test_request.lua

Java代码

--nginx变量
local var = ngx.var
ngx.say("ngx.var.a : ", var.a, " ")
ngx.say("ngx.var.b : ", var.b, " ")
ngx.say("ngx.var[2] : ", var[2], " ")
ngx.var.b = 2;
ngx.say(" ")
--请求头
local headers = ngx.req.get_headers()
ngx.say("headers begin", " ")
ngx.say("Host : ", headers["Host"], " ")
ngx.say("user-agent : ", headers["user-agent"], " ")
ngx.say("user-agent : ", headers.user_agent, " ")
for k,v in pairs(headers) do
if type(v) == "table" then
ngx.say(k, " : ", table.concat(v, ","), " ")
else
ngx.say(k, " : ", v, " ")
end
end
ngx.say("headers end", " ")
ngx.say(" ")
--get请求uri参数
ngx.say("uri args begin", " ")
local uri_args = ngx.req.get_uri_args()
for k, v in pairs(uri_args) do
if type(v) == "table" then
ngx.say(k, " : ", table.concat(v, ", "), " ")
else
ngx.say(k, ": ", v, " ")
end
end
ngx.say("uri args end", " ")
ngx.say(" ")
--post请求参数
ngx.req.read_body()
ngx.say("post args begin", " ")
local post_args = ngx.req.get_post_args()
for k, v in pairs(post_args) do
if type(v) == "table" then
ngx.say(k, " : ", table.concat(v, ", "), " ")
else
ngx.say(k, ": ", v, " ")
end
end
ngx.say("post args end", " ")
ngx.say(" ")
--请求的http协议版本
ngx.say("ngx.req.http_version : ", ngx.req.http_version(), " ")
--请求方法
ngx.say("ngx.req.get_method : ", ngx.req.get_method(), " ")
--原始的请求头内容
ngx.say("ngx.req.raw_header : ", ngx.req.raw_header(), " ")
--请求的body内容体
ngx.say("ngx.req.get_body_data() : ", ngx.req.get_body_data(), " ")
ngx.say(" ")

ngx.var ： nginx变量，如果要赋值如ngx.var.b = 2，此变量必须提前声明；另外对于nginx location中使用正则捕获的捕获组可以使用ngx.var[捕获组数字]获取；

ngx.req.get_headers：获取请求头，默认只获取前100，如果想要获取所以可以调用ngx.req.get_headers(0)；获取带中划线的请求头时请使用如headers.user_agent这种方式；如果一个请求头有多个值，则返回的是table；

ngx.req.get_uri_args：获取url请求参数，其用法和get_headers类似；

ngx.req.get_post_args：获取post请求内容体，其用法和get_headers类似，但是必须提前调用ngx.req.read_body()来读取body体（也可以选择在nginx配置文件使用lua_need_request_body on;开启读取body体，但是官方不推荐）；

ngx.req.raw_header：未解析的请求头字符串；

ngx.req.get_body_data：为解析的请求body体内容字符串。

如上方法处理一般的请求基本够用了。另外在读取post内容体时根据实际情况设置client_body_buffer_size和client_max_body_size来保证内容在内存而不是在文件中。

使用如下脚本测试

Java代码

wget --post-data 'a=1&b=2' 'http://127.0.0.1/lua_request/1/2?a=3&b=4' -O -

输出响应

1.1、example.conf配置文件

Java代码

location /lua_response_1 {
default_type "text/html";
content_by_lua_file /usr/example/lua/test_response_1.lua;
}

1.2、test_response_1.lua

Java代码

--写响应头
ngx.header.a = "1"
--多个响应头可以使用table
ngx.header.b = {"2", "3"}
--输出响应
ngx.say("a", "b", " ")
ngx.print("c", "d", " ")
--200状态码退出
return ngx.exit(200)

ngx.header：输出响应头；

ngx.print：输出响应内容体；

ngx.say：通ngx.print，但是会最后输出一个换行符；

ngx.exit：指定状态码退出。

2.1、example.conf配置文件

Java代码

location /lua_response_2 {
default_type "text/html";
content_by_lua_file /usr/example/lua/test_response_2.lua;
}

2.2、test_response_2.lua

Java代码

ngx.redirect("http://jd.com", 302)

ngx.redirect：重定向；

ngx.status=状态码，设置响应的状态码；ngx.resp.get_headers()获取设置的响应状态码；ngx.send_headers()发送响应状态码，当调用ngx.say/ngx.print时自动发送响应状态码；可以通过ngx.headers_sent=true判断是否发送了响应状态码。

其他API

1、example.conf配置文件

Java代码

location /lua_other {
default_type "text/html";
content_by_lua_file /usr/example/lua/test_other.lua;
}

2、test_other.lua

Java代码

--未经解码的请求uri
local request_uri = ngx.var.request_uri;
ngx.say("request_uri : ", request_uri, " ");
--解码
ngx.say("decode request_uri : ", ngx.unescape_uri(request_uri), " ");
--MD5
ngx.say("ngx.md5 : ", ngx.md5("123"), " ")
--http time
ngx.say("ngx.http_time : ", ngx.http_time(ngx.time()), " ")

ngx.escape_uri/ngx.unescape_uri ： uri编码解码；

ngx.encode_args/ngx.decode_args：参数编码解码；

ngx.encode_base64/ngx.decode_base64：BASE64编码解码；

ngx.re.match：nginx正则表达式匹配；

更多Nginx Lua API请参考 http://wiki.nginx.org/HttpLuaModule#Nginx_API_for_Lua。

Nginx全局内存

使用过如Java的朋友可能知道如Ehcache等这种进程内本地缓存，Nginx是一个Master进程多个Worker进程的工作方式，因此我们可能需要在多个Worker进程中共享数据，那么此时就可以使用ngx.shared.DICT来实现全局内存共享。

1、首先在nginx.conf的http部分分配内存大小

Java代码

#共享全局变量，在所有worker间共享
lua_shared_dict shared_data 1m;

2、example.conf配置文件

Java代码

location /lua_shared_dict {
default_type "text/html";
content_by_lua_file /usr/example/lua/test_lua_shared_dict.lua;
}

3、 test_lua_shared_dict.lua

Java代码

--1、获取全局共享内存变量
local shared_data = ngx.shared.shared_data
--2、获取字典值
local i = shared_data:get("i")
if not i then
i = 1
--3、惰性赋值
shared_data:set("i", i)
ngx.say("lazy set i ", i, " ")
end
--递增
i = shared_data:incr("i", 1)
ngx.say("i=", i, " ")

到此基本的Nginx Lua API就学完了，对于请求处理和输出响应如上介绍的API完全够用了，更多API请参考官方文档。

Nginx Lua模块指令

Nginx共11个处理阶段，而相应的处理阶段是可以做插入式处理，即可插拔式架构；另外指令可以在http、server、server if、location、location if几个范围进行配置：

指令	所处处理阶段	使用范围	解释
init_by_lua init_by_lua_file	loading-config	http	nginx Master进程加载配置时执行；通常用于初始化全局配置/预加载Lua模块
init_worker_by_lua init_worker_by_lua_file	starting-worker	http	每个Nginx Worker进程启动时调用的计时器，如果Master进程不允许则只会在init_by_lua之后调用；通常用于定时拉取配置/数据，或者后端服务的健康检查
set_by_lua set_by_lua_file	rewrite	server,server if,location,location if	设置nginx变量，可以实现复杂的赋值逻辑；此处是阻塞的，Lua代码要做到非常快；
rewrite_by_lua rewrite_by_lua_file	rewrite tail	http,server,location,location if	rrewrite阶段处理，可以实现复杂的转发/重定向逻辑；
access_by_lua access_by_lua_file	access tail	http,server,location,location if	请求访问阶段处理，用于访问控制
content_by_lua content_by_lua_file	content	location，location if	内容处理器，接收请求处理并输出响应
header_filter_by_lua header_filter_by_lua_file	output-header-filter	http，server，location，location if	设置header和cookie
body_filter_by_lua body_filter_by_lua_file	output-body-filter	http，server，location，location if	对响应数据进行过滤，比如截断、替换。
log_by_lua log_by_lua_file	log	http，server，location，location if	log阶段处理，比如记录访问量/统计平均响应时间

更详细的解释请参考http://wiki.nginx.org/HttpLuaModule#Directives。如上指令很多并不常用，因此我们只拿其中的一部分做演示。

init_by_lua

每次Nginx重新加载配置时执行，可以用它来完成一些耗时模块的加载，或者初始化一些全局配置；在Master进程创建Worker进程时，此指令中加载的全局变量会进行Copy-OnWrite，即会复制到所有全局变量到Worker进程。

1、nginx.conf配置文件中的http部分添加如下代码

Java代码

#共享全局变量，在所有worker间共享
lua_shared_dict shared_data 1m;
init_by_lua_file /usr/example/lua/init.lua;

2、init.lua

Java代码

--初始化耗时的模块
local redis = require 'resty.redis'
local cjson = require 'cjson'
--全局变量，不推荐
count = 1
--共享全局内存
local shared_data = ngx.shared.shared_data
shared_data:set("count", 1)

3、test.lua

Java代码

count = count + 1
ngx.say("global variable : ", count)
local shared_data = ngx.shared.shared_data
ngx.say(", shared memory : ", shared_data:get("count"))
shared_data:incr("count", 1)
ngx.say("hello world")

4、访问如http://192.168.1.2/lua 会发现全局变量一直不变，而共享内存一直递增

global variable : 2 , shared memory : 8 hello world

另外注意一定在生产环境开启lua_code_cache，否则每个请求都会创建Lua VM实例。

init_worker_by_lua

用于启动一些定时任务，比如心跳检查，定时拉取服务器配置等等；此处的任务是跟Worker进程数量有关系的，比如有2个Worker进程那么就会启动两个完全一样的定时任务。

1、nginx.conf配置文件中的http部分添加如下代码

Java代码

init_worker_by_lua_file /usr/example/lua/init_worker.lua;

2、init_worker.lua

Java代码

local count = 0
local delayInSeconds = 3
local heartbeatCheck = nil
heartbeatCheck = function(args)
count = count + 1
ngx.log(ngx.ERR, "do check ", count)
local ok, err = ngx.timer.at(delayInSeconds, heartbeatCheck)
if not ok then
ngx.log(ngx.ERR, "failed to startup heartbeart worker...", err)
end
end
heartbeatCheck()

ngx.timer.at：延时调用相应的回调方法；ngx.timer.at(秒单位延时，回调函数，回调函数的参数列表)；可以将延时设置为0即得到一个立即执行的任务，任务不会在当前请求中执行不会阻塞当前请求，而是在一个轻量级线程中执行。

另外根据实际情况设置如下指令

lua_max_pending_timers 1024; #最大等待任务数

lua_max_running_timers 256; #最大同时运行任务数

set_by_lua

设置nginx变量，我们用的set指令即使配合if指令也很难实现负责的赋值逻辑；

1.1、example.conf配置文件

Java代码

location /lua_set_1 {
default_type "text/html";
set_by_lua_file $num /usr/example/lua/test_set_1.lua;
echo $num;
}

set_by_lua_file：语法set_by_lua_file $var lua_file arg1 arg2...; 在lua代码中可以实现所有复杂的逻辑，但是要执行速度很快，不要阻塞；

1.2、test_set_1.lua

Java代码

local uri_args = ngx.req.get_uri_args()
local i = uri_args["i"] or 0
local j = uri_args["j"] or 0
return i + j

得到请求参数进行相加然后返回。

访问如http://192.168.1.2/lua_set_1?i=1&j=10进行测试。如果我们用纯set指令是无法实现的。

再举个实际例子，我们实际工作时经常涉及到网站改版，有时候需要新老并存，或者切一部分流量到新版

2.1、首先在example.conf中使用map指令来映射host到指定nginx变量，方便我们测试

Java代码

############ 测试时使用的动态请求
map $host $item_dynamic {
default "0";
item2014.jd.com "1";
}

如绑定hosts

192.168.1.2 item.jd.com;

192.168.1.2 item2014.jd.com;

此时我们想访问item2014.jd.com时访问新版，那么我们可以简单的使用如

Java代码

if ($item_dynamic = "1") {
proxy_pass http://new;
}
proxy_pass http://old;

但是我们想把商品编号为为8位(比如品类为图书的)没有改版完成，需要按照相应规则跳转到老版，但是其他的到新版；虽然使用if指令能实现，但是比较麻烦，基本需要这样

Java代码

set jump "0";
if($item_dynamic = "1") {
set $jump "1";
}
if(uri ~ "^/6[0-9]{7}.html") {
set $jump "${jump}2";
}
#非强制访问新版，且访问指定范围的商品
if (jump == "02") {
proxy_pass http://old;
}
proxy_pass http://new;

以上规则还是比较简单的，如果涉及到更复杂的多重if/else或嵌套if/else实现起来就更痛苦了，可能需要到后端去做了；此时我们就可以借助lua了：

Java代码

set_by_lua $to_book '
local ngx_match = ngx.re.match
local var = ngx.var
local skuId = var.skuId
local r = var.item_dynamic ~= "1" and ngx.re.match(skuId, "^[0-9]{8}$")
if r then return "1" else return "0" end;
';
set_by_lua $to_mvd '
local ngx_match = ngx.re.match
local var = ngx.var
local skuId = var.skuId
local r = var.item_dynamic ~= "1" and ngx.re.match(skuId, "^[0-9]{9}$")
if r then return "1" else return "0" end;
';
#自营图书
if ($to_book) {
proxy_pass http://127.0.0.1/old_book/$skuId.html;
}
#自营音像
if ($to_mvd) {
proxy_pass http://127.0.0.1/old_mvd/$skuId.html;
}
#默认
proxy_pass http://127.0.0.1/proxy/$skuId.html;

rewrite_by_lua

执行内部URL重写或者外部重定向，典型的如伪静态化的URL重写。其默认执行在rewrite处理阶段的最后。

1.1、example.conf配置文件

Java代码

location /lua_rewrite_1 {
default_type "text/html";
rewrite_by_lua_file /usr/example/lua/test_rewrite_1.lua;
echo "no rewrite";
}

1.2、test_rewrite_1.lua

Java代码

if ngx.req.get_uri_args()["jump"] == "1" then
return ngx.redirect("http://www.jd.com?jump=1", 302)
end

当我们请求http://192.168.1.2/lua_rewrite_1时发现没有跳转，而请求http://192.168.1.2/lua_rewrite_1?jump=1时发现跳转到京东首页了。此处需要301/302跳转根据自己需求定义。

2.1、example.conf配置文件

Java代码

location /lua_rewrite_2 {
default_type "text/html";
rewrite_by_lua_file /usr/example/lua/test_rewrite_2.lua;
echo "rewrite2 uri : $uri, a : $arg_a";
}

2.2、test_rewrite_2.lua

Java代码

if ngx.req.get_uri_args()["jump"] == "1" then
ngx.req.set_uri("/lua_rewrite_3", false);
ngx.req.set_uri("/lua_rewrite_4", false);
ngx.req.set_uri_args({a = 1, b = 2});
end

ngx.req.set_uri(uri, false)：可以内部重写uri（可以带参数），等价于 rewrite ^ /lua_rewrite_3；通过配合if/else可以实现 rewrite ^ /lua_rewrite_3 break；这种功能；此处两者都是location内部url重写，不会重新发起新的location匹配；

ngx.req.set_uri_args：重写请求参数，可以是字符串(a=1&b=2)也可以是table；

访问如http://192.168.1.2/lua_rewrite_2?jump=0时得到响应

rewrite2 uri : /lua_rewrite_2, a :

访问如http://192.168.1.2/lua_rewrite_2?jump=1时得到响应

rewrite2 uri : /lua_rewrite_4, a : 1

3.1、example.conf配置文件

Java代码

location /lua_rewrite_3 {
default_type "text/html";
rewrite_by_lua_file /usr/example/lua/test_rewrite_3.lua;
echo "rewrite3 uri : $uri";
}

3.2、test_rewrite_3.lua

Java代码

if ngx.req.get_uri_args()["jump"] == "1" then
ngx.req.set_uri("/lua_rewrite_4", true);
ngx.log(ngx.ERR, "=========")
ngx.req.set_uri_args({a = 1, b = 2});
end

ngx.req.set_uri(uri, true)：可以内部重写uri，即会发起新的匹配location请求，等价于 rewrite ^ /lua_rewrite_4 last；此处看error log是看不到我们记录的log。

所以请求如http://192.168.1.2/lua_rewrite_3?jump=1会到新的location中得到响应，此处没有/lua_rewrite_4，所以匹配到/lua请求，得到类似如下的响应

global variable : 2 , shared memory : 1 hello world

即

rewrite ^ /lua_rewrite_3; 等价于 ngx.req.set_uri("/lua_rewrite_3", false);

rewrite ^ /lua_rewrite_3 break; 等价于 ngx.req.set_uri("/lua_rewrite_3", false); 加 if/else判断/break/return

rewrite ^ /lua_rewrite_4 last; 等价于 ngx.req.set_uri("/lua_rewrite_4", true);

注意，在使用rewrite_by_lua时，开启rewrite_log on;后也看不到相应的rewrite log。

access_by_lua

用于访问控制，比如我们只允许内网ip访问，可以使用如下形式

Java代码

allow 127.0.0.1;
allow 10.0.0.0/8;
allow 192.168.0.0/16;
allow 172.16.0.0/12;
deny all;

1.1、example.conf配置文件

Java代码

location /lua_access {
default_type "text/html";
access_by_lua_file /usr/example/lua/test_access.lua;
echo "access";
}

1.2、test_access.lua

Java代码

if ngx.req.get_uri_args()["token"] ~= "123" then
return ngx.exit(403)
end

即如果访问如http://192.168.1.2/lua_access?token=234将得到403 Forbidden的响应。这样我们可以根据如cookie/用户token来决定是否有访问权限。

content_by_lua

此指令之前已经用过了，此处就不讲解了。

posted @ 2022-02-16 14:44 hanease 阅读(678) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

hanease

第一二章(Nginx+Lua)开发环境

第一章安装OpenResty(Nginx+Lua)开发环境

Mac OS X 平台安装

从包管理安装

源码包准备

相关库的安装

OpenResty 安装

设置环境变量

2.1 下载并上传tar包（简易源码安装方式）

2.2 安装执行命令

2.3 启动nginx并测试

安装环境

配置环境

HelloWorld

nginx+lua项目构建

第二章 OpenResty(Nginx+Lua)开发入门

Nginx入门

Lua入门

Nginx Lua API

接收请求

Nginx Lua模块指令

init_by_lua

init_worker_by_lua

公告

hanease

第一二章(Nginx+Lua)开发环境

第一章 安装OpenResty(Nginx+Lua)开发环境

Mac OS X 平台安装

从包管理安装

源码包准备

相关库的安装

OpenResty 安装

设置环境变量

2.1 下载并上传tar包（简易源码安装方式）

2.2 安装执行命令

2.3 启动nginx并测试

安装环境

配置环境

HelloWorld

nginx+lua项目构建

第二章 OpenResty(Nginx+Lua)开发入门

Nginx入门

Lua入门

Nginx Lua API

接收请求

Nginx Lua模块指令

init_by_lua

init_worker_by_lua

公告

第一章安装OpenResty(Nginx+Lua)开发环境