Nginx

1、目标

Nginx反向代理，路径映射的过程是什么？如何配置路径映射规则？

2、location 路径匹配

2.1 匹配规则

location 路径正则匹配：

符号 说明
~ 正则匹配，区分大小写
~* 正则匹配，不区分大小写
^~ 普通字符匹配，如果该选项匹配，则，只匹配该选项，不再向下匹配其他选项
= 普通字符匹配，精确匹配
@ 定义一个命名的 location，用于内部定向，例如 error_page，try_files

Nginx的location指令支持几种不同的匹配模式，不同的模式有不同的匹配逻辑和优先级。理解这些规则的优先级是配置Nginx路由的关键。

精确匹配（=）

精确匹配是指请求的URI必须完全匹配配置中的location块。如果URI与location块的字符串完全一致，则会匹配此location块。例如：

  1. location = /hello {
  2.     return 200 "Hello, World!";
  3. }

当访问/hello时，Nginx将返回Hello, World!，其他任何URI（如/hello/）都不会匹配该location块。

前缀匹配（/）

前缀匹配是Nginx中最常见的匹配方式，它会匹配URI的前缀部分。例如：

  1. location /images/ {
  2.     root /var/www/images;
  3. }

当请求的URI以/images/开头时（例如/images/photo.jpg），就会匹配此location块。需要注意的是，前缀匹配是从左到右进行匹配的，且Nginx会寻找最长的前缀匹配。

正则匹配（~ and ~* and ^~）

Nginx还支持使用正则表达式来进行匹配。正则表达式匹配通常用于更复杂的场景，例如匹配动态的路径或查询参数。

  • ~ 表示区分大小写的正则匹配。
  • ~* 表示不区分大小写的正则匹配。
  • ^~ 前缀匹配标记(~)例如
  1. location ~ \.php$ {
  2.   fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
  3. }

此规则会匹配所有以.php结尾的请求，并将其转发给PHP-FPM处理。正则匹配会根据location块中的正则表达式从请求的URI中提取信息。

正则匹配优先级

正则匹配的优先级较高，在同一层级下，如果正则匹配成功，Nginx会立即使用该location块，不再继续向下查找其他规则。

  1. location ~* \.jpg$ {
  2.     root /var/www/images;
  3. }
  5. location /images/ {
  6.     root /var/www/images;
  7. }

最长前缀匹配

当多个location规则能够匹配同一个请求时，Nginx会选择最长的前缀匹配规则。如果前缀匹配的长度相同，则选择最先出现的规则。

  1. location /images/ {
  2.     root /var/www/images;
  3. }
  5. location /images/photo/ {
  6.     root /var/www/photos;
  7. }

对于请求/images/photo/abc.jpg，Nginx会选择/images/photo/规则，因为它是最长的前缀匹配。

默认匹配（default）

Nginx还提供了一个默认的location规则，用于处理无法匹配任何特定规则的请求。在location块中可以使用default来定义默认行为：

  1. location / {
  2.     root /var/www/html;
  3. }
  5. location /default {
  6.     return 404;
  7. }

如果没有任何其他规则匹配的请求，会使用默认的location块进行处理。

2.2 匹配优先级

路径匹配，优先级：（跟 location 的书写顺序关系不大）

  1. 精确匹配：=前缀的指令严格匹配这个查询。如果找到，停止搜索。
  2. 普通字符匹配：所有剩下的常规字符串，最长的匹配。如果这个匹配使用^~前缀，搜索停止。
  3. 正则匹配：正则表达式，在配置文件中定义的顺序，匹配到一个结果，搜索停止；
  4. 默认匹配：如果第3条规则产生匹配的话，结果被使用。否则，如同从第2条规则被使用。

2.3 举例

