OpenResty学习笔记二，


OpenResty学习笔记二

    • Nginx Lua API
      • 接受请求
      • 输出响应
      • 更多API
    • Nginx全局内存
    • Nginx Lua模块指令
      • init_by_lua
      • init_worker_by_lua
      • set_by_lua
      • rewrite_by_lua
      • access_by_lua

Nginx Lua API

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

接受请求

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

配置文件：

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

request_var.lua

local var = ngx.var  
ngx.say("ngx.var.a : ", var.a, "<br/>")  
ngx.say("ngx.var.b : ", var.b, "<br/>")  
ngx.say("ngx.var[2] : ", var[2], "<br/>")  
ngx.var.b = 2;   
ngx.say("ngx.var.b : ", var.b, "<br/>")

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

request_headers.lua

local headers = ngx.req.get_headers()  
ngx.say("Host : ", headers["Host"], "<br/>")  
ngx.say("user-agent : ", headers["user-agent"], "<br/>")  
ngx.say("user-agent : ", headers.user_agent, "<br/>")  
for k,v in pairs(headers) do  
    if type(v) == "table" then  
        ngx.say(k, " : ", table.concat(v, ","), "<br/>")  
    else  
        ngx.say(k, " : ", v, "<br/>")  
    end  
end

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

ngx.req.get_post_args：获取post请求内容体，其用法和get_headers类似，但是必须提前调用ngx.req.read_body()来读取body体；

request_args.lua

--get请求uri参数    
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, ", "), "<br/>")  
    else  
        ngx.say(k, ": ", v, "<br/>")  
    end  
end  

--post请求参数  
ngx.req.read_body()  
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, ", "), "<br/>")  
    else  
        ngx.say(k, ": ", v, "<br/>")  
    end  
end

ngx.req.http_version()：请求的http协议版本 ；

ngx.req.get_method()：请求方法

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

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

在读取post内容体时根据实际情况设置client_body_buffer_size和client_max_body_size来保证内容在内存而不是在文件中。

输出响应

ngx.header：输出响应头；

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

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

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

response.lua

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

ngx.redirect：重定向； ngx.redirect(“http://jd.com”, 302) ；
ngx.status=状态码，设置响应的状态码；
ngx.resp.get_headers()获取设置的响应头；
ngx.send_headers()发送响应头，当调用ngx.say/ngx.print时自动发送响应头；
可以通过ngx.headers_sent=true判断是否发送了响应头。

更多API

ngx.escape_uri/ngx.unescape_uri ： uri编码解码；
ngx.encode_args/ngx.decode_args：参数编码解码；
ngx.encode_base64/ngx.decode_base64：BASE64编码解码；
ngx.re.match：nginx正则表达式匹配；

test.lua

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

更多Nginx Lua API请参考 https://www.nginx.com/resources/wiki/modules/lua/#nginx-api-for-lua。

Nginx全局内存

Nginx是一个Master进程多个Worker进程的工作方式，因此我们可能需要在多个Worker进程中共享数据，那么此时就可以使用ngx.shared.dict 来实现全局内存共享。

#共享全局变量，在所有worker间共享  
lua_shared_dict shared_data 1m;
  1. 配置localtion：
location /lua_shared_dict {  
    default_type text/html;  
    content_by_lua_file lua/lua_shared_dict.lua;  
}
  1. lua_shared_dict.lua
--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, "<br/>")  
end  
--递增  
i = shared_data:incr("i", 1)  
ngx.say("i=", i, "<br/>")

更多API请参考https://www.nginx.com/resources/wiki/modules/lua/#ngx-shared-dict

Nginx Lua模块指令

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

指令 所处理阶段 适用范围 描述
init_by_lua
init_by_lua_file		 loadung-config http nginx Master进程加载配置时执行；通常用于初始化全局配置/预加载Lua模块
init_work_by_lua
init_wrok_by_lua_file		 starting-worker http 每个Nginx Worker进程启动时调用的计时器，如果Master进程不允许则只会在init_by_lua之后调用；通常用于定时拉取配置数据或者后端服务的健康检查
set_by_lua
set_by_lua_file		 rewirte server,server if,location,location if 设置nginx变量，可以实现复杂的赋值逻辑；此处是阻塞的，Lua代码要做到非常快
rewrite_by_lua
rewrite_by_lua_file		 rewirte tail http,server,server if,location,location if rewrite阶段处理，可以实现复杂的转发/重定向逻辑
access_by_lua
access_by_lua_file		 access tail http,server,server if,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阶段处理，比如记录访问量/统计平均响应时间

更详细的解释请参考https://www.nginx.com/resources/wiki/modules/lua/#directives

init_by_lua

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

init.lua

--初始化耗时的模块  
local redis = require 'resty.redis'  
local cjson = require 'cjson'  

--共享全局内存  
local shared_data = ngx.shared.shared_data  
shared_data:set("count", 1)

init_worker_by_lua

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

local count = 0  
local delayInSeconds = 3  
local heartbeatCheck = nil  
  
heartbeatCheck = function(args)  
   count = count + 1  
   ngx.log(ngx.INFO, "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指令也很难实现负责的赋值逻辑，在lua代码中可以实现所有复杂的逻辑，但是要执行速度很快，不要阻塞

location /foo_sum {
	set $a 32;
	set $b 56;
	set_by_lua $sum
	       'return tonumber(ngx.arg[1]) + tonumber(ngx.arg[2])'
	$a $b;
	echo "sum = $sum";
}

rewrite_by_lua

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

location /lua_rewrite{  
    default_type text/html;  
    rewrite_by_lua_file lua/rewrite_1.lua;  
    echo "no rewrite";  
}

rewrite_1.lua

if ngx.req.get_uri_args()["jump"] == "1" then  
   return ngx.redirect("http://www.jd.com", 302)  
else if ngx.req.get_uri_args["jump"] == "2" then
   ngx.req.set_uri("/rewrite_2",false)
   ngx.req.set_uri_args({a=1,b=2})
else
   ngx.req.set_uri("/rewrite_2", true);  
   ngx.req.set_uri_args({a = 1, b = 2});  
end

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

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

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

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

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

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

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;

可以根据如cookie/用户token来决定是否有访问权限

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

相关内容

    暂无相关文章