Nginx之Rewrite

Nginx服务器的Rewrite功能的实现依赖于PCRE的支持，因此在编译安装Nginx服务器之前，需要安装PCRE库。Nginx使用的是ngx_http_rewrite_module模块来解析和处理Rewrite功能的相关配置。

安装PCRE库

Nginx服务器的Rewrite功能的实现依赖于PCRE的支持，因此在编译安装Nginx服务器之前下载

yum install pcre pcre-devel
./configure --with-pcre=/usr/local
make
sudo make install

Rewrite的相关指令

set指令

该指令用来设置一个新的变量。

语法	set $variable value;
默认值
位置	server、location、if

variable:变量的名称，该变量名称要用"$"作为变量的第一个字符，且不要与Nginx服务器预设的全局变量同名。value:变量的值，可以是字符串、其他变量或者变量的组合等。

Rewrite常用全局变量

变量	说明
$args	变量中存放了请求URL中的请求参数。比如http://192.168.200.133/server?arg1=value1&args2=value2中的"arg1=value1&arg2=value2"，功能和$query_string一样
$http_user_agent	变量存储的是用户访问服务的代理信息(如果通过浏览器访问，记录的是浏览器的相关版本信息)
$host	变量存储的是访问服务器的server_name值
$document_uri	变量存储的是当前访问地址的URI。比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server"，功能和$uri一样
$document_root	变量存储的是当前请求对应location的root值，如果未设置，默认指向Nginx自带html目录所在位置
$content_length	变量存储的是请求头中的Content-Length的值
$content_type	变量存储的是请求头中的Content-Type的值
$http_cookie	变量存储的是客户端的cookie信息，可以通过add_header Set-Cookie 'cookieName=cookieValue'来添加cookie数据
$limit_rate	变量中存储的是Nginx服务器对网络连接速率的限制，也就是Nginx配置中对limit_rate指令设置的值，默认是0，不限制。
$remote_addr	变量中存储的是客户端的IP地址
$remote_port	变量中存储了客户端与服务端建立连接的端口号
$remote_user	变量中存储了客户端的用户名，需要有认证模块才能获取
$scheme	变量中存储了访问协议
$server_addr	变量中存储了服务端的地址
$server_name	变量中存储了客户端请求到达的服务器的名称
$server_port	变量中存储了客户端请求到达服务器的端口号
$server_protocol	变量中存储了客户端请求协议的版本，比如"HTTP/1.1"
$request_body_file	变量中存储了发给后端服务器的本地文件资源的名称
$request_method	变量中存储了客户端的请求方式，比如"GET","POST"等
$request_filename	变量中存储了当前请求的资源文件的路径名
$request_uri	变量中存储了当前请求的URI，并且携带请求参数，比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server?id=10&name=zhangsan"

if指令

该指令用来支持条件判断，并根据条件判断结果选择不同的Nginx配置。

语法	if (condition){...}
默认值
位置	server、location

condition为判定条件，可以支持以下写法：

1.变量名。如果变量名对应的值为空字符串或"0"，if都判断为false,其他条件为true。

x if ($param){    

}

2.使用"="和"!="比较变量和字符串是否相等，满足条件为true，不满足为false

if ($request_method = POST){
	return 405;
}

注意：此处和Java不太一样的地方是字符串不需要添加引号,并且等号和不等号前后到需要加空格。

3.使用正则表达式对变量进行匹配，匹配成功返回true，否则返回false。变量与正则表达式之间使用"~","~*","!~","!~*"来连接。

"~"代表匹配正则表达式过程中区分大小写，

"~*"代表匹配正则表达式过程中不区分大小写

"!~"和"!~*"刚好和上面取相反值，如果匹配上返回false,匹配不上返回true

if ($http_user_agent ~ MSIE){
	#$http_user_agent的值中是否包含MSIE字符串，如果包含返回true
}

注意：正则表达式字符串一般不需要加引号，但是如果字符串中包含"}"或者是";"等字符时，就需要把引号加上。

4.判断请求的文件是否存在使用"-f"和"!-f"

if (-f $request_filename){
	#判断请求的文件是否存在
}
if (!-f $request_filename){
	#判断请求的文件是否不存在
}

