前言
本文介紹 OpenResty 的兩種正則模式匹配。
首先需要說明的是,OpenResty 套件中包含了兩種語法:一種是主要基于 FFI API 實(shí)現(xiàn)的 OpenResty 語法,一種是類原生 Lua 腳本語言的語法。
在本文所介紹的內(nèi)容中,對(duì)應(yīng)以上兩種語法的正則模式匹配分別是 ngx.re.find 和 string.find 。
這兩種規(guī)則起到完全相同的作用:在 subject string 中搜索指定的模式的串,若找到匹配值就返回它的開始位置和結(jié)束位置的位數(shù),否則返回兩個(gè) nil 空值。需要注意的是,當(dāng)查找到模式時(shí)才會(huì)產(chǎn)生兩個(gè)值,當(dāng)例如只有一個(gè)變量時(shí)只會(huì)產(chǎn)生開始位置位數(shù)或一個(gè) nil 空值。
即使你對(duì) Lua 比較熟悉,也已不再建議使用 string.find 等 Lua 的正則語法。一是因?yàn)橛捎趯?shí)現(xiàn)不同,Lua 提供的正則表達(dá)式的性能相比 ngx.re.* 的表現(xiàn)要遜色不少,二是 Lua 的正則語法并不符合 POSIX 規(guī)范,而 ngx.re.* 則由標(biāo)準(zhǔn) POSIX 規(guī)范進(jìn)行實(shí)現(xiàn),后者明顯更具備通用性和現(xiàn)在意義。
還有一個(gè)很重要的原因,相比 string.* 的每次都需重新編譯一遍,OpenResty 提供的 ngx.re.* 規(guī)范能夠在編譯完成后對(duì) Pattern 進(jìn)行緩存(使用 “o” 參數(shù)),并且也能通過 “j” 參數(shù)啟用 JIT 來進(jìn)一步提升性能(需 pcre JIT 支持)。
string.find
雖說已經(jīng)實(shí)在沒什么要用 string.find 的必要(前浪死在沙灘上),不過我還是打算簡(jiǎn)單介紹下,因?yàn)槲椰F(xiàn)在就是用的這個(gè)(原因我在后文會(huì)提到)。
-- syntax
from, to, err = string.find(s, pattern, start, [plain])
-- context
init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.\*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*
-- example
string.find(ngx.var.http_user_agent, "360")
以上示例的作用就是包含有 “360” 的 UA 進(jìn)行匹配,匹配命中時(shí)返回的值為 匹配串的開始位置和結(jié)束位置的位數(shù)(從左往右) 。舉個(gè)例子,使用 ngx.say 對(duì)輸出值進(jìn)行顯示,先完成以下代碼:
-- 定義變量
var = string.find(ngx.var.http_user_agent, "360")
-- 輸出
ngx.say("var=" .. var)
把它放到 Nginx 網(wǎng)站的 /example 路徑下:
location = /example {
access_by_lua_block {
var = string.find(ngx.var.http_user_agent, "360")
ngx.say("var=" .. var)
}
}
然后使用 curl 測(cè)試響應(yīng):
# 發(fā)個(gè)請(qǐng)求,順便指定 UA 為 360
curl example.com -A "360"
# 返回響應(yīng)會(huì)看到由 ngx.say echo 回來的字符串
# 這里匹配到的 "360" 字符串位于字首,位數(shù)是 1
var=1
ngx.re.find
ngx.re.find 規(guī)范的優(yōu)勢(shì)已經(jīng)在上文介紹過了,這里介紹下它的基本語法(更多說明可以參看 官方文檔 ),以及要發(fā)揮它的優(yōu)勢(shì)(使用 “o” 參數(shù)緩存和使用 pcre JIT)的所需要求。
-- syntax
from, to, err = ngx.re.find(subject, regex, options?, ctx?, nth?)
-- context
init_worker_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.\*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*
-- example
ngx.re.find(ngx.var.http_user_agent, "360", "jo")
要使用 ngx.re.* 規(guī)范,并且要實(shí)現(xiàn)更高性能的話,需要滿足三個(gè)條件:編譯時(shí)使用 –with-pcre-jit 參數(shù)以啟用 pcre JIT 支持;編譯時(shí)需要 lua-resty-core 支持(直接使用 OpenResty 安裝即可);以及使用 Lua 代碼時(shí),需要在 init_by_lua 段引入 require 'resty.core.regex' 語句(引入 lua-resty-core API 支持),并在構(gòu)建代碼時(shí)將使用 "jo" 參數(shù)作為你的習(xí)慣,這兩個(gè)參數(shù)提供 pcre JIT 和 Pattern Cache 開關(guān)。正如上面 example 中所用的那樣。
同樣作為前面舉例的實(shí)現(xiàn),Lua 代碼變成了這樣:
-- 定義變量
var = ngx.re.find(ngx.var.http_user_agent, "360", "jo")
-- 輸出
ngx.say("var=" .. var)
我的坑
最后來解釋下我為什么還在用 string.find 語法。原因比較尷尬,不是我不想用,而是我不能用。我使用了以下代碼:
if (ngx.re.find(ngx.var.request_uri, "^/admin/", "jo") ~= nil or ngx.re.find(ngx.var.request_uri, "^/tools/", "jo") ~= nil) then
return ngx.exit(ngx.HTTP_CLOSE)
end
然后我就發(fā)現(xiàn),這個(gè)匹配坑我了,我把這段代碼單獨(dú)拿出來時(shí)訪問 /admin/xxx 或 /tools/xxx 就會(huì)被拒,但是我一把它放進(jìn)代碼構(gòu)筑后就形同虛設(shè)。當(dāng)然我能肯定不是我其它代碼的問題,因?yàn)閾Q成 string.find 后就好了。
為了確認(rèn)是不是正則寫錯(cuò)的鍋,我也做過以下測(cè)試:
if (ngx.var.request_uri == "/test1/") then
if (ngx.re.find("/admin/test/", "^/admin/", "jo") ~= nil) then
ngx.say("1=" .. ngx.re.find("/admin/test/", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test2/") then
if (ngx.re.find("/admintest/", "^/admin/", "jo") ~= nil) then
ngx.say("2=" .. ngx.re.find("/admintest/", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test3/") then
if (ngx.re.find("/artic/", "^/admin/", "jo") ~= nil) then
ngx.say("3=" .. ngx.re.find("/artic/", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test4/") then
if (ngx.re.find("/artic", "^/admin/", "jo") ~= nil) then
ngx.say("4=" .. ngx.re.find("/artic", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test5/") then
if (ngx.re.find("/offline/admin/", "^/admin/", "jo") ~= nil) then
ngx.say("5=" .. ngx.re.find("/offline/admin/", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test6/") then
if (ngx.re.find("/offline/", "^/admin/", "jo") ~= nil) then
ngx.say("6=" .. ngx.re.find("/offline/", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test7/") then
if (ngx.re.find("/admin/", "^/admin/", "jo") ~= nil) then
ngx.say("7=" .. ngx.re.find("/admin/", "^/admin/", "jo"))
end
elseif (ngx.var.request_uri == "/test8/") then
if (ngx.re.find("/adm/in", "^/admin/", "jo") ~= nil) then
ngx.say("8=" .. ngx.re.find("/adm/in", "^/admin/", "jo"))
end
else
if (ngx.var.request_uri == "/test9/") then
if (ngx.re.find("/admin", "^/admin/", "jo") ~= nil) then
ngx.say("9=" .. ngx.re.find("/admin", "^/admin/", "jo"))
end
end
end
測(cè)試結(jié)果卻表明我的寫法并沒有錯(cuò),根據(jù) echo 的結(jié)果作出的判斷是, ^/admin/ 的確對(duì) /admin/xxx 進(jìn)行了唯一匹配。
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
您可能感興趣的文章:- Openresty服務(wù)器使用lua腳本寫的Hello World簡(jiǎn)單實(shí)例