从零手写实现 nginx-23-directive IF 条件判断指令

前言

大家好，我是老马。很高兴遇到你。

我们为 java 开发者实现了 java 版本的 nginx

https://github.com/houbb/nginx4j

如果你想知道 servlet 如何处理的，可以参考我的另一个项目：

手写从零实现简易版 tomcat minicat

手写 nginx 系列

如果你对 nginx 原理感兴趣，可以阅读：

从零手写实现 nginx-01-为什么不能有 java 版本的 nginx?

从零手写实现 nginx-02-nginx 的核心能力

从零手写实现 nginx-03-nginx 基于 Netty 实现

从零手写实现 nginx-04-基于 netty http 出入参优化处理

从零手写实现 nginx-05-MIME类型（Multipurpose Internet Mail Extensions，多用途互联网邮件扩展类型）

从零手写实现 nginx-06-文件夹自动索引

从零手写实现 nginx-07-大文件下载

从零手写实现 nginx-08-范围查询

从零手写实现 nginx-09-文件压缩

从零手写实现 nginx-10-sendfile 零拷贝

从零手写实现 nginx-11-file+range 合并

从零手写实现 nginx-12-keep-alive 连接复用

从零手写实现 nginx-13-nginx.conf 配置文件介绍

从零手写实现 nginx-14-nginx.conf 和 hocon 格式有关系吗？

从零手写实现 nginx-15-nginx.conf 如何通过 java 解析处理？

从零手写实现 nginx-16-nginx 支持配置多个 server

从零手写实现 nginx-17-nginx 默认配置优化

从零手写实现 nginx-18-nginx 请求头+响应头操作

从零手写实现 nginx-19-nginx cors

从零手写实现 nginx-20-nginx 占位符 placeholder

前言

大家好，我是老马。

这一节我们将配置的加载，拆分为不同的模块加载处理，便于后续拓展。

if

详细介绍一下 nginx 的 if 指令

Nginx 的 if 指令是一个用来在配置文件中进行条件判断的工具。

它通常用于 server、location、和 http 块中，用于执行特定的指令或改变请求的处理方式。

虽然它提供了灵活性，但也需要小心使用，因为某些情况下它可能会导致配置复杂化或带来意想不到的行为。

语法

if (condition) {
    # 指令
}

常见条件判断

• 变量值匹配:

  if ($variable = value) {
      # 指令
  }

• 变量值不匹配:

  if ($variable != value) {
      # 指令
  }

• 变量是否设置:

  if ($variable) {
      # 指令
  }

• 变量是否为空:

  if ($variable = "") {
      # 指令
  }

• 正则表达式匹配:

  if ($variable ~ pattern) {
      # 指令
  }

• 正则表达式不匹配:

  if ($variable !~ pattern) {
      # 指令
  }

• 正则表达式匹配并忽略大小写:

  if ($variable ~* pattern) {
      # 指令
  }

• 正则表达式不匹配并忽略大小写:

  if ($variable !~* pattern) {
      # 指令
  }

示例

1. 重定向非 www 的请求到 www:

   server {
       server_name example.com;
       if ($host = example.com) {
           return 301 http://www.example.com$request_uri;
       }
   }

2. 基于 User-Agent 的条件处理:

   location / {
       if ($http_user_agent ~* "MSIE") {
           return 403;
       }
       # 其他指令
   }

3. 阻止某个特定 IP 访问:

   location / {
       if ($remote_addr = 192.168.1.1) {
           return 403;
       }
       # 其他指令
   }

注意事项

1. if 指令的限制:

   • if 指令在某些情况下可能会导致配置难以维护，特别是在嵌套复杂逻辑时。
   • 它不能改变现有上下文中的配置（如 server 或 location），只能对请求进行处理。

2. 避免使用if进行重写逻辑: Nginx 官方推荐尽量使用 map 指令、重写模块 (rewrite) 等替代 if 指令来处理 URL 重写等操作，因为这些方法更高效且更直观。

3. 尽量使用 try_files: 在处理静态文件和重定向时，try_files 是一个更好的选择，因为它在性能和可读性上更优。

更好的选择

在某些情况下，使用 map 指令或者特定模块（如 rewrite 模块）可以替代 if 指令，提供更高效且清晰的配置。

例如，可以使用 map 指令来处理复杂的条件逻辑：

map $host $is_www {
    default 0;
    "www.example.com" 1;
    "example.com" 2;
}

server {
    server_name example.com www.example.com;
    if ($is_www = 2) {
        return 301 http://www.example.com$request_uri;
    }
}

总结来说，Nginx 的 if 指令可以用于条件判断，但在使用时应谨慎，尽量考虑其他更高效和可维护的替代方案。

nginx if 模块，放在 http 模块，server 模块，location 块中的配置例子

下面是一些 Nginx 配置示例，展示如何在 http、server 和 location 模块中使用 if 指令。

每个示例都会说明如何在这些不同的上下文中使用 if 指令来进行各种条件判断。

在 http 模块中使用 if 指令