break指令

该指令用于中断当前相同作用域中的其他Nginx配置。与该指令处于同一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指令配置无效。并且break还有另外一个功能就是终止当前的匹配并把当前的URI在本location进行重定向访问处理。

语法	break;
默认值
位置	server、location、if

举例

location /testbreak{
	default_type text/plain;
	set $username TOM; # set $username TOM; 指令设置变量 $username 的初始值为 "TOM"。
	if ($args){ # set $username TOM; 指令设置变量 $username 的初始值为 "TOM"。
		Set $username JERRY; # 如果 URL 参数存在，则执行下一行的 Set $username JERRY; 指令，将 $username 设置为 "JERRY"。
        break; # 然后，执行 break; 指令用于终止 if 块的执行，跳过 set $username ROSE; 指令
		set $username ROSE; 
	}
	add_header username $username; # add_header username $username; 指令添加一个名为 "username" 的响应头部，并将其值设置为 $username 变量的值。
	return 200 $username; # add_header username $username; 指令添加一个名为 "username" 的响应头部，并将其值设置为 $username 变量的值。
}

return指令

该指令用于完成对请求的处理，直接向客户端返回。在return后的所有Nginx配置都是无效的。

语法	return code [text]; return code URL; return URL;
默认值
位置	server、location、if

• code:为返回给客户端的HTTP状态代理。可以返回的状态代码为0~999的任意HTTP状态代理
• text:为返回给客户端的响应体内容，支持变量的使用
• URL:为返回给客户端的URL地址

举例

location /testreturn {

	return 200 success; # 该配置会直接返回一个状态码为 200 （请求成功）的响应，内容为 "success"。这种情况下，响应类型为默认值 text/plain。
}

location /testreturn {

	return https://www.baidu.com; # 该配置将会返回一个状态码为 302（重定向）的响应，并将客户端重定向到 https://www.baidu.com。由于没有指定 return 指令的第一个参数（HTTP 状态码），因此使用了默认值 302。
}

location /testreturn {
	return 302 https://www.baidu.com; # 该配置与第二个配置类似，都是将客户端重定向到 https://www.baidu.com。但是，这里显式地指定了状态码为 302。
}

rewrite指令

该指令通过正则表达式的使用来改变URI。可以同时存在一个或者多个指令，按照顺序依次对URL进行匹配和处理。

语法	rewrite regex replacement [flag];
默认值
位置	server、location、if

• regex:用来匹配URI的正则表达式
• replacement:匹配成功后，用于替换URI中被截取内容的字符串。如果该字符串是以"http://"或者"https://"开头的，则不会继续向下对URI进行其他处理，而是直接返回重写后的URI给客户端。

