Nginx内置变量应用场景分析

 更新时间:2025年11月24日 11:28:32   作者:岚叔运维  
Nginx内置变量速查表,涵盖请求URI、客户端信息、服务器信息、文件路径、响应与性能等类别,这篇文章给大家介绍Nginx内置变量应用场景分析,感兴趣的朋友跟随小编一起看看吧

Nginx 的内置变量是其配置灵活性的核心,它们提供了丰富的客户端请求和服务器状态信息。下述表格汇总了这些变量,并附带了实用的分类和说明,方便快速查阅和使用。

1. Nginx 内置变量速查表

变量类别

变量名

说明与示例

请求URI与参数

$uri/ $document_uri

当前请求的URI(不含参数),可能经过内部重写。例:/api/user

$request_uri

客户端原始的完整请求URI(含参数)。例:/api/user?id=1

$args/ $query_string

请求行中的参数字符串。例:id=1&name=test

$arg_name

获取指定名称的参数值。例:$arg_id的值为 1

$is_args

如果请求有参数,值为?,否则为空。常用于拼接URL

客户端信息

$remote_addr

客户端的直接IP地址

$http_x_forwarded_for

透传客户端原始IP的请求头,常用于识别经过代理的真实用户IP

$http_user_agent

客户端浏览器标识

$http_referer

请求来源页面

请求内容

$request_method

HTTP 请求方法,如 GETPOST

$content_length

请求头中的 Content-Length字段

$content_type

请求头中的 Content-Type字段

$request_body

客户端的请求主体内容

服务器信息

$host

请求的主机名,优先级:请求行 > "Host"请求头 > 匹配的服务器名

$server_name

当前匹配的服务器块名称

$server_port

请求到达的服务器端口

$scheme

请求协议,httphttps

$https

若为SSL安全模式,值为 on,否则为空

文件路径

$document_root

当前请求的文档根目录或别名

$request_filename

当前请求映射到的本地文件系统路径

响应与性能

$status

HTTP 响应状态码

$body_bytes_sent

发送给客户端的响应体字节数(不含头)

$request_time

处理请求所耗费的时间

其他常用变量

$cookie_name

获取指定名称的 Cookie 值

$http_name

获取任意请求头字段,将-替换为下划线,字母小写。例:$http_accept_language

$nginx_version

Nginx 版本号

$time_iso8601

服务器时间的 ISO 8601 格式

2. 核心变量详解与应用场景

了解这些变量的典型用法,能帮助你更好地配置Nginx。

  • 精确控制:$uri 与 $request_uri
    • $uri反映的是当前请求经过Nginx内部处理(如重写规则)后的URI,不带参数。它常用于内部重定向或作为其他指令的输入。
    • $request_uri则是客户端发来的原始请求,包含所有参数,且是只读的。在构建反向代理请求时,如果你希望原封不动地将客户端请求传递给后端,通常会使用 $request_uri
  • 获取客户端真实IP:$remote_addr $http_x_forwarded_for
    • 当客户端与Nginx服务器之间没有代理时,$remote_addr就是客户端的真实IP。
    • 当存在反向代理(如CDN、负载均衡器)时,$remote_addr会是最后一个代理服务器的IP。此时,代理服务器通常会将客户端的原始IP放在 X-Forwarded-For请求头中,这个值可以通过 $http_x_forwarded_for变量获取 。处理多级代理时,这个变量可能包含一个IP列表。
  • 灵活获取请求头:$http_name
    • 这是一个通用变量,name可以替换为任何请求头字段名的小写字母和下划线形式。例如,获取 Accept-Language头,使用 $http_accept_language。这为根据请求头信息做差异化处理提供了极大灵活性。

3. 实际应用举例

下面通过几个常见场景展示这些变量的用法。

记录详细日志

你可以在 log_format中组合使用变量,记录更丰富的信息。例如,记录客户端IP、用户代理、请求处理时间和响应状态:

log_format main '$remote_addr - $remote_user [$time_local] '
               '"$request" $status $body_bytes_sent '
               '"$http_referer" "$http_user_agent" '
               '$request_time';

访问控制与重定向

根据参数重写URL:

