nginx自定义变量与内置预定义变量的使用

总览

nginx可以使用变量简化配置与提高配置的灵活性，所有的变量值都可以通过这种方式引用：

$变量名

而nginx中的变量分为两种，自定义变量与内置预定义变量

内置变量

声明

可以在sever,http,location等标签中使用set命令（非唯一）声明变量，语法如下

set $变量名 变量值

注意nginx中的变量必须都以$开头。

可见性

nginx的配置文件中所有使用的变量都必须是声明过的，否则nginx会无法启动并打印相关异常日志

nginx变量的一个有趣的特性就是nginx中没一个变量都是全局可见的，而他们又不是全局变量。比如下面这个例子

location a/ {
 return 200 $a
}

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

由于变量是全局可见的所以nginx启动不会报错，而第一个location中并不知道$a的具体值因此返回的响应结果为一个空字符串。

在不同层级的标签中声明的变量性的可见性规则如下:

• location标签中声明的变量中对这个location块可见
• server标签中声明的变量对server块以及server块中的所有子块可见
• http标签中声明的变量对http块以及http块中的所有子块可见

内置预定义变量

内置预定义变量即无需声明就可以使用的变量，通常包括一个http请求或响应中一部分内容的值，以下为一些常用的内置预定义变量

变量名	定义
$arg_parameter	get请求中变量名parameter参数的值。
$args	这个变量等于get请求中的参数。例如，foo=123&bar=blahblah;这个变量只可以被修改
$binary_remote_addr	二进制码形式的客户端地址。
$body_bytes_sent	传送页面的字节数
$content_length	请求头中的content-length字段。
$content_type	请求头中的content-type字段。
$cookie_cookie	cookie cookie的值。
$document_root	当前请求在root指令中指定的值。
$document_uri	与$uri相同。
$host	请求中的主机头(host)字段，如果请求中的主机头不可用或者空，则为处理请求的server名称(处理请求的server的server_name指令的值)。值为小写，不包含端口。
$hostname	机器名使用 gethostname系统调用的值
$http_header	http请求头中的内容，header为http请求中的内容转为小写，-变为_(破折号变为下划线)，例如：$http_user_agent(uaer-agent的值);
$sent_http_header	http响应头中的内容，header为http响应中的内容转为小写，-变为_(破折号变为下划线)，例如： $sent_http_cache_control, $sent_http_content_type…;
$is_args	如果$args设置，值为"?"，否则为""。
$limit_rate	这个变量可以限制连接速率。
$nginx_version	当前运行的nginx版本号。
$query_string	与$args相同。
$remote_addr	客户端的ip地址。
$remote_port	客户端的端口。
$remote_user	已经经过auth basic module验证的用户名。
$request_filename	当前连接请求的文件路径，由root或alias指令与uri请求生成。
$request_body	这个变量（0.7.58+）包含请求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比较有意义。
$request_body_file	客户端请求主体信息的临时文件名。
$request_completion	如果请求成功，设为"ok"；如果请求未完成或者不是一系列请求中最后一部分则设为空。
$request_method	这个变量是客户端请求的动作，通常为get或post。包括0.8.20及之前的版本中，这个变量总为main request中的动作，如果当前请求是一个子请求，并不使用这个当前请求的动作。
$request_uri	这个变量等于包含一些客户端请求参数的原始uri，它无法修改，请查看$uri更改或重写uri。
$scheme	所用的协议，比如http或者是https，比如rewrite ^(.+)$ $scheme://example.com$1 redirect;
$server_addr	服务器地址，在完成一次系统调用后可以确定这个值，如果要绕开系统调用，则必须在listen中指定地址并且使用bind参数。
$server_name	服务器名称。
$server_port	请求到达服务器的端口号。
$server_protocol	请求使用的协议，通常是http/1.0或http/1.1。
$uri	请求中的当前uri(不带请求参数，参数位于$$args)，不同于浏览器传递的args)，不同于浏览器传递的request_uri的值，它可以通过内部重定向，或者使用index指令进行修改。不包括协议和主机名，例如/foo/bar.html

到此这篇关于nginx自定义变量与内置预定义变量的使用的文章就介绍到这了,更多相关nginx自定义变量与内置预定义变量内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！