Nginx rewrite模块

介绍

Nginx的rewrite模块即ngx_http_rewrite_module标准模块，主要功能是重写请求URI，也是Nginx默认安装的模块。rewrite模块会根据PCRE正则匹配重写URI，然后根据指令参数或者发起内部跳转再一次进行location匹配，或者直接进行30x重定向返回客户端。
rewrite模块的指令就是一门微型的编程语言，包含set、rewrite、break、if、return等一系列指令。

set指令

set指令是由ngx_http_rewrite_module标准模块提供的，用于向变量存放值。在Nginx配置文件中，变量只能存放一种类型的值，因为只存在一种类型的值，那就是字符串。
set指令的配置项格式如下：

set $variable value;

注意：在Nginx配置文件中，变量定义和使用都要以$开头。Nginx变量名前面有一个$符号，这是记法上的要求。所有的Nginx变量在引用时必须带上$前缀。另外，Nginx变量不能与Nginx服务器预设的全局变量同名。比如，我们的nginx.conf文件中有下面这一行配置：

set $a hello world;

上面的语句中，set配置指令对变量$a进行了赋值操作，把字符串hello world赋给了它。也可以直接把变量嵌入字符串常量中以构造出新的字符串：

set $a foo; set $b $a, $a;

这个例子通过前面定义的变量$a的值来构造变量$b的值，于是这两条指令顺序执行完之后，$a的值是foo，而$b的值则是foo，foo。把变量嵌入字符串常量中以构造出新的字符串，这种技术在Linux Shell脚本中常常用到，并且被称为“变量插值”（VariableInterpolation）
set指令不仅有赋值的功能，还有创建Nginx变量的副作用，即当作为赋值对象的变量尚不存在时，它会自动创建该变量。比如在上面这个例子中，若$a这个变量尚未创建，则set指令会自动创建$a这个用户变量。
Nginx变量一旦创建，其变量名的可见范围就是整个Nginx配置，甚至可以跨越不同虚拟主机的server配置块。但是，对于每个请求，所有变量都有一份独立的副本，或者说都有各变量用来存放值的容器的独立副本，彼此互不干扰。Nginx变量的生命期是不可能跨越请求边界的。

rewrite指令

rewrite指令是由ngx_http_rewrite_module标准模块提供的，主要功能是改写请求URI。rewrite指令的格式如下：

rewrite regrex replacement [flag];

如果regrex匹配URI，URI就会被替换成replacement的计算结果，replacement一般是一个“变量插值”表达式，其计算之后的字符串就是新的URI。

下面的例子有两个重新配置项，具体如下：

location /download/ {  rewrite ^/download/(.*)/video/(.*)$ /view/$1/mp3/$2.mp3 last;  rewrite ^/download/(.*)/audio/(.*)*$ /view/$1/mp3/$2.rmvb last;  return 404; } location /view {  echo uri: $uri ; }

在这个演示例子中，replacement中的占位变量$1、$2的值是指令参数regrex正则表达式从原始URI中匹配出来的子字符串，也叫正则捕获组，编号从1开始。
rewrite指令可以使用的上下文为：server、location、if inlocation。
如果rewrite同一个上下文中有多个这样的rewrite重新指令，匹配就会依照rewrite指令出现的顺序先后依次进行下去，匹配成功之后并不会终止，而是继续往下匹配，直到返回最后一个匹配的为止。如果想要中途中止，不再继续往下匹配，可以使用第3个指令参数flag。flag参数的值有last、break、redirect、permanent。
如果flag参数使用last值，并且匹配成功，那么停止处理任何rewrite相关的指令，立即用计算后的新URI开始下一轮的location匹配和跳转。前面的例子使用的就是last参数值。
如果flag参数使用break值，就如同break指令的字面意思一样，停止处理任何rewrite的相关指令，但是不进行location跳转。
将上面的rewrite例子中的last参数值改成break，代码如下：

location /view {  echo  view : $uri ;  } location /download_break/ {  rewrite ^/download_break/(.*)/video/(.*)$ /view/$1/mp3/$2.mp3 break;  rewrite ^/download_break/(.*)/audio/(.*)*$ /view/$1/mp3/$2.rmvb break;  echo  download_break new uri : $uri ; }

在浏览器中请求http://crazydemo.com/download_break/1/video/10，地址发生了重写，但是location并没有跳转，而是直接结束了

