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

2024-06-15 00:44

本文主要是介绍从零手写实现 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 指令是一个用来在配置文件中进行条件判断的工具。

它通常用于 serverlocation、和 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 指令在某些情况下可能会导致配置难以维护,特别是在嵌套复杂逻辑时。
    • 它不能改变现有上下文中的配置(如 serverlocation),只能对请求进行处理。
  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 配置示例,展示如何在 httpserverlocation 模块中使用 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 = "") {# 执行指令,例如返回 404return 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$") {# 执行指令,例如返回 403return 403;}}}
}

配置说明

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

  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

这篇关于从零手写实现 nginx-23-directive IF 条件判断指令的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1061949

相关文章

Nginx location匹配模式与规则详解

《Nginxlocation匹配模式与规则详解》:本文主要介绍Nginxlocation匹配模式与规则,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、环境二、匹配模式1. 精准模式2. 前缀模式(不继续匹配正则)3. 前缀模式(继续匹配正则)4. 正则模式(大

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

C++如何通过Qt反射机制实现数据类序列化

《C++如何通过Qt反射机制实现数据类序列化》在C++工程中经常需要使用数据类,并对数据类进行存储、打印、调试等操作,所以本文就来聊聊C++如何通过Qt反射机制实现数据类序列化吧... 目录设计预期设计思路代码实现使用方法在 C++ 工程中经常需要使用数据类,并对数据类进行存储、打印、调试等操作。由于数据类

Python实现图片分割的多种方法总结

《Python实现图片分割的多种方法总结》图片分割是图像处理中的一个重要任务,它的目标是将图像划分为多个区域或者对象,本文为大家整理了一些常用的分割方法,大家可以根据需求自行选择... 目录1. 基于传统图像处理的分割方法(1) 使用固定阈值分割图片(2) 自适应阈值分割(3) 使用图像边缘检测分割(4)

Android实现在线预览office文档的示例详解

《Android实现在线预览office文档的示例详解》在移动端展示在线Office文档(如Word、Excel、PPT)是一项常见需求,这篇文章为大家重点介绍了两种方案的实现方法,希望对大家有一定的... 目录一、项目概述二、相关技术知识三、实现思路3.1 方案一:WebView + Office Onl

Java中Switch Case多个条件处理方法举例

《Java中SwitchCase多个条件处理方法举例》Java中switch语句用于根据变量值执行不同代码块,适用于多个条件的处理,:本文主要介绍Java中SwitchCase多个条件处理的相... 目录前言基本语法处理多个条件示例1:合并相同代码的多个case示例2:通过字符串合并多个case进阶用法使用

C# foreach 循环中获取索引的实现方式

《C#foreach循环中获取索引的实现方式》:本文主要介绍C#foreach循环中获取索引的实现方式,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录一、手动维护索引变量二、LINQ Select + 元组解构三、扩展方法封装索引四、使用 for 循环替代

Spring Security+JWT如何实现前后端分离权限控制

《SpringSecurity+JWT如何实现前后端分离权限控制》本篇将手把手教你用SpringSecurity+JWT搭建一套完整的登录认证与权限控制体系,具有很好的参考价值,希望对大家... 目录Spring Security+JWT实现前后端分离权限控制实战一、为什么要用 JWT?二、JWT 基本结构

Java实现优雅日期处理的方案详解

《Java实现优雅日期处理的方案详解》在我们的日常工作中,需要经常处理各种格式,各种类似的的日期或者时间,下面我们就来看看如何使用java处理这样的日期问题吧,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言一、日期的坑1.1 日期格式化陷阱1.2 时区转换二、优雅方案的进阶之路2.1 线程安全重构2

Android实现两台手机屏幕共享和远程控制功能

《Android实现两台手机屏幕共享和远程控制功能》在远程协助、在线教学、技术支持等多种场景下,实时获得另一部移动设备的屏幕画面,并对其进行操作,具有极高的应用价值,本项目旨在实现两台Android手... 目录一、项目概述二、相关知识2.1 MediaProjection API2.2 Socket 网络