nginx+lua學習筆記一 Nginx Lua API

和一般的Web Server類似，我們需要接收請求、處理并輸出響應。而對于請求我們需要獲取如請求參數(shù)、請求頭、Body體等信息；而對于處理就是調(diào)用相應的Lua代碼即可；輸出響應需要進行響應狀態(tài)碼、響應頭和響應內(nèi)容體的輸出。因此我們從如上幾個點出發(fā)即可。

接收請求

1、example.conf配置文件

location ~ /lua_request/(\d+)/(\d+) {  
    #設置nginx變量  
    set $a $1;   
    set $b $host;  
    default_type "text/html";  
    #nginx內(nèi)容處理  
    content_by_lua_file /usr/example/lua/test_request.lua;  
    #內(nèi)容體處理完成后調(diào)用  
    echo_after_body "ngx.var.b $b";  
}
2、test_request.lua
--nginx變量  
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("<br/>")  
  
--請求頭  
local headers = ngx.req.get_headers()  
ngx.say("headers begin", "<br/>")  
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.say("headers end", "<br/>")  
ngx.say("<br/>")  
  
--get請求uri參數(shù)  
ngx.say("uri args begin", "<br/>")  
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  
ngx.say("uri args end", "<br/>")  
ngx.say("<br/>")  
  
--post請求參數(shù)  
ngx.req.read_body()  
ngx.say("post args begin", "<br/>")  
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.say("post args end", "<br/>")  
ngx.say("<br/>")  
--請求的http協(xié)議版本  
ngx.say("ngx.req.http_version : ", ngx.req.http_version(), "<br/>")  
--請求方法  
ngx.say("ngx.req.get_method : ", ngx.req.get_method(), "<br/>")  
--原始的請求頭內(nèi)容  
ngx.say("ngx.req.raw_header : ",  ngx.req.raw_header(), "<br/>")  
--請求的body內(nèi)容體  
ngx.say("ngx.req.get_body_data() : ", ngx.req.get_body_data(), "<br/>")  
ngx.say("<br/>")
lua API介紹
ngx.var : nginx變量，如果要賦值如ngx.var.b = 2，此變量必須提前聲明；另外對于nginx location中使用正則捕獲的捕獲組可以使用ngx.var[捕獲組數(shù)字]獲取;

ngx.req.get_headers：獲取請求頭，默認只獲取前100，如果想要獲取所以可以調(diào)用

ngx.req.get_headers(0):獲取帶中劃線的請求頭時請使用如headers.user_agent這種方式;如果一個請求頭有多個值，則返回的是table;

ngx.req.get_uri_args：獲取url請求參數(shù)，其用法和get_headers類似;

ngx.req.get_post_args：獲取post請求內(nèi)容體，其用法和get_headers類似，但是必須提前調(diào)用ngx.req.read_body()來讀取body體（也可以選擇在nginx配置文件使用)lua_need_request_body on;開啟讀取body體，但是官方不推薦）;

ngx.req.raw_header：未解析的請求頭字符串;

ngx.req.get_body_data：為解析的請求body體內(nèi)容字符串。

如上方法處理一般的請求基本夠用了。另外在讀取post內(nèi)容體時根據(jù)實際情況設置client_body_buffer_size和client_max_body_size來保證內(nèi)容在內(nèi)存而不是在文件中。

使用如下腳本測試

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配置文件

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

--寫響應頭  
ngx.header.a = "1"  
--多個響應頭可以使用table  
ngx.header.b = {"2", "3"}  
--輸出響應  
ngx.say("a", "b", "<br/>")  
ngx.print("c", "d", "<br/>")  
--200狀態(tài)碼退出  
return ngx.exit(200)
  • ngx.header：輸出響應頭；
  • ngx.print：輸出響應內(nèi)容體；
  • ngx.say：通ngx.print，但是會最后輸出一個換行符；
  • ngx.exit：指定狀態(tài)碼退出。

2.1、 example.conf配置文件

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

ngx.redirect("http://jd.com", 302)
  • ngx.redirect：重定向;

ngx.status=狀態(tài)碼，設置響應的狀態(tài)碼；ngx.resp.get_headers()獲取設置的響應狀態(tài)碼；ngx.send_headers()發(fā)送響應狀態(tài)碼，當調(diào)用ngx.say/ngx.print時自動發(fā)送響應狀態(tài)碼；可以通過ngx.headers_sent=true判斷是否發(fā)送了響應狀態(tài)碼。

其他API
1、example.conf配置文件

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

2、test_other.lua

--未經(jīng)解碼的請求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/>")
  • ngx.escape_uri/ngx.unescape_uri ： uri編碼解碼；
  • ngx.encode_args/ngx.decode_args：參數(shù)編碼解碼；
  • ngx.encode_base64/ngx.decode_base64：BASE64編碼解碼；
  • ngx.re.match：nginx正則表達式匹配；

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

Nginx全局內(nèi)存

使用過如Java的朋友可能知道如Ehcache等這種進程內(nèi)本地緩存，Nginx是一個Master進程多個Worker進程的工作方式，因此我們可能需要在多個Worker進程中共享數(shù)據(jù)，那么此時就可以使用[ngx.shared.DICT]來實現(xiàn)全局內(nèi)存共享。

1、首先在nginx.conf的http部分分配內(nèi)存大小

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

2、example.conf配置文件

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

--1、獲取全局共享內(nèi)存變量  
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請參考http://wiki.nginx.org/HttpLuaModule#ngx.shared.DICT。

到此基本的Nginx Lua API就學完了，對于請求處理和輸出響應如上介紹的API完全夠用了，更多API請參考官方文檔。

最后編輯于 ：
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內(nèi)容