在location上下文中，last和break是有区别的：last其实就相当于一个新的URL，Nginx进行了一次新的location匹配，通过last获得一个可以转到其他location配置中处理的机会（内部的重定向）；而break在一个location中将原来的URL（包括URI和args）改写之后，再继续进行后面的处理，这个重写之后的请求始终都是在同一个location上下文中，并没有发生内部跳转。
这里要注意：last和break的区别仅仅发生在location上下文中；如果发生在server上下文，那么last和break的作用是一样的。
还要注意：在location上下文中的rewrite指令使用last指令参数会再次以新的URI重新发起内部重定向，再次进行location匹配，而新的URI极有可能和旧的URI一样再次匹配到相同的目标location中，这样死循环就发生了。当循环到第10次时，Nginx会终止这样无意义的循环并返回500错误。这一点需要特别注意。
如果rewrite指令使用的flag参数的值是permanent，就表示进行外部重定向，也就是在客户端进行重定向。此时，服务器将新URI地址返回给客户端浏览器，并且返回301（永久重定向的响应码）给客户端。客户端将使用新的重定向地址再发起一次远程请求。在浏览器中的表现就是地址变为重定向地址了。
如果rewrite指令使用的flag参数的值是redirect，就表示进行外部重定向，表现的行为与permanent参数值完全一样，不同的是返回302（临时重定向的响应码）给客户端。

if条件指令

if条件指令配置项的格式如下：

if (condition) {...}

当if条件满足时，执行配置块中的配置指令。if的配置块相当于引入了一个新的上下文作用域。if条件指令适用于server和location两个上下文。

condition条件表达式可以用到一系列比较操作符，大致如下：
（1）=：相等。
（2）!=：不相等。
（3）~：区分字母大小写模式匹配。
（4）~*：不区分字母大小写模式匹配。
（5）还有其他几个专用比较符号，比如判断文件及目录是否存在的符号，等等。
下面是一个简单的演示程序，根据内置变量$http_user_agent的值判断客户端的类型，代码如下：

#if指令的演示程序 location /if_demo {  if ($http_user_agent ~*Firefox) { #匹配Firefox浏览器  return 403;  }