通过一个实例，简单说明一下匹配优先级：

  1. location  = / {
  2.   # 精确匹配 / ，主机名后面不能带任何字符串
  3.   [ configuration A ]
  4. }
  6. location  / {
  7.   # 因为所有的地址都以 / 开头，所以这条规则将匹配到所有请求
  8.   # 但是正则和最长字符串会优先匹配
  9.   [ configuration B ]
  10. }
  12. location /documents/ {
  13.   # 匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索
  14.   # 只有后面的正则表达式没有匹配到时，这一条才会采用这一条
  15.   [ configuration C ]
  16. }
  18. location ~ /documents/Abc {
  19.   # 匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索
  20.   # 只有后面的正则表达式没有匹配到时，这一条才会采用这一条
  21.   [ configuration CC ]
  22. }
  24. location ^~ /images/ {
  25.   # 匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条。
  26.   [ configuration D ]
  27. }
  29. location ~* \.(gif|jpg|jpeg)$ {
  30.   # 匹配所有以 gif,jpg或jpeg 结尾的请求
  31.   # 然而，所有请求 /images/ 下的图片会被 config D 处理，因为 ^~ 到达不了这一条正则
  32.   [ configuration E ]
  33. }
  35. location /images/ {
  36.   # 字符匹配到 /images/，继续往下，会发现 ^~ 存在
  37.   [ configuration F ]
  38. }
  40. location /images/abc {
  41.   # 最长字符匹配到 /images/abc，继续往下，会发现 ^~ 存在
  42.   # F与G的放置顺序是没有关系的
  43.   [ configuration G ]
  44. }
  46. location ~ /images/abc/ {
  47.   # 只有去掉 config D 才有效：先最长匹配 config G 开头的地址，继续往下搜索，匹配到这一条正则，采用
  48.     [ configuration H ]
  49. }
  51. location ~* /js/.*/\.js

按照上面的location写法，以下的匹配示例成立：

  1. / -> config A：精确完全匹配，即使/index.html也匹配不了
  2. /downloads/download.html -> config B：匹配B以后，往下没有任何匹配，采用B
  3. /images/1.gif -> configuration D：匹配到F，往下匹配到D，停止往下
  4. /images/abc/def -> config D：最长匹配到G，往下匹配D，停止往下你可以看到 任何以/images/开头的都会匹配到D并停止，FG写在这里是没有任何意义的，H是永远轮不到的，这里只是为了说明匹配顺序
  5. /documents/document.html -> config C：匹配到C，往下没有任何匹配，采用C
  6. /documents/1.jpg -> configuration E：匹配到C，往下正则匹配到E
  7. /documents/Abc.jpg -> config CC：最长匹配到C，往下正则顺序匹配到CC，不会往下到E

其他匹配示例

  1. location ~ ^/(cn|tw|de|fr|es|pt|jp|it|ar)/ai/object-remover/ {
  2.   rewrite ^/(cn|tw|de|fr|es|pt|jp|it|ar)/ai/object-remover/(.*)$ /$1/application/object-remover/$2 break;
  3.   proxy_pass https://xxx.xxx.com;
  5.   proxy_set_header Host $host;
  6.   proxy_set_header X-Real-IP $remote_addr;
  7.   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  9.   # Rewrite all requests to use j4.flexclip.com as the base URL
  10. }

此规则会匹配所有 /cn/ai/object-remover/、/tw/ai/object-remover/、/fr/ai/object-remover/ 等的请求。

整段配置的功能是：

  • URI 匹配与重写：任何匹配 /cn/ai/object-remover/、/tw/ai/object-remover/ 等路径的请求，都将会被重写。重写后的路径将会变成 /语言代码/application/object-remover/原始路径，例如 /cn/application/object-remover/abc/xyz。
  • 请求转发：重写后的请求将通过 proxy_pass 被转发到 https://xxx.xxx.com。
  • 请求头设置：在转发请求时，设置了原始请求的 Host、客户端的 X-Real-IP 和 X-Forwarded-For 头。

3、总结

Nginx的路由匹配规则通过精确匹配、前缀匹配、正则匹配和默认匹配进行请求处理。理解这些匹配规则的优先级和使用场景，将有助于你更高效地配置Nginx并避免潜在的错误。通过灵活地组合这些匹配规则，你可以实现非常复杂的路由逻辑，满足各种业务需求。