http {
    # 示例变量
    set $example_variable "test_value";

    # 变量值匹配
    if ($example_variable = "test_value") {
        # 执行指令，例如设置另一个变量
        set $matched "yes";
    }

    # 变量是否设置
    if ($example_variable) {
        # 执行指令，例如设置另一个变量
        set $is_set "yes";
    }

    # 其他 HTTP 块配置
    server {
        listen 80;
        server_name example.com;

        location / {
            root /var/www/html;
            index index.html;
        }
    }
}

在 server 模块中使用 if 指令

http {
    server {
        listen 80;
        server_name example.com;

        # 示例变量
        set $example_variable "test_value";

        # 变量值不匹配
        if ($example_variable != "other_value") {
            # 执行指令，例如重定向
            return 301 http://example.com/redirect;
        }

        # 变量是否为空
        if ($example_variable = "") {
            # 执行指令，例如返回 404
            return 404;
        }

        location / {
            root /var/www/html;
            index index.html;
        }
    }
}

在 location 模块中使用 if 指令

http {
    server {
        listen 80;
        server_name example.com;

        location / {
            root /var/www/html;
            index index.html;

            # 示例变量
            set $example_variable "test_value";

            # 正则表达式匹配
            if ($example_variable ~ "^test.*") {
                # 执行指令，例如设置头部
                add_header X-Matched "yes";
            }

            # 正则表达式匹配并忽略大小写
            if ($example_variable ~* "TEST.*") {
                # 执行指令，例如设置头部
                add_header X-Matched-IgnoreCase "yes";
            }

            # 正则表达式不匹配
            if ($example_variable !~ "^no_match$") {
                # 执行指令，例如返回 403
                return 403;
            }
        }
    }
}

配置说明

1. 在 http 模块中：这里的 if 指令可以用来设置全局变量或根据条件设置变量。配置项适用于整个 http 块中的所有 server 和 location。

2. 在 server 模块中：if 指令用于服务器级别的配置，例如条件重定向或返回特定的 HTTP 状态码。

3. 在 location 模块中：if 指令可以针对特定的 URL 路径进行更细粒度的控制，如条件设置响应头部或根据变量值返回特定状态码。

请注意，虽然在 if 指令中可以执行很多操作，但在实际配置中应尽量避免过于复杂的逻辑，以确保服务器的高性能和可维护性。如果有更复杂的需求，建议考虑使用 Nginx 的 map 指令或其他更合适的模块。

java 如何实现 nginx 的 if 指令特性（基础能力）

一些思考

感觉我们需要把配置文件中的基础属性全部全拿出来？不然初始化的时机要怎么定义呢？

IF 指令也应该是在根据最新的数据，条件判断得到的。

核心实现

/**
 * 操作符
 *
 * @since 0.21.0
 * @author 老马啸西风
 */
public class NginxIfOperatorManager {

    private static final Map<String, NginxIfOperator> map = new HashMap<>();

    static {
        final NginxIfOperatorDefine operatorDefine = new NginxIfOperatorDefine();
        final NginxIfOperatorEquals operatorEquals = new NginxIfOperatorEquals();
        final NginxIfOperatorNotEquals operatorNotEquals = new NginxIfOperatorNotEquals();
        final NginxIfOperatorRegexMatch regexMatch = new NginxIfOperatorRegexMatch();
        final NginxIfOperatorRegexNotMatch regexNotMatch = new NginxIfOperatorRegexNotMatch();
        final NginxIfOperatorRegexMatchIgnoreCase regexMatchIgnoreCase = new NginxIfOperatorRegexMatchIgnoreCase();
        final NginxIfOperatorRegexMatchIgnoreCaseNot regexMatchIgnoreCaseNot = new NginxIfOperatorRegexMatchIgnoreCaseNot();

        map.put(operatorDefine.operator(), operatorDefine);
        map.put(operatorEquals.operator(), operatorEquals);
        map.put(operatorNotEquals.operator(), operatorNotEquals);
        map.put(regexMatch.operator(), regexMatch);
        map.put(regexNotMatch.operator(), regexNotMatch);
        map.put(regexMatchIgnoreCase.operator(), regexMatchIgnoreCase);
        map.put(regexMatchIgnoreCaseNot.operator(), regexMatchIgnoreCaseNot);
    }

    public boolean match(NginxCommonConfigEntry configParam, NginxRequestDispatchContext dispatchContext) {
        List<String> values = configParam.getValues();

        String key = getOperKey(configParam, dispatchContext);

        return map.get(key).eval(values.get(0), values.get(2), dispatchContext);
    }

    protected String getOperKey(NginxCommonConfigEntry configParam, NginxRequestDispatchContext dispatchContext) {
        List<String> values = configParam.getValues();

        if(values.size() == 1) {
            return "";
        }

        return values.get(1);
    }

}

小结

if 是一个非常灵活的能力，但是非常灵活的同时，可能会导致配置变得难以维护。

我们后续考虑继续学习下 map rewrite try_files 等指令。

我是老马，期待与你的下次重逢。

开源地址

为了便于大家学习，已经将 nginx 开源

https://github.com/houbb/nginx4j