location /rewrite {
	rewrite ^/rewrite/url\w*$ https://www.baidu.com;
	rewrite ^/rewrite/(test)\w*$ /$1;
	rewrite ^/rewrite/(demo)\w*$ /$1;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

1. 第一个location块是一个重写规则，当请求的URI是以"/rewrite/url"开头的时候，会将请求重定向到"https://www.baidu.com"。例如，/rewrite/url123会被重定向到https://www.baidu.com。
2. 第二个和第三个location块分别匹配以"/rewrite/test"和"/rewrite/demo"开头的URI。然后将匹配到的部分重新组成新的URI，分别是/test和/demo。例如，/rewrite/test123会被重定向到/test，/rewrite/demotest会被重定向到/demo。
3. 最后两个location块分别匹配URI为/test和/demo的请求。它们都设置了响应头的Content-Type为"text/plain"，并返回状态码为200的成功响应。实际响应内容分别为test_success和demo_success。

flag:用来设置rewrite对URI的处理行为，可选值有如下：

• last:终止继续在本location块中处理接收到的URI，并将此处重写的URI作为一个新的URI，使用各location块进行处理。该标志将重写后的URI重写在server块中执行，为重写后的URI提供了转入到其他location块的机会。

location /rewrite {
	rewrite ^/rewrite/(test)\w*$ /$1 last;
	rewrite ^/rewrite/(demo)\w*$ /$1 last;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

1. 第一个location块中的rewrite规则匹配以"/rewrite/test"开头且以字母、数字或下划线结尾的URL。然后将匹配到的部分重新组成新的URI，即/$1，其中$1表示正则表达式中第一个括号匹配的内容。最后的last关键字表示在此处完成重写，并继续处理新的URI。
2. 第二个location块中的rewrite规则匹配以"/rewrite/demo"开头且以字母、数字或下划线结尾的URL。同样地，将匹配到的部分重新组成新的URI，即/$1。也使用了last关键字来完成重写并继续处理新的URI。
3. 最后两个location块分别匹配URI为/test和/demo的请求。它们都设置了响应头的Content-Type为"text/plain"，并返回状态码为200的成功响应。实际响应内容分别为test_success和demo_success。

 测试测试访问http://192.168.2.4:8081/rewrite/testabc，能正确访问

• break：将此处重写的URI作为一个新的URI,在本块中继续进行处理。该标志将重写后的地址在当前的location块中执行，不会将新的URI转向其他的location块。

location /rewrite {
    #/test   /usr/local/nginx/html/test/index.html
	rewrite ^/rewrite/(test)\w*$ /$1 break;
	rewrite ^/rewrite/(demo)\w*$ /$1 break;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

1. 第一个location块匹配URI为/rewrite的请求。它包含两个rewrite规则，分别匹配以"/rewrite/test"和"/rewrite/demo"开头且以字母、数字或下划线结尾的URL。与之前相比，这里使用了break关键字。它的作用是在此处完成重写，并且停止NGINX对新URI的处理。
2. 如果URI匹配到了/test或/demo，则会跳过第一个location块，直接执行相应的响应处理逻辑。与之前一样，都设置了响应头的Content-Type为"text/plain"，并返回状态码为200的成功响应。实际响应内容分别为test_success和demo_success。

 测试测试访问http://192.168.2.4:8081/rewrite/testabc，页面报404错误

• redirect：将重写后的URI返回给客户端，状态码为302，指明是临时重定向URI,主要用在replacement变量不是以"http://"或者"https://"开头的情况。

location /rewrite {
	rewrite ^/rewrite/(test)\w*$ /$1 redirect;
	rewrite ^/rewrite/(demo)\w*$ /$1 redirect;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

1. 第一个location块中的rewrite规则使用了redirect关键字。它匹配以"/rewrite/test"开头且以字母、数字或下划线结尾的URL，并将匹配到的部分重新组成新的URI，即/$1。同时，使用redirect关键字表示执行重定向操作，将客户端重定向到新的URI。
2. 第二个location块中也有类似的rewrite规则，匹配以"/rewrite/demo"开头且以字母、数字或下划线结尾的URL，并将匹配到的部分重新组成新的URI，即/$1。同样地，使用redirect关键字执行重定向操作。
3. 最后两个location块分别匹配URI为/test和/demo的请求，设置响应头的Content-Type为"text/plain"，并返回状态码为200的成功响应。实际响应内容分别为test_success和demo_success。

测试访问http://192.168.2.4:8081/rewrite/testabc，请求会被临时重定向，浏览器地址也会发生改变

• permanent：将重写后的URI返回给客户端，状态码为301，指明是永久重定向URI,主要用在replacement变量不是以"http://"或者"https://"开头的情况。

location /rewrite {
	rewrite ^/rewrite/(test)\w*$ /$1 permanent;
	rewrite ^/rewrite/(demo)\w*$ /$1 permanent;
}
location /test{
	default_type text/plain;
	return 200 test_success;
}
location /demo{
	default_type text/plain;
	return 200 demo_success;
}

1. 第一个location块中的rewrite规则使用了permanent关键字。它匹配以"/rewrite/test"开头且以字母、数字或下划线结尾的URL，并将匹配到的部分重新组成新的URI，即/$1。使用permanent关键字表示执行永久重定向操作，将客户端永久重定向到新的URI。
2. 第二个location块中也有类似的rewrite规则，匹配以"/rewrite/demo"开头且以字母、数字或下划线结尾的URL，并将匹配到的部分重新组成新的URI，即/$1。同样地，使用permanent关键字执行永久重定向操作。
3. 最后两个location块分别匹配URI为/test和/demo的请求，设置响应头的Content-Type为"text/plain"，并返回状态码为200的成功响应。实际响应内容分别为test_success和demo_success。

测试访问http://192.168.2.4:8081/rewrite/testabc ，请求会被永久重定向，浏览器地址也会发生改变

rewrite_log指令

该指令配置是否开启URL重写日志的输出功能。

语法	rewrite_log on|off;
默认值	rewrite_log off;
位置	http、server、location、if

 开启后，URL重写的相关日志将以notice级别输出到error_log指令配置的日志文件汇总。

rewrite_log on;
error_log  logs/error.log notice;

Rewrite的案例

准备三个域名,linux：vim /etc/hosts，win10：C:\Windows\System32\drivers\etc

127.0.0.1   www.test.cn
127.0.0.1   www.test1.cn
127.0.0.1   www.test.com

域名跳转

果我们想访问京东网站，大家都知道我们可以输入www.jd.com,但是同样的我们也可以输入www.360buy.com同样也都能访问到京东网站。这个其实是因为京东刚开始的时候域名就是www.360buy.com，后面由于各种原因把自己的域名换成了www.jd.com, 虽然说域名变量，但是对于以前只记住了www.360buy.com的用户来说，我们如何把这部分用户也迁移到我们新域名的访问上来，针对于这个问题，我们就可以使用Nginx中Rewrite的域名跳转来解决。

• 通过Nginx实现访问www.test.cn

server {
	listen 80;
	server_name www.test.cn;
	location /{
		default_type text/html;
		return 200 '
welcome to test
';
	}
}

 测试

• 通过Rewrite完成将www.test.com和www.test1.cn的请求跳转到www.test.cn  

server {
	listen 80;
	server_name www.test.com www.test1.cn;
	rewrite ^/ http://www.test.cn;
}

 测试www.test1.cn,跳转到www.test.cn

• 如何在域名跳转的过程中携带请求的URI？  

修改配置信息  

server {
	listen 80;
	server_name www.test.com www.test1.cn;
	rewrite ^(.*) http://www.test.cn$1；
}

域名镜像

镜像网站指定是将一个完全相同的网站分别放置到几台服务器上，并分别使用独立的URL进行访问。其中一台服务器上的网站叫主站，其他的为镜像网站。镜像网站和主站没有太大的区别，可以把镜像网站理解为主站的一个备份节点。可以通过镜像网站提供网站在不同地区的响应速度。镜像网站可以平衡网站的流量负载、可以解决网络宽带限制、封锁等。

而我们所说的域名镜像和网站镜像比较类似，上述案例中，将www.test.com和 www.test1.cn都能跳转到www.test.cn，那么www.test.cn我们就可以把它起名叫主域名，其他两个就是我们所说的镜像域名，当然如果我们不想把整个网站做镜像，只想为其中某一个子目录下的资源做镜像，我们可以在location块中配置rewrite功能，比如:

server {
    listen          80;
    server_name     www.test1.cn www.test.com;
    location /images {
    	rewrite ^/images (.*)$ http://www.test.cn$1;
    }

}

在上面的配置中，当请求的URL以"/images"开头时，rewrite规则将匹配到的URL重写为http://www.test.cn并保留原始请求中的路径部分（$1表示正则表达式捕获组）。这样，所有访问"/images"子目录下的资源都会被重定向到http://www.test.cn。

独立域名

一个完整的项目包含多个模块，比如购物网站有商品搜索模块、商品详情模块和购物车模块等，那么我们如何为每一个模块设置独立的域名。

http://search.test.com:81  访问商品搜索模块
http://item.test.com:82	  访问商品详情模块
http://cart.test.com:83	  访问商品购物车模块

配置

server{
	listen 81;
	server_name search.test.com;
	rewrite ^(.*) http://www.test.cn/search$1;
}
server{
	listen 82;
	server_name item.test.com;
	rewrite ^(.*) http://www.test.cn/item$1;
}
server{
	listen 83;
	server_name cart.test.com;
	rewrite ^(.*) http://www.test.cn/cart$1;
}

目录自动添加"/"

通过一个例子来演示下问题

server {
	listen	8082;
	server_name localhost;
	location /test{
		root html;
		index index.html;
	}
}

通过http://192.168.2.4:8082/test和通过http://192.168.2.4:8082/test/访问的区别？

如果不加斜杠，Nginx服务器内部会自动做一个301的重定向，重定向的地址会有一个指令叫server_name_in_redirect on|off;来决定重定向的地址：

如果该指令为on
	重定向的地址为:  http://server_name:8082/目录名/;
	http://localhost:8082/heima/
如果该指令为off
	重定向的地址为:  http://原URL中的域名:8082/目录名/;
	http://192.168.200.133:8082/heima/

所以就拿刚才的地址来说，http://192.168.2.4:8082/test如果不加斜杠，那么按照上述规则，如果指令server_name_in_redirect为on，则301重定向地址变为 http://localhost:8082/test/,如果为off，则301重定向地址变为http://192.168.2.4:8082/test/。后面这个是正常的，前面地址就有问题。

注意server_name_in_redirect指令在Nginx的0.8.48版本之前默认都是on，之后改成了off,所以现在我们这个版本不需要考虑这个问题，但是如果是0.8.48以前的版本并且server_name_in_redirect设置为on，我们如何通过rewrite来解决这个问题？  

测试我nginx当前版本为1.20.1，所以无论后面是否加斜杆也不影响

解决方案:我们可以使用rewrite功能为末尾没有斜杠的URL自动添加一个斜杠

server {
	listen	80;
	server_name localhost;
	server_name_in_redirect on;
	location /test{
		if (-d $request_filename){
			rewrite ^/(.*)([^/])$ http://$host/$1$2/ permanent;
		}
	}
}

测试,这样无论访问路径是否加了斜杠都可以访问成功

合并目录

搜索引擎优化(SEO)是一种利用搜索引擎的搜索规则来提高目的网站在有关搜索引擎内排名的方式。我们在创建自己的站点时，可以通过很多中方式来有效的提供搜索引擎优化的程度。其中有一项就包含URL的目录层级一般不要超过三层，否则的话不利于搜索引擎的搜索也给客户端的输入带来了负担，但是将所有的文件放在一个目录下又会导致文件资源管理混乱并且访问文件的速度也会随着文件增多而慢下来，这两个问题是相互矛盾的，那么使用rewrite如何解决上述问题?

举例，网站中有一个资源文件的访问路径时 /server/11/22/33/44/20.html,也就是说20.html存在于第5级目录下，如果想要访问该资源文件，客户端的URL地址就要写成 http://192.168.2.4/server/11/22/33/44/20.html,

server {
	listen 8083;
	server_name localhost;
	location /server{
		root html;
	}
}

但是这个是非常不利于SEO搜索引擎优化的，同时客户端也不好记.使用rewrite我们可以进行如下配置:

server {
	listen 8083;
	server_name localhost;

	   
	location /server{
	      rewrite ^/server-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+)\.html$ /server/$1/$2/$3/$4/$5.html last;
	}
}

这样的花，客户端只需要输入http://192.168.2.4:8082/server-11-22-33-44-20.html就可以访问到20.html页面了。这里也充分利用了rewrite指令支持正则表达式的特性。

防盗链

防盗链之前我们已经介绍过了相关的知识，在rewrite中的防盗链和之前将的原理其实都是一样的，只不过通过rewrite可以将防盗链的功能进行完善下，当出现防盗链的情况，我们可以使用rewrite将请求转发到自定义的一张图片和页面，给用户比较好的提示信息。下面我们就通过根据文件类型实现防盗链的一个配置实例:

location /images {
    root html;
    valid_referers none blocked 192.168.2.1; # 192.168.2.1的请求才被视为有效
    if ($invalid_referer){ # 使用if指令判断referer是否无效，即不在有效的referer列表中。
        #return 403;
        rewrite ^/    /images/forbidden.png break; # 如果referer无效，则执行rewrite规则
    }
}

valid_referers指令指定了有效的referer（引用页面）：

• none（无refer），none表示不允许有Referer头的请求
• blocked（被屏蔽），blocked表示不允许特定的Referer头访问资源
• 指定域名或ip

测试，用192.169.2.1去访问可以的，

如果用其他ip去访问，他会跳转到 forbidden.png图片