匹配谷歌浏览器

 if ($http_user_agent ~*Chrome) { #匹配Chrome谷歌浏览器  return 301;  }  if ($http_user_agent ~*iphone) { #匹配iPhone手机  return 302;  }  if ($http_user_agent ~*android) { #匹配安卓手机  return 404;  }  return 405; #其他浏览器默认访问规则 }

在演示代码中使用到了return指令，用于返回HTTP的状态码。
return指令会停止同一个作用域的剩余指令处理，并返回给客户端指定的响应码。
return指令可以用于server、location、if上下文中，执行阶段是rewrite阶段。其指令的格式如下：

#格式一：返回响应的状态码和提示文字，提示文字可选 return code [text]; #格式二：返回响应的重定向状态码(如301)和重定向URL return code URL; #格式三：返回响应的重定向URL，默认的返回状态码是临时重定向302 return URL;

实例：

server {   listen       80;   server_name  localhost;      # 普通匹配，这里是为了配合/ 中的rewrite last 命令   location /gis/uv/ {     proxy_pass http://127.0.0.1:8080;   }      location / {          set $is_match_wind 0;     # 如果是/gis/xxx/xxx.json格式，就重新进入匹配     if ($request_uri ~* /gis/[0-9]{8}/[0-9]{8}-uv-[0-9]{3}\.json$) {       set $is_match_wind 1;       # 这里会重新再次匹配location /gis/uv/部分进入       rewrite /gis/([0-9]{8})/([0-8]{8}-uv-[0-9]{3}\.json)$ /gis/uv/$1/$2 last;     }          # 如果不是/gis/xx/xxx.json,就直接在本地进行查找文件     if ($is_match_wind = 0) {       root html;     }   }   error_page   500 502 503 504  /50x.html;   location = /50x.html {     root   html;   } }

这部分参考官方文档：http://nginx.org/en/docs/http/ngx_http_rewrite_module.html

server {     listen       80;     server_name  localhost; 		 		location / { 		 			set $is_match_wind 0; 			if ($request_uri ~* /gis/uv/[0-9]{8}/[0-9]{8}-uv-[0-9]{3}\.json$) { 				set $is_match_wind 1; 				rewrite /gis/uv/([0-9]{8})/([0-8]{8}-uv-[0-9]{3}\.json)$ /gis/$1/$2 break; 			} 			 			# 如果不是/gis/xx/xxx.json,就直接在本地进行查找文件 			if ($is_match_wind = 0) { 				root html; 			} 		}     error_page   500 502 503 504  /50x.html;     location = /50x.html {         root html;     } }

这上面的配置，但浏览器中输入
[http://localhost/gis/uv/20220415/20220415-uv-004.json](http://localhost/gis/uv/20220415/20220415-uv-004.json)或 [http://localhost/gis/20220415/20220415-uv-004.json](http://localhost/gis/uv/20220415/20220415-uv-004.json) 都可以访问到本地磁盘中html里面的 gis/20220415/xxxx.json文件，说明last和break只是不执行rewrite部分逻辑了，其他的逻辑还会执行
image.png

add_header指令

response header一般是以key：value的形式，例如Content-Encoding：
gzip、Cache-Control：no-store，设置的命令如下：

add_header Cache-Control no-store; add_header Content-Encoding gzip;

但是，有一个十分常用的response header为Content-Type，可以在它设置了类型的同时指定charset，例如text/html；charset=utf-8，由于其存在分号，而分号在配置文件中作为结束符，因此在配置时需要用引号把其引起来，配置如下：

add_header Content-Type 'text/html; charset=utf-8';

使用AJAX进行跨域请求时，浏览器会向跨域资源的服务端发送一个OPTIONS请求，用于判断实际请求是否安全或者判断服务端是否允许跨域访问，这种请求也叫作预检请求。跨域访问的预检请求是浏览器自动发出的，用户程序往往不知情，如果不进行特别的配置，那么客户端发出一次请求，在服务端往往会收到两个请求；一个是预检请求；另一个是正式的请求。后端的服务器（PHP或者Tomcat）如果不经过特殊的过滤，那么很容易将OPTIONS预检请求当成正式的数据请求。
对于客户端而言，只有预检请求返回成功，客户端才开始正式请求。在实际的使用场景中，预检请求比较影响性能，用户往往会有两倍请求的感觉，所以一般会在Nginx代理服务端对预检请求进行提前拦截，同时对预检请求设置比较长时间的有效期。

upstream zuul {   #server 192.168.233.1:7799; 	server 192.168.233.128:7799; 	keepalive 1000; } server {  	listen 80;  	server_name nginx.server *.nginx.server;  	default_type 'text/html';  	charset utf-8;  	#转发到上游服务器，但是 'OPTIONS' 请求直接返回空  	location / {  		if ($request_method = 'OPTIONS') {  			add_header Access-Control-Max-Age 1728000;  			add_header Access-Control-Allow-Origin *;  			add_header Access-Control-Allow-Credentials true;  			add_header Access-Control-Allow-Methods 'GET, POST, OPTIONS';  			add_header Access-Control-Allow-Headers 'Keep-Alive,User-Agent,X-Requested-With,\ If-Modified-Since,Cache-Control,Content-Type,token';  			return 204;  		}  		proxy_pass http://zuul/ ;  	}  }

配置Nginx，加入Access-Control-Max-Age请求头，用来指定本次预检请求的有效期，单位为秒。上面结果中的有效期是20天（1 728 000秒），即允许缓存该条回应1 728 000秒，在此期间客户端不用发出另一条预检请求。

指令的执行顺序

大多数Nginx新手都会频繁遇到这样一个困惑：当同一个location配置块使用了多个Nginx模块的配置指令时，这些指令的执行顺序很可能会跟它们的书写顺序大相径庭。现在就来看这样一个令人困惑的例子：

location /sequence_demo_1 {  set $a foo;  echo $a;  set $a bar;  echo $a; }

上面的代码先给变量$a赋值foo，随后输出，再给变量$a赋值bar，随后输出。如果这是一段Java代码，毫无疑问，最终的输出结果一定为“foo bar”。然而不幸的是，事实并非如此，在浏览器中访问http://crazydemo.com/sequence_demo_1，结果如图7-24所示。


为什么出现了这种不合常理的现象呢？
Nginx的请求处理阶段共有11个，分别是post-read、server-rewrite、find-config、rewrite、post-rewrite、preaccess、access、post-access、try-files、content以及log。其中3个比较常见的按照执行时的先后顺序依次是rewrite阶段、access阶段以及content阶段。
Nginx的配置指令一般只会注册并运行在其中的某一个处理阶段，比如set指令就是在rewrite阶段运行的，而echo指令只会在content阶段运行。因此，属于rewrite阶段的配置指令（示例中的set）总是会无条件地在content阶段的配置指令（示例中的echo）之前执行，即便是echo配置项出现在set配置项的前面。
上面例子中的指令按照请求处理阶段的先后次序排序，实际的执行次序如下：

location /sequence_demo_1 {  #rewrite阶段的配置指令，执行在前面  set $a foo;  set $a bar;  #content阶段的配置指令，执行在后面  echo $a;  echo $a; }

所以，输出的结果就是bar bar了。

参考：

[1] https://www.toutiao.com/i6976865819091419681/
[2] https://www.toutiao.com/i6806616548166337027/ (另一篇，未学习)