Nginx 内置绑定变量 · Spring Boot 技术栈

## 概述 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，带参数 | | $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](https://github.com/openresty/lua-nginx-module#ngxvarvariable)小节。利用这些内置变量，来做一个简单的数学求和运算例子： ``` server { listen 80; server_name openresty.tinywan.com; location /resty_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("[x] sum: ", a + b ) } } } ``` 验证结果 ``` PS C:\Users\Tinywan> curl -i "http://openresty.tinywan.com/resty_sum?a=2024&b=24" HTTP/1.1 200 OK Server: openresty/1.17.8.2 Date: Mon, 22 Jul 2024 07:28:47 GMT Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive [x] sum: 2048 ``` 也许你笑了，这个API太简单没有实际意义。我们做个简易防火墙，看看如何开始玩耍。参看下面示例代码： ``` server { listen 80; server_name openresty.tinywan.com; location /resty_access_sum { # 使用access阶段完成准入阶段处理 access_by_lua_block { local black_ips = {["172.18.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("[x] sum：", a + b ) } } } ``` 运行测试 ``` PS C:\Users\Tinywan> curl -i "http://openresty.tinywan.com/resty_access_sum?a=2024&b=24" HTTP/1.1 403 Forbidden Server: openresty/1.17.8.2 Date: Mon, 22 Jul 2024 08:42:30 GMT Content-Type: text/html; charset=utf-8 Content-Length: 159 Connection: keep-alive <html> <head><title>403 Forbidden</title></head> <body> <center><h1>403 Forbidden</h1></center> <hr><center>openresty/1.17.8.2</center> </body> </html> ``` 或者自定义错误提示语 ``` location /resty_access_sum { # 使用access阶段完成准入阶段处理 access_by_lua_block { local black_ips = {["172.18.0.1"]=true} local ip = ngx.var.remote_addr if true == black_ips[ip] then ngx.say("<html><body>Sorry, 403 Forbidden. 开源技术小栈.</body></html>") ngx.exit(ngx.HTTP_FORBIDDEN) end } } ``` 请求测试 ``` PS C:\Users\Tinywan> curl -i "http://openresty.tinywan.com/resty_access_sum?a=2024&b=24" HTTP/1.1 200 OK Server: openresty/1.17.8.2 Date: Mon, 22 Jul 2024 15:25:42 GMT Content-Type: application/octet-stream Transfer-Encoding: chunked Connection: keep-alive <html><body>Sorry, 403 Forbidden. 开源技术小栈.</body></html> ``` 通过测试结果看到，提取了终端的IP地址后进行限制。扩充一下，就可以支持 IP 地址段，如果再与系统`iptables`进行配合，那么就足以达到软防火墙的目的。目前为止，所有的例子都是对Nginx内置变量的获取，是否可以对其进行设置呢？其实大多数内容都是不允许写入的，例如刚刚的终端IP地址，在请求中是不允许对其进行更新的。对于可写的变量中的`limit_rate`，值得一提，它能完成传输速率限制，并且它的影响是单个请求级别。参看下面示例： ``` location /resty_download { # 使用access阶段完成准入阶段处理 access_by_lua_block { ngx.var.limit_rate = 1000 }; } ``` 下载测试： ``` wget "http://openresty.tinywan.com/resty_download/tinywan.lua" --2024-07-22 19:59:51-- http://openresty.tinywan.com/resty_download/tinywan.lua Connecting to 127.0.0.1:8866... connected. HTTP request sent, awaiting response... 200 OK Length: 135802 (133K) [application/octet-stream] Saving to: 'tinywan.lua' 1.cab 6%[===> ] 8.00K 1.01KB/s eta 1m 53s ```