快捷導(dǎo)航

nginx自定義變量與內(nèi)置預(yù)定義變量的使用

更新時間：2020年06月22日 15:16:24 作者：tinysakurac

這篇文章主要介紹了nginx自定義變量與內(nèi)置預(yù)定義變量的使用，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

總覽

nginx可以使用變量簡化配置與提高配置的靈活性，所有的變量值都可以通過這種方式引用：

$變量名

而nginx中的變量分為兩種，自定義變量與內(nèi)置預(yù)定義變量

內(nèi)置變量

聲明

可以在sever,http,location等標(biāo)簽中使用set命令（非唯一）聲明變量，語法如下

set $變量名 變量值

注意nginx中的變量必須都以$開頭。

可見性

nginx的配置文件中所有使用的變量都必須是聲明過的，否則nginx會無法啟動并打印相關(guān)異常日志

nginx變量的一個有趣的特性就是nginx中沒一個變量都是全局可見的，而他們又不是全局變量。比如下面這個例子

location a/ {
 return 200 $a
}

location b/ {
 set $a hello nginx
 return 200 $a
}

由于變量是全局可見的所以nginx啟動不會報錯，而第一個location中并不知道$a的具體值因此返回的響應(yīng)結(jié)果為一個空字符串。

在不同層級的標(biāo)簽中聲明的變量性的可見性規(guī)則如下:

location標(biāo)簽中聲明的變量中對這個location塊可見
server標(biāo)簽中聲明的變量對server塊以及server塊中的所有子塊可見
http標(biāo)簽中聲明的變量對http塊以及http塊中的所有子塊可見

內(nèi)置預(yù)定義變量

內(nèi)置預(yù)定義變量即無需聲明就可以使用的變量，通常包括一個http請求或響應(yīng)中一部分內(nèi)容的值，以下為一些常用的內(nèi)置預(yù)定義變量

變量名	定義
$arg_PARAMETER	GET請求中變量名PARAMETER參數(shù)的值。
$args	這個變量等于GET請求中的參數(shù)。例如，foo=123&bar=blahblah;這個變量只可以被修改
$binary_remote_addr	二進(jìn)制碼形式的客戶端地址。
$body_bytes_sent	傳送頁面的字節(jié)數(shù)
$content_length	請求頭中的Content-length字段。
$content_type	請求頭中的Content-Type字段。
$cookie_COOKIE	cookie COOKIE的值。
$document_root	當(dāng)前請求在root指令中指定的值。
$document_uri	與$uri相同。
$host	請求中的主機(jī)頭(Host)字段，如果請求中的主機(jī)頭不可用或者空，則為處理請求的server名稱(處理請求的server的server_name指令的值)。值為小寫，不包含端口。
$hostname	機(jī)器名使用 gethostname系統(tǒng)調(diào)用的值
$http_HEADER	HTTP請求頭中的內(nèi)容，HEADER為HTTP請求中的內(nèi)容轉(zhuǎn)為小寫，-變?yōu)開(破折號變?yōu)橄聞澗€)，例如：$http_user_agent(Uaer-Agent的值);
$sent_http_HEADER	HTTP響應(yīng)頭中的內(nèi)容，HEADER為HTTP響應(yīng)中的內(nèi)容轉(zhuǎn)為小寫，-變?yōu)開(破折號變?yōu)橄聞澗€)，例如： $sent_http_cache_control, $sent_http_content_type…;
$is_args	如果$args設(shè)置，值為"?"，否則為""。
$limit_rate	這個變量可以限制連接速率。
$nginx_version	當(dāng)前運(yùn)行的nginx版本號。
$query_string	與$args相同。
$remote_addr	客戶端的IP地址。
$remote_port	客戶端的端口。
$remote_user	已經(jīng)經(jīng)過Auth Basic Module驗(yàn)證的用戶名。
$request_filename	當(dāng)前連接請求的文件路徑，由root或alias指令與URI請求生成。
$request_body	這個變量（0.7.58+）包含請求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比較有意義。
$request_body_file	客戶端請求主體信息的臨時文件名。
$request_completion	如果請求成功，設(shè)為"OK"；如果請求未完成或者不是一系列請求中最后一部分則設(shè)為空。
$request_method	這個變量是客戶端請求的動作，通常為GET或POST。包括0.8.20及之前的版本中，這個變量總為main request中的動作，如果當(dāng)前請求是一個子請求，并不使用這個當(dāng)前請求的動作。
$request_uri	這個變量等于包含一些客戶端請求參數(shù)的原始URI，它無法修改，請查看$uri更改或重寫URI。
$scheme	所用的協(xié)議，比如http或者是https，比如rewrite ^(.+)$ $scheme://example.com$1 redirect;
$server_addr	服務(wù)器地址，在完成一次系統(tǒng)調(diào)用后可以確定這個值，如果要繞開系統(tǒng)調(diào)用，則必須在listen中指定地址并且使用bind參數(shù)。
$server_name	服務(wù)器名稱。
$server_port	請求到達(dá)服務(wù)器的端口號。
$server_protocol	請求使用的協(xié)議，通常是HTTP/1.0或HTTP/1.1。
$uri	請求中的當(dāng)前URI(不帶請求參數(shù)，參數(shù)位于request_uri的值，它可以通過內(nèi)部重定向，或者使用index指令進(jìn)行修改。不包括協(xié)議和主機(jī)名，例如/foo/bar.html