openrestry中的常用Lua API介紹【黑馬java培訓(xùn)】

更新時間:2020-10-13 來源:黑馬程序員瀏覽量:

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

接收請求

獲取nginx變量：ngx.var

 server {
        listen 8080;
        location / {
        	#定義nginx變量	
			set $b $host;
			
            default_type text/html;
            content_by_lua_block {
            	local var = ngx.var; -- 獲取nginx變量
				ngx.say("ngx.var.b : ", var.b, "<br/>")
				ngx.var.b = 2; -- 設(shè)置變量值
				ngx.say("ngx.var.b : ", var.b, "<br/>")
				ngx.say("<br/>")
            }
        }
    }

獲取請求頭：ngx.req.get_headers()

server {
        listen 8080;
        location / {
        	#定義nginx變量	
			set $b $host;
			
            default_type text/html;
            content_by_lua_block {
				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/>")
				ngx.say("=======================================","</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.req.get_uri_args()

server {
        listen 8080;
        location / {
        	#定義nginx變量	
			set $b $host;
			
            default_type text/html;
            content_by_lua_block {
				ngx.say("uri args begin", "<br/>")
				local uri_args = ngx.req.get_uri_args()
				ngx.say("param:username=",uri_args['username'], "<br/>")
				ngx.say("param:password=",uri_args['password'], "<br/>")
				ngx.say("uri args end", "<br/>")
				ngx.say("<br/>")
            }
        }
    }

post請求參數(shù)：ngx.req.get_post_args()

server {
        listen 8080;
        location / {
        	#定義nginx變量	
			set $b $host;
			
            default_type text/html;
            content_by_lua_block {
				ngx.say("uri args begin", "<br/>")
				-- 獲取請求體中的數(shù)據(jù)
				ngx.req.read_body()
				local uri_args = ngx.req.get_post_args() --獲取key-value格式的數(shù)據(jù)
				ngx.say("param:username=",uri_args['username'], "<br/>")
				ngx.say("param:password=",uri_args['password'], "<br/>")
				ngx.say("uri args end", "<br/>")
				ngx.say("<br/>")
            }
        }
    }

其他請求相關(guān)的方法：

獲取請求的http協(xié)議版本：ngx.req.http_version()

獲取請求方法：ngx.req.get_method()

獲取請求頭內(nèi)容：ngx.req.get_headers()

獲取請求的body內(nèi)容體：ngx.req.get_body_data()

輸出響應(yīng)

 server {
        listen 8080;
        location / {
            default_type text/html;
            content_by_lua_block {
				--寫響應(yīng)頭
				ngx.header.a = "1"
				--多個響應(yīng)頭可以使用table
				ngx.header.b = {"2", "3"}
				--輸出響應(yīng)
				ngx.say("a", "b", "<br/>")
				ngx.print("c", "d", "<br/>")
				--200狀態(tài)碼退出
				return ngx.exit(200)
            }
        }
    }

}

響應(yīng)相關(guān)方法：

ngx.header.xx = yy：輸出響應(yīng)頭;

ngx.print()：輸出響應(yīng)內(nèi)容體;

ngx.say()：同ngx.print()一樣，但是會最后輸出一個換行符;

ngx.exit()：指定狀態(tài)碼退出;

ngx.send_headers()：發(fā)送響應(yīng)狀態(tài)碼，當(dāng)調(diào)用ngx.say/ngx.print時自動發(fā)送響應(yīng)狀態(tài)碼;

ngx.headers_sent( )：判斷是否發(fā)送了響應(yīng)狀態(tài)碼。

重定向

 server {
        listen 8080;
        location / {
            default_type text/html;
            content_by_lua_block {
				ngx.redirect("http://jd.com", 302);  
            }
        }
    }

Nginx全局內(nèi)存

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

1、首先在nginx.conf的http部分定義一個全局內(nèi)存，并指定內(nèi)存大小。

#共享全局變量，在所有worker間共享，如下：定義了一個名為shared_data的全局內(nèi)存，大小為1m
lua_shared_dict shared_data 1m;

2、使用全局內(nèi)存

 server {	
        listen 8080;
        location / {
            default_type text/html;
            content_by_lua_block {
				--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/>")
            }
        }
    }

3、全局內(nèi)存常用方法介紹

ngx.shared.DICT

獲取共享內(nèi)存字典項對象

語法：dict = ngx.shared.DICT
	dict = ngx.shared[name_var]
	
其中，DICT和name_var表示的名稱是一致的，比如上面例子中，shared_data = ngx.shared.shared_data
就是dict = ngx.shared.DICT的表達(dá)形式，
也可以通過下面的方式達(dá)到同樣的目的：
shared_data = ngx.shared['shared_data']

ngx.shared.DICT:get(key)

獲取共享內(nèi)存上key對應(yīng)的值。如果key不存在，或者key已經(jīng)過期，將會返回nil;如果出現(xiàn)錯誤，那么將會返回nil以及錯誤信息。

ngx.shared.DICT:get_stale(key)

與get方法類似，區(qū)別在于該方法對于過期的key也會返回，第三個返回參數(shù)表明返回的key的值是否已經(jīng)過期，true表示過期，false表示沒有過期。

ngx.shared.DICT:set(key, value, exptime?, flags?)

“無條件”地往共享內(nèi)存上插入key-value對，這里講的“無條件”指的是不管待插入的共享內(nèi)存上是否已經(jīng)存在相同的key。

三個返回值的含義：

success：成功插入為true，插入失敗為false

err：操作失敗時的錯誤信息，可能類似"no memory"

forcible：true表明需要通過強(qiáng)制刪除(LRU算法)共享內(nèi)存上其他字典項來實現(xiàn)插入，false表明沒有刪除共享內(nèi)存上的字典項來實現(xiàn)插入。

exptime參數(shù)表明key的有效期時間，單位是秒(s)，默認(rèn)值為0，表明永遠(yuǎn)不會過期;

flags參數(shù)是一個用戶標(biāo)志值，會在調(diào)用get方法時同時獲取得到

ngx.shared.DICT.safe_set(key, value, exptime?, flags?)

與set方法類似，區(qū)別在于不會在共享內(nèi)存用完的情況下，通過強(qiáng)制刪除(LRU算法)的方法實現(xiàn)插入。如果內(nèi)存不足，會直接返回nil和err信息"no memory"

ngx.shared.DICT.add(key, value, exptime?, flags?)

與set方法類似，與set方法區(qū)別在于不會插入重復(fù)的鍵(可以簡單認(rèn)為add方法是set方法的一個子方法)，如果待插入的key已經(jīng)存在，將會返回nil和和err="exists"

ngx.shared.DICT.safe_add(key, value, exptime?, flags?)

與safe_set方法類似，區(qū)別在于不會插入重復(fù)的鍵(可以簡單認(rèn)為safe_add方法是safe_set方法的一個子方法)，如果待插入的key已經(jīng)存在，將會返回nil和和err="exists"

ngx.shared.DICT.replace(key, value, exptime?, flags?)

與set方法類似，區(qū)別在于只對已經(jīng)存在的key進(jìn)行操作(可以簡單認(rèn)為replace方法是set方法的一個子方法)，如果待插入的key在字典上不存在，將會返回nil和錯誤信息"not found"

ngx.shared.DICT.delete(key)

無條件刪除指定的key-value對，其等價于ngx.shared.DICT:set(key, nil)

ngx.shared.DICT.incr(key, value)

對key對應(yīng)的值進(jìn)行增量操作，增量值是value，其中value的值可以是一個正數(shù)，0，也可以是一個負(fù)數(shù)。value必須是一個Lua類型中的number類型，否則將會返回nil和"not a number";key必須是一個已經(jīng)存在于共享內(nèi)存中的key，否則將會返回nil和"not found".

ngx.shared.DICT.flush_all()

清除字典上的所有字段，但不會真正釋放掉字段所占用的內(nèi)存，而僅僅是將每個字段標(biāo)志為過期。

ngx.shared.DICT.flush_expired(max_count?)

清除字典上過期的字段，max_count表明上限值，如果為0或者沒有給出，表明需要清除所有過期的字段，返回值flushed是實際刪除掉的過期字段的數(shù)目。

注意：

與flush_all方法的區(qū)別在于，該方法將會釋放掉過期字段所占用的內(nèi)存

ngx.shared.DICT.get_keys(max_count?)

從字典上獲取字段列表，個數(shù)為max_count，如果為0或沒有給出，表明不限定個數(shù)。默認(rèn)值是1024個

注意：

強(qiáng)烈建議在調(diào)用該方法時，指定一個max_count參數(shù)，因為在keys數(shù)量很大的情況下，如果不指定max_count的值，可能會導(dǎo)致字典被鎖定，從而阻塞試圖訪問字典的worker進(jìn)程。

猜你喜歡：

Java如何遍歷map?