Nginx Lua 模块指令(详解)

init_by_lua

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

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

init_by_lua_file /usr/example/lua/init.lua;  

init.lua

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

test.lua


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")
另外注意一定在生产环境开启 lua_code_cache,否则每个请求都会创建 Lua VM 实例。

语法: lua_code_cache on | off 使用的上下文:http, server, location, location if 作用:lua_code_cache是nginx_lua模块的一条指令。它为 *_by_lua_file(如 set_by_lua_file 和 content_by_lua_file) 这些指令以及Lua模块, 开启或关闭Lua代码缓存. (nginx_lua模块说明:http://wiki.nginx.org/HttpLuaModule#lua_code_cache) 语法: lua_code_cache on | off 使用的上下文:http, server, location, location if 作用:lua_code_cache是nginx_lua模块的一条指令。它为 *_by_lua_file(如 set_by_lua_file 和 content_by_lua_file) 这些指令以及Lua模块, 开启或关闭Lua代码缓存. (nginx_lua模块说明:http://wiki.nginx.org/HttpLuaModule#lua_code_cache) 如果关闭,每个ngx_lua处理的请求将运行在一个独立的Lua VM实例里,0.9.3版本后有效. 所以 set_by_lua_file, content_by_lua_file, access_by_lua_file, 等等指令引用的Lua文件将不再缓存到内存, 并且所有Lua模块每次都会从头重新加载. 这样开发者就可以避免改代码然后重启nginx的操作. 但是, 那些直接写在 nginx.conf 里的代码比如由 set_by_lua, content_by_lua, access_by_lua, and rewrite_by_lua 指定的代码不会在你编辑他们时实时更新,因为只有发送HUP信号通知Nginx才会正确重新加载Nginx的config文件。 即使打开了代码缓存, 那些*_by_lua_file指令里由 dofile 或 loadfile 加载的Lua文件也无法被缓存 (除非你自己手动缓存了他们). 通常你可以用 init_by_lua 或 init_by_lua_file 其中一种指令来加载所有这些无法被缓存的文件, 或把这些文件做成真正的Lua模块并用require加载. 生产环境下千万别关闭Lua代码缓存,只能用在开发模式下,因为对性能有十分大的影响 (每次IO读取和编译Lua代码消耗很大, 简单的hello world都会慢一个数量级)

init_worker_by_lua

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

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

init_worker_by_lua_file /usr/example/lua/init_worker.lua;  
init_worker.lua
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 指令也很难实现负责的赋值逻辑;

example.conf 配置文件

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代码中可以实现所有复杂的逻辑,但是要执行速度很快,不要阻塞;

test_set_1.lua

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 指令是无法实现的。

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

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


############ 测试时使用的动态请求 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 时访问新版,那么我们可以简单的使用如


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

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

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 了:


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 处理阶段的最后

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

if ngx.req.get_uri_args()["jump"] == "1" then return ngx.redirect("http://www.jd.com?jump=1", 302) end
test_rewrite_2.lua
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

test_rewrite_3.lua
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);

access_by_lua

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;  
example.conf 配置文件
location /lua_access {  
default_type "text/html";  
access_by_lua_file /usr/example/lua/test_access.lua;  
echo "access";  
}  
test_access.lua
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 来决定是否有访问权限。

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

参考地址:
https://blog.csdn.net/qinyushuang/article/details/44857995
http://wiki.jikexueyuan.com/project/nginx-lua/introduction.html

Leave a Reply

电子邮件地址不会被公开。 必填项已用*标注