这世道呀，写个文章被转来转去的… 以前在51cto写了不少于nginx lua的文章… 前段时间因为elasticsearch的权限管理又捡起lua。但是当全网搜lua文章的时候，居然搜到了被转载的文章。 当时看那文章的时候，发觉这人文笔忒差… 后来看到author署名才知道是我以前的文章。 真逗比呀….
这篇文章主要是整理以前的文档…. 关于lua_nginx_module的安装就不多说了，推荐直接用淘宝OpenResty
文章后期有更新、更改，但总是被爬虫爬走，所以我这里标注下原文链接.
下面都是些nginx lua的例子….
如果你想返回一句话，那么可以使用ngx.say函数，他的功能跟echo是一样的。
location /echo {
default_type text/plain;
echo hello lua;
}
location /lua {
default_type text/plain;
content_by_lua 'ngx.say("hello xiaorui.cc")';
}
如果你想使用nginx lua控制访问的权限，那么需要使用access_by_lua… 下面的例子很简单是通过ngx.var.remote_addr拿到用户的ip地址，然后进行判断。
nginx本身的内置变量也可以实现下面的功能，但需要知道的是，使用nginx 内置变量实现权限控制是相当痛苦的. 不能使用if嵌套，if xx and xx 等等
location @client{
proxy_pass http://www.xiaorui.cc;
}
location ~ /test {
default_type text/html;
content_by_lua 'ngx.say("this is ruifengyun.com!")';
access_by_lua '
if ngx.var.remote_addr == "10.2.20.110" then
ngx.exit(ngx.HTTP_FORBIDDEN)
end
if ngx.var.remote_addr == "10.2.20.112" then
ngx.exec("@client")
end
';
}
下面也是个控制经过判断的接口,通过ngx.location.capture模拟访问/auth,然后对于该用户时候有继续的权限。
location / {
access_by_lua '
local res = ngx.location.capture("/auth")
if res.status == ngx.HTTP_OK then
return
end
if res.status == ngx.HTTP_FORBIDDEN then
ngx.exit(res.status)
end
ngx.exit(ngx.HTTP_INTERNAL_SERVER_ERROR)
';
# proxy_pass/fastcgi_pass/postgres_pass/...
}
rewrite_by_lua是用来实现rewrite跳转的。 这个是先判断 check-pam接口的return的内容是不是spam，是的话，转跳到其他的页面
location / {
rewrite_by_lua '
local res = ngx.location.capture("/check-spam")
if res.body == "spam" then
ngx.redirect("/terms-of-use.html")
end
'; fastcgi_pass ...;
}
那么 这个例子,你也应该会看懂。
location / {
content_by_lua '
myIP = ngx.req.get_headers()["X-Real-IP"]
if myIP == nil then
myIP = ngx.req.get_headers()["x_forwarded_for"]
end
if myIP == nil then
myIP = ngx.var.remote_addr
end
if myIP == "" then
ngx.exec("@client")
else
ngx.exec("@client_test")
end
';
}
ngx.redirect的用法，可以301 302
return ngx.redirect("/foo")
return ngx.redirect("http://localhost:1984/foo", ngx.HTTP_MOVED_TEMPORARILY)
return ngx.redirect("/foo", 301)
返回302临时重定向 地址栏会显示跳转后的地址
rewrite ^ /foo? redirect; # nginx config
return ngx.redirect(‘/foo’); — lua code
另外我们还过滤post get put 各种method过来的参数，下面的例子是关于post的例子
location = /test {
content_by_lua '
ngx.req.read_body()
local args = ngx.req.get_post_args()
for key, val in pairs(args) do
if type(val) == "table" then
ngx.say(key, ": ", table.concat(val, ", "))
else
ngx.say(key, ": ", val)
end
end
';
}
下面的例子是使用lua直接分那会一个比较完整的页面。 这不是重点，重点是里面有ngx.req.raw_header() ngx.req.get_Method() ngx.req.get_uri_args() 这些内置变量。
#!/usr/bin/env lua
ngx.say('aaaaaa </br>')
local url = ngx.var.uri
ngx.say('<br>',url,'<br/>')
ngx.print('这次访问的header头是 ',ngx.req.raw_header())
ngx.print('<meta http-equiv="content-type" content="text/html;charset=utf-8">')
ngx.print('<h1> 这个是 h1 </h1>')
ngx.print('这次访问的是 get 还是 post 呀 ',ngx.req.get_Method())
local args = ngx.req.get_uri_args()
ngx.print(args)
local res = ngx.location.capture("/")
ngx.print('<br>http code <br>‘,res.status)
获取url中的参数
location = /adder {
set_by_lua res "
local a = tonumber(ngx.arg[1])
local b = tonumber(ngx.arg[2])
return a + b"arg_a arg_b;
echores;
}
如果你的nginx配置是这么实现rewrite跳转的。
location /test {
rewrite ^/test/(.*) /$1 break;
proxy_pass http://my_backend;
}
那么在lua中是这么实现的。
location /test {
rewrite_by_lua '
local uri = ngx.re.sub(ngx.var.uri, "^/test/(.*)", "$1", "o")
ngx.req.set_uri(uri)
';
proxy_pass http://my_backend;
}
我想大家看这个对照，已经知道是啥意思了.
通过lua获取nginx的内置变量，通过这些变量做些逻辑的处理~
Nginx提供了很多内置的变量,如:
$arg_PARAMETER 这个变量包含在查询字符串时GET请求PARAMETER的值。
$args 这个变量等于请求行中的参数。
$binary_remote_addr 二进制码形式的客户端地址。
$body_bytes_sent 传送页面的字节数
$content_length 请求头中的Content-length字段。
$content_type 请求头中的Content-Type字段。
$cookie_COOKIE cookie COOKIE的值。
$document_root 当前请求在root指令中指定的值。
document_uri 与uri相同。
$host 请求中的主机头字段，如果请求中的主机头不可用，则为服务器处理请求的服务器名称。
is_args 如果args设置，值为”?”，否则为””。
$limit_rate 这个变量可以限制连接速率。
$nginx_version 当前运行的nginx版本号。
query_string 与args相同。
$remote_addr 客户端的IP地址。
$remote_port 客户端的端口。
$remote_user 已经经过Auth Basic Module验证的用户名。
$request_filename 当前连接请求的文件路径，由root或alias指令与URI请求生成。
$request_body 这个变量（0.7.58+）包含请求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比较有意义。
$request_body_file 客户端请求主体信息的临时文件名。
$request_completion 未知。
$request_method 这个变量是客户端请求的动作，通常为GET或POST。
包括0.8.20及之前的版本中，这个变量总为main request中的动作，如果当前请求是一个子请求，并不使用这个当前请求的动作。
request_uri 这个变量等于包含一些客户端请求参数的原始URI，它无法修改，请查看uri更改或重写URI。
scheme 所用的协议，比如http或者是https，比如rewrite ^(.+) scheme://example.com1 redirect;
$server_addr 服务器地址，在完成一次系统调用后可以确定这个值，如果要绕开系统调用，则必须在listen中指定地址并且使用bind参数。
$server_name 服务器名称。
$server_port 请求到达服务器的端口号。
$server_protocol 请求使用的协议，通常是HTTP/1.0或HTTP/1.1。
uri 请求中的当前URI(不带请求参数，参数位于args)，可以不同于浏览器传递的$request_uri的值，它可以通过内部重定向，或者使用index指令进行修改。
另外：
HTTP_X_FORWARDED_FOR是透过代理服务器取得客户端的真实IP地址，有些用此方法读取到的仍然是代理服务器的IP。还有一点需要注意的是：如果客户端没有通过代理服务器来访问，那么用 HTTP_X_FORWARDED_FOR 取到的值将是空的。
函数版的访问
location /lua1 {
default_type 'text/plain';
content_by_lua 'ngx.say("hello, lua")';
}
# 请求另外的url
location /lua2 {
content_by_lua '
local res = ngx.location.capture("/hello1")
ngx.say("data: " .. res.body)
';
}
