# 获取Nginx内置绑定变量 `Nginx`作为一个成熟、久经考验的负载均衡软件，与其提供丰富、完整的内置变量是分不开的，它极大增加了我们对`Nginx`网络行为的控制细度。这些变量大部分都是在请求进入时解析的，并把他们缓存到会话`cycle`中，方便下一次获取使用。首先我们来看看`Nginx`对我们都开放了那些`API`。 参看下表： | 名称 | 说明 | |-----|-----| | $arg_name | 请求中的name参数 | | $args | 请求中的参数 | | $binary_remote_addr | 远程地址的二进制表示 | | $body_bytes_sent | 已发送的消息体字节数 | | $content_length | HTTP请求信息里的"Content-Length" | | $content_type | 请求信息里的"Content-Type" | | $document_root | 针对当前请求的根路径设置值 | | $document_uri | 与$uri相同; 比如 /test2/test.php | | $host | 请求信息中的"Host"，如果请求中没有Host行，则等于设置的服务器名 | | $hostname | 机器名使用 gethostname系统调用的值 | | $http_cookie | cookie 信息 | | $http_referer | 引用地址 | | $http_user_agent | 客户端代理信息 | | $http_via | 最后一个访问服务器的Ip地址。 | | $http_x_forwarded_for | 相当于网络访问路径 | | $is_args | 如果请求行带有参数，返回“?”，否则返回空字符串 | | $limit_rate | 对连接速率的限制 | | $nginx_version | 当前运行的nginx版本号 | | $pid | worker进程的PID | | $query_string | 与$args相同 | | $realpath_root | 按root指令或alias指令算出的当前请求的绝对路径。其中的符号链接都会解析成真是文件路径 | | $remote_addr | 客户端IP地址 | | $remote_port | 客户端端口号 | | $remote_user | 客户端用户名，认证用 | | $request | 用户请求 | | $request_body | 这个变量（0.7.58+）包含请求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比较有意义 | | $request_body_file | 客户端请求主体信息的临时文件名 | | $request_completion | 如果请求成功，设为"OK"；如果请求未完成或者不是一系列请求中最后一部分则设为空 | | $request_filename | 当前请求的文件路径名，比如/opt/nginx/www/test.php | | $request_method | 请求的方法，比如"GET"、"POST"等 | | $request_uri | 请求的URI，带参数; 比如[http://localhost:88/test1/](http://localhost:88/test1/) | test2/test.php | | $scheme | 所用的协议，比如http或者是https | | $server_addr | 服务器地址，如果没有用listen指明服务器地址，使用这个变量将发起一次系统调用以取得地址(造成资源浪费) | | $server_name | 请求到达的服务器名 | | $server_port | 请求到达的服务器端口号 | | $server_protocol | 请求的协议版本，"HTTP/1.0"或"HTTP/1.1" | | $uri | 请求的URI，可能和最初的值有不同，比如经过重定向之类的 | 很多是吧，其实这还不是全部，`Nginx`一直在不停迭代更新是一个原因，还有一个原因是有些变量太冷门。使用它们，我们将会有很多玩法。 首先，我们在`OpenResty`中如何引用这些变量呢？参考[ngx.var.VARIABLE](http://wiki.nginx.org/HttpLuaModuleZh#ngx.var.VARIABLE)小节。 利用这些内置变量，来做一个简单的数学求和运算例子： ~~~ server { listen 8866; server_name localhost; location /sum { #处理业务 content_by_lua_block { local a = tonumber(ngx.var.arg_a) or 0 local b = tonumber(ngx.var.arg_b) or 0 ngx.say("sum:", a + b ) } } } ~~~ 验证一下： ~~~ ➜ ~ curl 'http://127.0.0.1:8866/sum?a=11&b=12' sum:23 ~~~ 也许你笑了，这个`API`太简单了，貌似实际意义不大。我们做个最简易的防火墙，貌似有就那么点意思了不是？ 代码如下： ~~~ server { listen 8866; server_name localhost; location /sum { # 使用access阶段完成准入阶段处理 access_by_lua ' local black_ips = {["127.0.0.1"]=true} local ip = ngx.var.remote_addr if true == black_ips[ip] then ngx.exit(ngx.HTTP_FORBIDDEN) end '; #处理业务 content_by_lua_block { local a = tonumber(ngx.var.arg_a) or 0 local b = tonumber(ngx.var.arg_b) or 0 ngx.say("sum:", a + b ) } } } ~~~ 测试 shell ： ~~~ ➜ ~ curl '192.168.1.104:8866/sum?a=11&b=12' sum:23 ➜ ~ ➜ ~ ➜ ~ curl '127.0.0.1:8866/sum?a=11&b=12' 403 Forbidden 403 Forbidden openresty/1.9.3.1 ~~~ 通过测试结果看到，我们提取了终端的`IP`地址后进行限制，我们这个简单防火墙就诞生了。稍微扩充一下，就可以做到支持范围，如果再可以与系统`iptables`进行配合，那么达到软防火墙的目的就没有任何问题。 目前为止，我们所有的例子都是对`Nginx`内置变量的获取，我们是否可以对其进行设置呢？其实大多数内容都是不允许写入的，例如刚刚的终端`IP`地址，在应用中我们是不允许对其进行更新的。对于可写的变量中的`limit_rate`，是值得一提的，他能完成传输速率限制。进一步说对于静态文件传输、日志传输的情况，我们可以用它来完成限速的效果，它的影响是单个请求。 例如下面的例子： ~~~ location /download { access_by_lua ' ngx.var.limit_rate = 1000 '; } ~~~ 我们来下载这个文件： ~~~ ➜ ~ wget '127.0.0.1:8866/download/1.cab' --2015-09-13 13:59:51-- http://127.0.0.1:8866/download/1.cab Connecting to 127.0.0.1:8866... connected. HTTP request sent, awaiting response... 200 OK Length: 135802 (133K) [application/octet-stream] Saving to: '1.cab' 1.cab 6%[===> ] 8.00K 1.01KB/s eta 1m 53s ~~~