ngx_lua常用变量参数

最近项目接触了Nginx的lua使用，网上查了查资料，这里记录一下。

Nginx与Lua编写脚本的基本构建块是指令。 指令用于指定何时运行用户Lua代码以及如何使用结果。 下面是显示指令执行顺序的图。

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部分添加如下代码

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

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

2、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)

3、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”)

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部分添加如下代码

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

2、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指令也很难实现负责的赋值逻辑；

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

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

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

2.1、首先在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处理阶段的最后。

1.1、example.conf配置文件
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
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配置文件
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
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配置文件
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
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访问，可以使用如下形式

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配置文件
location /lua_access {

default_type “text/html”;

access_by_lua_file /usr/example/lua/test_access.lua;

echo “access”;

}

1.2、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来决定是否有访问权限。

content_by_lua

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

另外在使用PCRE进行正则匹配时需要注意正则的写法，具体规则请参考http://wiki.nginx.org/HttpLuaModule中的Special PCRE Sequences部分。还有其他的注意事项也请阅读官方文档。

#######################################################

#Ngx指令
lua_code_cache on | off;
作用:打开或关闭 Lua 代码缓存，影响以下指令： set_by_lua_file , content_by_lua_file, rewrite_by_lua_file, access_by_lua_file 及强制加载或者reload Lua 模块等.缓存开启时修改LUA代码需要重启nginx,不开启时则不用。开发阶段一般关闭缓存。
作用域：main, server, location, location if

lua_regex_cache_max_entries 1024;
作用：未知（貌似是限定缓存正则表达式处理结果的最大数量）

lua_package_path …/path… ;
作用：设置用lua代码写的扩展库路径。
例：lua_package_path ‘/foo/bar/?.lua;/blah/?.lua;;’;

lua_package_cpath ‘/bar/baz/?.so;/blah/blah/?.so;;’;
作用：设置C扩展的lua库路径。

set_by_lua $var ‘<lua-script>’ [$arg1 $arg2];
set_by_lua_file $var <path-to-lua-script-file> [$arg1 $arg2 …];
作用：设置一个Nginx变量，变量值从lua脚本里运算由return返回，可以实现复杂的赋值逻辑；此处是阻塞的，Lua代码要做到非常快.
另外可以将已有的ngx变量当作参数传进Lua脚本里去，由ngx.arg[1],  ngx.arg[2]等方式访问。
作用域：main, server, location, server if, location if
处理阶段：rewrite

警告自从v0.9.17发行版以来，不鼓励使用此set_by_lua 指令;请改用新的set_by_lua_block指令。

content_by_lua ‘<lua script>’;
content_by_lua_file luafile;
作用域：location, location if
说明：内容处理器，接收请求处理并输出响应，content_by_lua直接在nginx配置文件里编写较短Lua代码后者使用lua文件。

rewrite_by_lua ‘<lua script>’
rewrite_by_lua_file lua_file;
作用域：http, server, location, location if
执行内部URL重写或者外部重定向，典型的如伪静态化的URL重写。其默认执行在rewrite处理阶段的最后.
注意，在使用rewrite_by_lua时，开启rewrite_log on;后也看不到相应的rewrite log。

access_by_lua ‘lua code’;
access_by_lua_file lua_file.lua;
作用：用于访问控制，比如我们只允许内网ip访问，可以使用如下形式。
access_by_lua ‘
if ngx.req.get_uri_args()[“token”] ~= “123” then
return ngx.exit(403)
end ‘;
作用域：http, server, location, location if

header_filter_by_lua ‘lua code’;
header_filter_by_lua_file path_file.lua;
作用：设置header 和 cookie；

lua_need_request_body on|off;
作用：是否读请求体，跟ngx.req.read_body()函数作用类似,但官方不推荐使用此方法。

lua_shared_dict shared_data 10m;
作用：设置一个共享全局变量表，在所有worker进程间共享。在lua脚本中可以如下访问它：
例：local shared_data = ngx.shared.shared_data
10m 不知是什么意思。

init_by_lua ‘lua code’;
init_by_lua_file lua_file.lua;
作用域：http
说明：ginx Master进程加载配置时执行；通常用于初始化全局配置/预加载Lua模块

init_worker_by_lua ‘lua code’;
init_worker_by_lua_file luafile.lua;
作用域：http

说明：每个Nginx Worker进程启动时调用的计时器，如果Master进程不允许则只会在init_by_lua之后调用；通常用于定时拉取配置/数据，或者后端服务的健康检查。

