跳至主要內容

Nginx 代理中结尾 `/` 配置

王金城大约 3 分钟

在 Nginx 配置代理服务器时，proxy_pass 指令的结尾是否带 / 会对请求路径的处理方式产生重要影响。以下是详细的情况分析和使用场景说明，想要了解更多内容可以查看 Nginx 官方文档

proxy_pass 不带 / 的情况

当 proxy_pass 的 URL 不以 / 结尾时，Nginx 会将匹配到的路径部分完整地附加到代理目标地址之后。

行为分析

  • 假设配置如下：
    location /api {
    proxy_pass http://backend_server;
}
  • 当用户访问 http://example.com/api/resource 时：
    • 匹配到的路径是 /api/resource。
    • Nginx 将完整的路径 /api/resource 附加到代理目标地址 http://backend_server 后面。
    • 最终被代理的请求为：http://backend_server/api/resource。

使用场景

  • 场景描述：后端服务需要接收到完整的原始路径（包括 /api）。
  • 示例：
    location /service {
    proxy_pass http://internal_service;
}
    • 用户访问：http://example.com/service/v1/data
    • 被代理到：http://internal_service/service/v1/data

proxy_pass 带 / 的情况

当 proxy_pass 的 URL 以 / 结尾时，Nginx 会将匹配到的路径部分去掉前缀后，再附加到代理目标地址之后。

行为分析

  • 假设配置如下：
    location /api/ {
    proxy_pass http://backend_server/;
}
  • 当用户访问 http://example.com/api/resource 时：
    • 匹配到的路径是 /api/resource。
    • 由于 proxy_pass 结尾带 /，Nginx 去掉前缀 /api，仅保留剩余部分 /resource。
    • 然后将 /resource 附加到代理目标地址 http://backend_server/ 后面。
    • 最终被代理的请求为：http://backend_server/resource。

使用场景

  • 场景描述：后端服务不需要接收到原始路径的前缀部分（如 /api），只需要实际的资源路径。
  • 示例：
    location /static/ {
    proxy_pass http://file_server/;
}
    • 用户访问：http://example.com/static/images/logo.png
    • 被代理到：http://file_server/images/logo.png

特殊情况：location 和 proxy_pass 的组合

1. location 不带 /，但 proxy_pass 带 / 禁止使用

警告

这种方式是禁止使用的，因为代理后的地址会附加一个 /，导致路径错误。

  • 假设配置如下：
    location /api {
    proxy_pass http://backend_server/;
}
  • 当用户访问 http://example.com/api/resource 时：
    • 匹配到的路径是 /api/resource。
    • 由于 proxy_pass 结尾带 /，Nginx 去掉前缀 /api，仅保留剩余部分 /resource。
    • 然后将其附加到代理目标地址 http://backend_server/ 后面。
    • 最终被代理的请求为：http://backend_server//resource（注意多余的 /）。

2. location 带 /，但 proxy_pass 不带 /

  • 假设配置如下：
    location /api/ {
    proxy_pass http://backend_server;
}
  • 当用户访问 http://example.com/api/resource 时：
    • 匹配到的路径是 /api/resource。
    • 由于 proxy_pass 不带 /，Nginx 会将整个路径 /api/resource 附加到代理目标地址 http://backend_server 后面。
    • 最终被代理的请求为：http://backend_server/api/resource。

总结对比

http://example.com/api/resource --> http://backend_server/api/resource

location /api {
   proxy_pass http://backend_server;
}

http://example.com/api/resource --> http://backend_server/resource

location /api/ {
   proxy_pass http://backend_server/;
}

http://example.com/api/resource --> http://backend_server/api/resource

location /api/ {
   proxy_pass http://backend_server;
}

警告

http://example.com/api/resource --> http://backend_server//resource 禁止使用

location /api {
   proxy_pass http://backend_server/;
}

注意事项

  1. 尾部斜杠的重要性：

    • location 和 proxy_pass 是否带 / 对路径处理有直接影响。
    • 如果不明确需求，建议统一规则，避免路径混乱。

  2. 调试工具：

    • 使用 curl 或浏览器开发者工具检查最终的代理请求路径。
    • 在 Nginx 配置中启用日志记录（如 error_log 或 access_log）以跟踪请求路径。

  3. 避免多余斜杠：

    • 如果出现类似 http://backend_server//api/resource 的问题，可以通过调整配置或使用 rewrite 规则修复路径。