if ($arg_version = "v2") {
    rewrite ^/api/(.*)$ /v2/api/$1 last;
}

基于原始IP进行访问限制(注意:需确保代理服务器正确设置了 X-Forwarded-For):

# 允许来自192.168.1.100和10.0.0.0/8网段的请求
if ($http_x_forwarded_for !~* "^(192\.168\.1\.100|10\..*)") {
    return 403;
}

代理配置

在反向代理设置中,常使用变量向后端传递原始请求信息:

location /api/ {
    proxy_pass http://backend_server;
    # 将原始Host头传递给后端
    proxy_set_header Host $host;
    # 传递客户端真实IP
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
}

4. 注意事项

  • 变量使用场景:并非所有变量都可以在所有配置指令中使用,具体需参考Nginx官方文档。
  • 条件判断:在Nginx配置中,尤其是在 if指令中使用变量进行字符串匹配或条件判断时,需要特别注意Nginx的匹配规则,有时可能需要使用 ~*(不区分大小写匹配)或 ~(区分大小写匹配)等操作符 。
  • 变量性能:大部分内置变量开销很小,但频繁在复杂逻辑或高并发场景下使用某些涉及字符串处理的变量仍需注意。

到此这篇关于Nginx内置变量应用场景分析的文章就介绍到这了,更多相关nginx内置变量内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Nginx反向代理WebSocket响应403的解决办法

    详解Nginx反向代理WebSocket响应403的解决办法

    本篇文章主要介绍了详解Nginx反向代理WebSocket响应403的解决办法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • nginx如何通过proxy_pass设置反向代理,隐藏端口号

    nginx如何通过proxy_pass设置反向代理,隐藏端口号

    这篇文章主要介绍了nginx如何通过proxy_pass设置反向代理,隐藏端口号方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • 浅谈nginx读写锁的实现逻辑

    浅谈nginx读写锁的实现逻辑

    本文主要介绍了浅谈nginx读写锁的实现逻辑,是通过自旋锁来实现的,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-05-05
  • 通过nginx代理拦截请求进行全局访问限制

    通过nginx代理拦截请求进行全局访问限制

    这篇文章主要介绍了通过nginx代理拦截请求进行全局访问限制,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • nginx如何搭建前后端分离架构

    nginx如何搭建前后端分离架构

    本文介绍了如何使用Vue-cli搭建前端开发环境,并详细讲解了nginx、webpack-devserver和Postman的使用方法,此外,还介绍了API基本设计规范,包括HTTP状态码、数据格式和接口设计
    2025-01-01
  • Nginx平滑升级核心原理与location配置案例详解

    Nginx平滑升级核心原理与location配置案例详解

    Nginx平滑升级指在不中断服务的前提下,为Nginx添加新模块或更新版本,保障业务持续运行,下面通过本文给大家分享基于“为Nginx 1.24.0添加echo-nginx-module模块”的完整平滑升级流程,包含详细操作步骤、命令解释及注意事项,感兴趣的朋友一起看看吧
    2025-10-10
  • Nginx常用命令和部署详解以及实战案例示范

    Nginx常用命令和部署详解以及实战案例示范

    这篇文章主要介绍了Nginx的常用命令和在不同环境下的部署方法,包括在CentOS和Docker中部署Nginx,并详细说明了如何配置Nginx以实现实时刷新数据和数据分析系统的场景,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-02-02
  • nginx中path模式配置示例

    nginx中path模式配置示例

    这篇文章主要介绍了nginx中path模式配置示例,nginx服务器默认是不支持pathinfo模式的,需要修改配置才可以实现,本文即给出了配置示例,需要的朋友可以参考下
    2014-12-12
  • 详解Nginx反向代理到Tomcat服务器

    详解Nginx反向代理到Tomcat服务器

    本篇文章主要介绍了详解Nginx反向代理到Tomcat服务器,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • Nginx实现静态资源压缩的方法详解

    Nginx实现静态资源压缩的方法详解

    静态资源过大,下载耗时导致页面打开慢,希望通过压缩减小文件大小,提升下载速度,所以本文给大家介绍了Nginx实现静态资源压缩的方法,并通过代码示例给大家介绍的非常详细,需要的朋友可以参考下
    2024-02-02

最新评论