######################################################

方法                             常量
ngx.arg[index]              #ngx指令参数，当这个变量在set_by_lua或者set_by_lua_file内使用的时候是只读的，指的是在配置指令输入的参数.
ngx.var.varname          #读写NGINX变量的值,最好在lua脚本里缓存变量值，避免在当前请求的生命周期内内存的泄漏
如：
location ~ ^/Name/(.+)$ {
set $service “”;
set $path “”;
set_by_lua_block $ret {
ngx.var.service =   “service”
ngx.var.path =   “path”
}
}

ngx.config.ngx_lua_version  #当前ngx_lua模块版本号
ngx.config.nginx_version    #nginx版本
ngx.worker.exiting          #当前worker进程是否正在关闭
ngx.worker.pid              #当前worker进程的PID
ngx.config.nginx_configure  #编译时的./configure命令选项
ngx.config.prefix           #编译时的prefix选项

core constans:              #ngx_lua 核心常量
ngx.OK (0)
ngx.ERROR (-1)
ngx.AGAIN (-2)
ngx.DONE (-4)
ngx.DECLINED (-5)
ngx.nil
http method constans:       #经常在ngx.location.catpure和ngx.location.capture_multi方法中被调用.
ngx.HTTP_GET
ngx.HTTP_HEAD
ngx.HTTP_PUT
ngx.HTTP_POST
ngx.HTTP_DELETE
ngx.HTTP_OPTIONS
ngx.HTTP_MKCOL
ngx.HTTP_COPY
ngx.HTTP_MOVE
ngx.HTTP_PROPFIND
ngx.HTTP_PROPPATCH
ngx.HTTP_LOCK
ngx.HTTP_UNLOCK
ngx.HTTP_PATCH
ngx.HTTP_TRACE
http status constans:       #http请求状态常量
ngx.HTTP_OK (200)
ngx.HTTP_CREATED (201)
ngx.HTTP_SPECIAL_RESPONSE (300)
ngx.HTTP_MOVED_PERMANENTLY (301)
ngx.HTTP_MOVED_TEMPORARILY (302)
ngx.HTTP_SEE_OTHER (303)
ngx.HTTP_NOT_MODIFIED (304)
ngx.HTTP_BAD_REQUEST (400)
ngx.HTTP_UNAUTHORIZED (401)
ngx.HTTP_FORBIDDEN (403)
ngx.HTTP_NOT_FOUND (404)
ngx.HTTP_NOT_ALLOWED (405)
ngx.HTTP_GONE (410)
ngx.HTTP_INTERNAL_SERVER_ERROR (500)
ngx.HTTP_METHOD_NOT_IMPLEMENTED (501)
ngx.HTTP_SERVICE_UNAVAILABLE (503)
ngx.HTTP_GATEWAY_TIMEOUT (504)

Nginx log level constants：      #错误日志级别常量 ,这些参数经常在ngx.log方法中被使用.
ngx.STDERR
ngx.EMERG
ngx.ALERT
ngx.CRIT
ngx.ERR
ngx.WARN
ngx.NOTICE
ngx.INFO
ngx.DEBUG

