本文目的是學(xué)習(xí)Nginx+Lua開發(fā),對(duì)于Nginx基本知識(shí)可以參考如下文章:
nginx啟動(dòng)、關(guān)閉、重啟
http://www.cnblogs.com/derekchen/archive/2011/02/17/1957209.html
agentzh 的 Nginx 教程
http://openresty.org/download/agentzh-nginx-tutorials-zhcn.html
Nginx+Lua入門
http://17173ops.com/2013/11/01/17173-ngx-lua-manual.shtml
nginx 配置指令的執(zhí)行順序
http://zhongfox.github.io/blog/server/2013/05/15/nginx-exec-order/
nginx與lua的執(zhí)行順序和步驟說明
http://www.mrhaoting.com/?p=157
Nginx配置文件nginx.conf中文詳解
Tengine的Nginx開發(fā)從入門到精通
http://tengine.taobao.org/book/
官方文檔
http://wiki.nginx.org/Configuration
本文目的是學(xué)習(xí)Nginx+Lua開發(fā),對(duì)于Lua基本知識(shí)可以參考如下文章:
Lua簡明教程
http://coolshell.cn/articles/10739.html
lua在線lua學(xué)習(xí)教程
Lua 5.1 參考手冊(cè)
http://www.codingnow.com/2000/download/lua_manual.html
Lua5.3 參考手冊(cè)
http://cloudwu.github.io/lua53doc/
和一般的Web Server類似,我們需要接收請(qǐng)求、處理并輸出響應(yīng)。而對(duì)于請(qǐng)求我們需要獲取如請(qǐng)求參數(shù)、請(qǐng)求頭、Body體等信息;而對(duì)于處理就是調(diào)用相應(yīng)的Lua代碼即可;輸出響應(yīng)需要進(jìn)行響應(yīng)狀態(tài)碼、響應(yīng)頭和響應(yīng)內(nèi)容體的輸出。因此我們從如上幾個(gè)點(diǎn)出發(fā)即可。
1、example.conf配置文件
2、test_request.lua
ngx.var : nginx變量,如果要賦值如ngx.var.b = 2,此變量必須提前聲明;另外對(duì)于nginx location中使用正則捕獲的捕獲組可以使用ngx.var[捕獲組數(shù)字]獲??;
ngx.req.get_headers:獲取請(qǐng)求頭,默認(rèn)只獲取前100,如果想要獲取所以可以調(diào)用ngx.req.get_headers(0);獲取帶中劃線的請(qǐng)求頭時(shí)請(qǐng)使用如headers.user_agent這種方式;如果一個(gè)請(qǐng)求頭有多個(gè)值,則返回的是table;
ngx.req.get_uri_args:獲取url請(qǐng)求參數(shù),其用法和get_headers類似;
ngx.req.get_post_args:獲取post請(qǐng)求內(nèi)容體,其用法和get_headers類似,但是必須提前調(diào)用ngx.req.read_body()來讀取body體(也可以選擇在nginx配置文件使用lua_need_request_body on;開啟讀取body體,但是官方不推薦);
ngx.req.raw_header:未解析的請(qǐng)求頭字符串;
ngx.req.get_body_data:為解析的請(qǐng)求body體內(nèi)容字符串。
如上方法處理一般的請(qǐng)求基本夠用了。另外在讀取post內(nèi)容體時(shí)根據(jù)實(shí)際情況設(shè)置client_body_buffer_size和client_max_body_size來保證內(nèi)容在內(nèi)存而不是在文件中。
使用如下腳本測(cè)試
輸出響應(yīng)
1.1、example.conf配置文件
1.2、test_response_1.lua
ngx.header:輸出響應(yīng)頭;
ngx.print:輸出響應(yīng)內(nèi)容體;
ngx.say:通ngx.print,但是會(huì)最后輸出一個(gè)換行符;
ngx.exit:指定狀態(tài)碼退出。
2.1、example.conf配置文件
2.2、test_response_2.lua
ngx.redirect:重定向;
ngx.status=狀態(tài)碼,設(shè)置響應(yīng)的狀態(tài)碼;ngx.resp.get_headers()獲取設(shè)置的響應(yīng)狀態(tài)碼;ngx.send_headers()發(fā)送響應(yīng)狀態(tài)碼,當(dāng)調(diào)用ngx.say/ngx.print時(shí)自動(dòng)發(fā)送響應(yīng)狀態(tài)碼;可以通過ngx.headers_sent=true判斷是否發(fā)送了響應(yīng)狀態(tài)碼。
其他API
1、example.conf配置文件
2、test_other.lua
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正則表達(dá)式匹配;
更多Nginx Lua API請(qǐng)參考 http://wiki.nginx.org/HttpLuaModule#Nginx_API_for_Lua。
Nginx全局內(nèi)存
使用過如Java的朋友可能知道如Ehcache等這種進(jìn)程內(nèi)本地緩存,Nginx是一個(gè)Master進(jìn)程多個(gè)Worker進(jìn)程的工作方式,因此我們可能需要在多個(gè)Worker進(jìn)程中共享數(shù)據(jù),那么此時(shí)就可以使用ngx.shared.DICT來實(shí)現(xiàn)全局內(nèi)存共享。
1、首先在nginx.conf的http部分分配內(nèi)存大小
2、example.conf配置文件
3、 test_lua_shared_dict.lua
更多API請(qǐng)參考http://wiki.nginx.org/HttpLuaModule#ngx.shared.DICT。
到此基本的Nginx Lua API就學(xué)完了,對(duì)于請(qǐng)求處理和輸出響應(yīng)如上介紹的API完全夠用了,更多API請(qǐng)參考官方文檔。
Nginx共11個(gè)處理階段,而相應(yīng)的處理階段是可以做插入式處理,即可插拔式架構(gòu);另外指令可以在http、server、server if、location、location if幾個(gè)范圍進(jìn)行配置:
指令 | 所處處理階段 | 使用范圍 | 解釋 |
init_by_lua init_by_lua_file | loading-config | http | nginx Master進(jìn)程加載配置時(shí)執(zhí)行; 通常用于初始化全局配置/預(yù)加載Lua模塊 |
init_worker_by_lua init_worker_by_lua_file | starting-worker | http | 每個(gè)Nginx Worker進(jìn)程啟動(dòng)時(shí)調(diào)用的計(jì)時(shí)器,如果Master進(jìn)程不允許則只會(huì)在init_by_lua之后調(diào)用; 通常用于定時(shí)拉取配置/數(shù)據(jù),或者后端服務(wù)的健康檢查 |
set_by_lua set_by_lua_file | rewrite | server,server if,location,location if | 設(shè)置nginx變量,可以實(shí)現(xiàn)復(fù)雜的賦值邏輯;此處是阻塞的,Lua代碼要做到非??欤?/p> |
rewrite_by_lua rewrite_by_lua_file | rewrite tail | http,server,location,location if | rrewrite階段處理,可以實(shí)現(xiàn)復(fù)雜的轉(zhuǎn)發(fā)/重定向邏輯; |
access_by_lua access_by_lua_file | access tail | http,server,location,location if | 請(qǐng)求訪問階段處理,用于訪問控制 |
content_by_lua content_by_lua_file | content | location,location if | 內(nèi)容處理器,接收請(qǐng)求處理并輸出響應(yīng) |
header_filter_by_lua header_filter_by_lua_file | output-header-filter | http,server,location,location if | 設(shè)置header和cookie |
body_filter_by_lua body_filter_by_lua_file | output-body-filter | http,server,location,location if | 對(duì)響應(yīng)數(shù)據(jù)進(jìn)行過濾,比如截?cái)?、替換。 |
log_by_lua log_by_lua_file | log | http,server,location,location if | log階段處理,比如記錄訪問量/統(tǒng)計(jì)平均響應(yīng)時(shí)間 |
更詳細(xì)的解釋請(qǐng)參考http://wiki.nginx.org/HttpLuaModule#Directives。如上指令很多并不常用,因此我們只拿其中的一部分做演示。
每次Nginx重新加載配置時(shí)執(zhí)行,可以用它來完成一些耗時(shí)模塊的加載,或者初始化一些全局配置;在Master進(jìn)程創(chuàng)建Worker進(jìn)程時(shí),此指令中加載的全局變量會(huì)進(jìn)行Copy-OnWrite,即會(huì)復(fù)制到所有全局變量到Worker進(jìn)程。
1、nginx.conf配置文件中的http部分添加如下代碼
2、init.lua
3、test.lua
4、訪問如http://192.168.1.2/lua 會(huì)發(fā)現(xiàn)全局變量一直不變,而共享內(nèi)存一直遞增
global variable : 2 , shared memory : 8 hello world
另外注意一定在生產(chǎn)環(huán)境開啟lua_code_cache,否則每個(gè)請(qǐng)求都會(huì)創(chuàng)建Lua VM實(shí)例。
用于啟動(dòng)一些定時(shí)任務(wù),比如心跳檢查,定時(shí)拉取服務(wù)器配置等等;此處的任務(wù)是跟Worker進(jìn)程數(shù)量有關(guān)系的,比如有2個(gè)Worker進(jìn)程那么就會(huì)啟動(dòng)兩個(gè)完全一樣的定時(shí)任務(wù)。
1、nginx.conf配置文件中的http部分添加如下代碼
2、init_worker.lua
ngx.timer.at:延時(shí)調(diào)用相應(yīng)的回調(diào)方法;ngx.timer.at(秒單位延時(shí),回調(diào)函數(shù),回調(diào)函數(shù)的參數(shù)列表);可以將延時(shí)設(shè)置為0即得到一個(gè)立即執(zhí)行的任務(wù),任務(wù)不會(huì)在當(dāng)前請(qǐng)求中執(zhí)行不會(huì)阻塞當(dāng)前請(qǐng)求,而是在一個(gè)輕量級(jí)線程中執(zhí)行。
另外根據(jù)實(shí)際情況設(shè)置如下指令
lua_max_pending_timers 1024; #最大等待任務(wù)數(shù)
lua_max_running_timers 256; #最大同時(shí)運(yùn)行任務(wù)數(shù)
set_by_lua
設(shè)置nginx變量,我們用的set指令即使配合if指令也很難實(shí)現(xiàn)負(fù)責(zé)的賦值邏輯;
1.1、example.conf配置文件
set_by_lua_file:語法set_by_lua_file $var lua_file arg1 arg2...; 在lua代碼中可以實(shí)現(xiàn)所有復(fù)雜的邏輯,但是要執(zhí)行速度很快,不要阻塞;
1.2、test_set_1.lua
得到請(qǐng)求參數(shù)進(jìn)行相加然后返回。
訪問如http://192.168.1.2/lua_set_1?i=1&j=10進(jìn)行測(cè)試。 如果我們用純set指令是無法實(shí)現(xiàn)的。
再舉個(gè)實(shí)際例子,我們實(shí)際工作時(shí)經(jīng)常涉及到網(wǎng)站改版,有時(shí)候需要新老并存,或者切一部分流量到新版
2.1、首先在example.conf中使用map指令來映射host到指定nginx變量,方便我們測(cè)試
如綁定hosts
192.168.1.2 item.jd.com;
192.168.1.2 item2014.jd.com;
此時(shí)我們想訪問item2014.jd.com時(shí)訪問新版,那么我們可以簡單的使用如
但是我們想把商品編號(hào)為為8位(比如品類為圖書的)沒有改版完成,需要按照相應(yīng)規(guī)則跳轉(zhuǎn)到老版,但是其他的到新版;雖然使用if指令能實(shí)現(xiàn),但是比較麻煩,基本需要這樣
以上規(guī)則還是比較簡單的,如果涉及到更復(fù)雜的多重if/else或嵌套if/else實(shí)現(xiàn)起來就更痛苦了,可能需要到后端去做了;此時(shí)我們就可以借助lua了:
rewrite_by_lua
執(zhí)行內(nèi)部URL重寫或者外部重定向,典型的如偽靜態(tài)化的URL重寫。其默認(rèn)執(zhí)行在rewrite處理階段的最后。
1.1、example.conf配置文件
1.2、test_rewrite_1.lua
當(dāng)我們請(qǐng)求http://192.168.1.2/lua_rewrite_1時(shí)發(fā)現(xiàn)沒有跳轉(zhuǎn),而請(qǐng)求http://192.168.1.2/lua_rewrite_1?jump=1時(shí)發(fā)現(xiàn)跳轉(zhuǎn)到京東首頁了。 此處需要301/302跳轉(zhuǎn)根據(jù)自己需求定義。
2.1、example.conf配置文件
2.2、test_rewrite_2.lua
ngx.req.set_uri(uri, false):可以內(nèi)部重寫uri(可以帶參數(shù)),等價(jià)于 rewrite ^ /lua_rewrite_3;通過配合if/else可以實(shí)現(xiàn) rewrite ^ /lua_rewrite_3 break;這種功能;此處兩者都是location內(nèi)部url重寫,不會(huì)重新發(fā)起新的location匹配;
ngx.req.set_uri_args:重寫請(qǐng)求參數(shù),可以是字符串(a=1&b=2)也可以是table;
訪問如http://192.168.1.2/lua_rewrite_2?jump=0時(shí)得到響應(yīng)
rewrite2 uri : /lua_rewrite_2, a :
訪問如http://192.168.1.2/lua_rewrite_2?jump=1時(shí)得到響應(yīng)
rewrite2 uri : /lua_rewrite_4, a : 1
3.1、example.conf配置文件
3.2、test_rewrite_3.lua
ngx.req.set_uri(uri, true):可以內(nèi)部重寫uri,即會(huì)發(fā)起新的匹配location請(qǐng)求,等價(jià)于 rewrite ^ /lua_rewrite_4 last;此處看error log是看不到我們記錄的log。
所以請(qǐng)求如http://192.168.1.2/lua_rewrite_3?jump=1會(huì)到新的location中得到響應(yīng),此處沒有/lua_rewrite_4,所以匹配到/lua請(qǐng)求,得到類似如下的響應(yīng)
global variable : 2 , shared memory : 1 hello world
即
rewrite ^ /lua_rewrite_3; 等價(jià)于 ngx.req.set_uri("/lua_rewrite_3", false);
rewrite ^ /lua_rewrite_3 break; 等價(jià)于 ngx.req.set_uri("/lua_rewrite_3", false); 加 if/else判斷/break/return
rewrite ^ /lua_rewrite_4 last; 等價(jià)于 ngx.req.set_uri("/lua_rewrite_4", true);
注意,在使用rewrite_by_lua時(shí),開啟rewrite_log on;后也看不到相應(yīng)的rewrite log。
access_by_lua
用于訪問控制,比如我們只允許內(nèi)網(wǎng)ip訪問,可以使用如下形式
1.1、example.conf配置文件
1.2、test_access.lua
即如果訪問如http://192.168.1.2/lua_access?token=234將得到403 Forbidden的響應(yīng)。這樣我們可以根據(jù)如cookie/用戶token來決定是否有訪問權(quán)限。
content_by_lua
此指令之前已經(jīng)用過了,此處就不講解了。
另外在使用PCRE進(jìn)行正則匹配時(shí)需要注意正則的寫法,具體規(guī)則請(qǐng)參考http://wiki.nginx.org/HttpLuaModule中的Special PCRE Sequences部分。還有其他的注意事項(xiàng)也請(qǐng)閱讀官方文檔。
聯(lián)系客服