nginx配置中，location的优先级以及if指令带来的坑

原创已于 2024-05-22 18:25:11 修改 · 1.8k 阅读

16 ·

CC 4.0 BY-SA版权

文章标签：

#nginx #运维

于 2024-05-22 18:21:38 首次发布

在 Nginx 配置中，location 指令用于定义请求 URI 与特定资源或服务的映射关系。location 块的匹配优先级是按特定规则设定的，下面是详细的优先级规则，从高到低：

精确匹配 (=)：
- 匹配请求的 URI 必须完全一样。
- 示例：
```
location = /exact-match {
    # 配置指令
}
```
前缀匹配 (^~)：
- 如果匹配到此类型的 location，则 Nginx 不会再进行正则表达式的匹配。
- 示例：
```
location ^~ /static/ {
    # 配置指令
}
```
正则匹配 (~ 或 ~*)：
- ~ 表示区分大小写匹配
- ~* 表示不区分大小写匹配
- 如果有多个正则表达式匹配，则选择匹配度最高的那个。
- 示例：
```
location ~ \.php$ {
    # 配置指令
}
location ~* \.(jpg|jpeg|png|gif)$ {
    # 配置指令
}
```
前缀匹配 (无修饰符)：
- 对于没有任何修饰符的 location 块，Nginx 会按照最长前缀匹配的原则进行匹配。
- 示例：
```
location /images/ {
    # 配置指令
}
location / {
    # 配置指令
}
```

匹配流程：

Nginx 首先尝试匹配精确匹配的 location 块。
如果没有找到精确匹配的块，Nginx 会尝试匹配前缀匹配 (^~) 的块。
如果没有找到合适的前缀匹配的块，再尝试匹配正则表达式的 location 块。
最后，Nginx 会匹配前缀匹配的 location 块（未带任何修饰符的）。

通过这样的优先级规则，Nginx 能够确定应该使用的 location 块，从而选择合适的配置指令来处理请求。

特别注意：

Nginx if 指令在配置文件中的使用往往会产生一些误解，尤其是当开发者误解其工作方式和作用范围时可能会带来一些不期望的行为。这主要是由于 Nginx if 指令的动作并不像许多编程语言中的 if 那样灵活和可预测。以下是一些常见的误解以及如何避免这些问题：

常见的误解及问题原因

if 指令的作用范围：
- Nginx 的 if 指令只能在 server、location 或 http 块内使用，不能嵌套在其他块中。
- 误解在于一些开发者可能期望 if 可以用在更细粒度的位置，如 upstream 块内，但实际上这是不允许的。
if 指令的副作用：
- 有时候 if 指令会导致意外的副作用，例如重写规则和条件逻辑中的意外行为。
- 这是因为 Nginx 的配置在设计上是声明性配置，而 if 本质上却是一种命令性逻辑，容易引发逻辑冲突。
指令执行的顺序问题：
- 由于 Nginx 配置文件的顺序特别重要，if 条件可能会导致配置逻辑变得不直观和难以预测。
- 例如，在某些情况下，if 语句中的条件和嵌套的指令可能不会按预期顺序执行。

如何避免 `if` 带来的误解

避免在复杂逻辑中使用 if：
- 对于复杂的条件处理，尽量使用其他方式，如 try_files 或将逻辑拆分到多个 location 块中。
- 示例：
```
location / {
    try_files $uri $uri/ /index.php$is_args$args;
}
```

使用更明确的配置方式：

尽量依赖 Nginx 的其他内置功能，如 map 指令、重写模块中的 rewrite 指令等等，而不是使用 if。

示例：

map $http_user_agent $mobile {
    default 0;
    ~*Mobile 1;
}

server {
    listen 80;
    server_name example.com;

    location / {
        if ($mobile) {
            rewrite ^ /mobile last;
        }
    }

    location /mobile {
        # ......
    }
}

认真测试 if 语句及其作用：
- 如确有需要使用 if，应反复测试其作用效果和可能的副作用，确保逻辑及顺序均符合预期。
参考官方文档和最佳实践：
- 确保查阅 Nginx 的官方文档，了解 if 指令的相关限制和推荐的使用方法。
- 官方关于 if 块的警告：https://www.nginx.com/resources/wiki/start/topics/depth/ifisevil/