##################
#API中的方法：
##################
print()                         #与 ngx.print()方法有区别，print() 相当于ngx.log()
ngx.ctx                         #这是一个lua的table，用于保存ngx上下文的变量，在整个请求的生命周期内都有效,详细参考官方
ngx.location.capture()          #发出一个子请求，详细用法参考官方文档。
ngx.location.capture_multi()    #发出多个子请求，详细用法参考官方文档。
ngx.status                      #读或者写当前请求的相应状态. 必须在输出相应头之前被调用.
ngx.header.HEADER               #访问或设置http header头信息，详细参考官方文档。
ngx.req.set_uri()               #设置当前请求的URI,详细参考官方文档
ngx.set_uri_args(args)          #根据args参数重新定义当前请求的URI参数.
ngx.req.get_uri_args()          #返回一个LUA TABLE，包含当前请求的全部的URL参数
ngx.req.get_post_args()         #返回一个LUA TABLE，包括所有当前请求的POST参数
ngx.req.get_headers()           #返回一个包含当前请求头信息的lua table.
ngx.req.set_header()            #设置当前请求头header某字段值.当前请求的子请求不会受到影响.
ngx.req.read_body()             #在不阻塞ngnix其他事件的情况下同步读取客户端的body信息.[详细]
ngx.req.discard_body()          #明确丢弃客户端请求的body
ngx.req.get_body_data()         #以字符串的形式获得客户端的请求body内容
ngx.req.get_body_file()         #当发送文件请求的时候，获得文件的名字
ngx.req.set_body_data()         #设置客户端请求的BODY
ngx.req.set_body_file()         #通过filename来指定当前请求的file data。
ngx.req.clear_header()          #清求某个请求头
ngx.exec(uri,args)              #执行内部跳转，根据uri和请求参数
ngx.redirect(uri, status)       #执行301或者302的重定向。
ngx.send_headers()              #发送指定的响应头
ngx.headers_sent                #判断头部是否发送给客户端ngx.headers_sent=true
ngx.print(str)                  #发送给客户端的响应页面
ngx.say()                       #作用类似ngx.print，不过say方法输出后会换行
ngx.log(log.level,…)          #写入nginx日志
ngx.flush()                     #将缓冲区内容输出到页面（刷新响应）
ngx.exit(http-status)           #结束请求并输出状态码
ngx.eof()                       #明确指定关闭结束输出流
ngx.escape_uri()                #URI编码(本函数对逗号,不编码，而php的urlencode会编码)
ngx.unescape_uri()              #uri解码
ngx.encode_args(table)          #将tabel解析成url参数
ngx.decode_args(uri)            #将参数字符串编码为一个table
ngx.encode_base64(str)          #BASE64编码
ngx.decode_base64(str)          #BASE64解码
ngx.crc32_short(str)            #字符串的crs32_short哈希
ngx.crc32_long(str)             #字符串的crs32_long哈希
ngx.hmac_sha1(str)              #字符串的hmac_sha1哈希
ngx.md5(str)                    #返回16进制MD5
ngx.md5_bin(str)                #返回2进制MD5
ngx.today()                     #返回当前日期yyyy-mm-dd
ngx.time()                      #返回当前时间戳
ngx.now()                       #返回当前时间
ngx.update_time()               #刷新后返回
ngx.localtime()                 #返回 yyyy-mm-dd hh:ii:ss
ngx.utctime()                   #返回yyyy-mm-dd hh:ii:ss格式的utc时间
ngx.cookie_time(sec)            #返回用于COOKIE使用的时间
ngx.http_time(sec)              #返回可用于http header使用的时间
ngx.parse_http_time(str)        #解析HTTP头的时间
ngx.is_subrequest               #是否子请求（值为 true or false）
ngx.re.match(subject,regex,options,ctx)     #ngx正则表达式匹配，详细参考官网
ngx.re.gmatch(subject,regex,opt)            #全局正则匹配
ngx.re.sub(sub,reg,opt)         #匹配和替换（未知）
ngx.re.gsub()                   #未知
ngx.shared.DICT                 #ngx.shared.DICT是一个table 里面存储了所有的全局内存共享变量
ngx.shared.DICT.get
ngx.shared.DICT.get_stale
ngx.shared.DICT.set
ngx.shared.DICT.safe_set
ngx.shared.DICT.add
ngx.shared.DICT.safe_add
ngx.shared.DICT.replace
ngx.shared.DICT.delete
ngx.shared.DICT.incr
ngx.shared.DICT.flush_all
ngx.shared.DICT.flush_expired
ngx.shared.DICT.get_keys
ndk.set_var.DIRECTIVE           #不懂

###################################################################

ngx.var.arg与ngx.req.get_uri_args的理解
uri请求如下：

http://127.0.0.1?filename=1&filename=2&filename=3

local filename = ngx.var.filename
local filename = ngx.req.get_uri_args[“filename”]

相同点：
都是获取请求uri中的参数

不同点：
当请求uri中有多个同名参数时，ngx.var.arg是取第一个出现的值 “1“
ngx.req.get_uri_args[“xx”]是返回一个table，该table里存放了该参数的所有值。返回的table列表为[“1”, “2”, “3”]
ngx.req.get_uri_args[“x”]是ngx.var.arg_x的升级版
———————

引用：

http://blog.csdn.net/hwhjava/article/details/47722309

https://www.cnblogs.com/tinywan/p/6526191.html

https://blog.csdn.net/Lovegengxin/article/details/80651859

https://jinnianshilongnian.iteye.com/blog/2186448

https://www.cnblogs.com/tinywan/p/6538006.html