【Web服务器】Nginx之Rewrite与location的用法

---

前言

  现在许多公司都会用nginx去反向代理服务器。在域名更名后需要保持旧域名能够跳转到新域名上。如果在后端使用apache服务器虽然也可以去跳转，但是效率没有nginx高。

---

一、正则表达式

1. Nginx 的正则表达式

匹配符	功能说明
^	匹配输入字符串的起始位置
$	匹配输入字符串的结束位置
*	匹配前面的字符零次或多次。如 ol* 能匹配 o 及 ol、oll
+	匹配前面的字符一次或多次。如 ol+ 能匹配 ol及 oll、olll，但不能匹配 o 。
?	匹配前面的字符零次或一次，例如 do(es)? 能匹配 do 或者 does ，? 等效于{0,1}
.	匹配除 \n 之外的任何单个字符，若要匹配包括“\n”在内的任意字符，请使用诸如 [.\n]` 之类的模式
\	将后面接着的字符标记为一个特殊字符或一个原义字符或一个向后引用。如 \n 匹配一个换行符，而 \$ 则匹配 $
\d \s \w	匹配纯数字[0-9] 空白符 任意单词字符包括下划线 [A-Za-z0-9_]
{n}	重复 n 次
{n,}	重复 n 次或更多次
{n,m}	重复 n 到 m 次
[]	定义匹配的字符范围
[c]	匹配单个字符 c
[a-z]	匹配 a-z 小写字母的任意一个
[a-zA-Z0-9]	匹配所有大小写字母或数字
()	表达式的开始和结束位置
`	`

2. 正则表达的优势

• 精确匹配，减少遍历的消耗。
• 节省服务响应的资源消耗。
• 提高用户体验感。
• 提高服务器并发时、处理效率/性能。

3. Nginx 使用正则的作用

  Nginx作为运维角度前段接受、想用客户请求的直接对服务器所以需要考虑到Nginx的执行效率（精确匹配-类比）、性能（资源消耗）、抗压能力（高并发时处理能力）、用户体验感（用户访问群体）。

二、location 的概念

1. location 和 rewrite 区别

  从功能看 rewrite 和 location 似乎有点像，都能实现跳转，主要区别在于 rewrite 是在同一域名内更改获取资源的路径，而 location 是对一类路径做控制访问或反向代理，还可以proxy _pass 到其他机器。

• rewrite ：对访问的域名或者域名内的URL路径地址重写。
• location ：对访问的路径做访问控制或者代理转发。

2. location 匹配的分类

location 大致可以分为三类：

• 精准匹配：location = / {...}
• 一般匹配：location / {...}
• 正则匹配：location ~ / {...}

3. location 常用的匹配规则

匹配规则	功能说明
=	进行普通字符的精准匹配
^~	表示普通字符匹配，使用前缀匹配。如果匹配成功则不会匹配其他的location
~	区分大小写
~*	不区分大小写
！~	区分大小写的不去匹配
！~*	不区分大小的不去匹配

3.1 location 匹配优先级

• 首先精确匹配 =；
• 其次前缀匹配 ^~；
• 其次是按文件中顺序的正则匹配 ~或~*；
• 然后匹配不带任何修饰符的一般前缀匹配；
• 最后是交给 / 通用匹配。

3.2 location 匹配的实例

location = / {}

​    =为精确匹配 / ，主机名后面不能带任何字符串。

​   比如访问 / 和 /data，则 / 匹配，/data 不匹配。再比如 location = /abc，则只匹配 /abc ，/abc/ 或 /abcd 不匹配。若 location /abc，则即匹配 /abc 、/abcd/ 同时也匹配 /abc/。

location / {}

​   因为所有的地址都以 / 开头，所以这条规则将匹配到所有请求。

​   比如访问 / 和 /data, 则 / 匹配，/data也匹配。但后面前缀路径会和最长字符串优先匹配（最长匹配）。

location /documents/ {}

​   匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索其它 location。

​   只有其它 location后面的前缀路径没有匹配到时，才会采用这一条。

location /documents/abc {}

​    匹配任何以 /documents/abc 开头的地址，匹配符合以后，还要继续往下搜索其它 location。

​   只有其它 location 后面的前缀路径没有匹配到时，才会采用这一条。

location ^~ /images/ {}

​    匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条。

location ~* \.(gif|jpg|jpeg)$ {}

​    匹配所有以 gif、jpg 或 jpeg 结尾的请求。

​   然而，所有请求 /images/ 下的图片会被 location ^~ /images/ 处理，因为 ^~ 的优先级更高，所以到达不了这一条正则。

location /images/abc {}

​   最长字符匹配到 /images/abc，优先级最低，继续往下搜索其它 location，会发现 ^~ 和 ~ 存在

location ~ /images/abc {}

​    匹配以 /images/abc 开头的，优先级次之，只有去掉 location ^~ /images/ 才会采用这一条

location /images/abc/1.html {}

​    匹配/images/abc/1.html 文件，如果和正则location ~ /images/abc/1.html 相比，正则优先级更高。

location 优先级总结

  首先看 优先级：精确= > 前缀^~ > 正则~,~* > 一般 > 通用/。

  在没有精准匹配的情况下，先看前缀匹配的长度，然后根据最长的前缀匹配的优先级去确定是否再去看其它正则匹配location，如果最长的前缀匹配带有 ^~ 则不再看其它正则匹配location，如果最长的前缀匹配是没有修饰符的一般匹配则会再看其它正则匹配location。

  前缀匹配看长度，最长的优先匹配。

  正则匹配看上下顺序，由上往下依次匹配，当有匹配成功时候，停止匹配，按当前匹配规则处理请求。

  只有在精准、前缀、正则、一般 都没有匹配到的时候才会看通用匹配。

3.3 实际网站规则定义

第一个必选规则

  直接匹配网站根目录首页，通过域名访问网站首页比较频繁，使用这个会加速处理，比如说官网。

  可以是一个静态首页，也可以直接转发给后端应用服务器。

location = /index.html {
    root   html;
	index  index.html index.htm;
}

第二个必选规则

  处理静态文件请求，这是nginx作为http服务器的强项。

  有两种配置模式，目录匹配或后缀匹配，任选其一或搭配使用。

location ^~ /static/ {
    root /webroot/;
}

location ~* \.(gif|jpg|jpeg|png|css|js|ico)$ {
    root /webroot/res/;
}

第三个规则

  通用规则，比如用来转发带.php、.jsp后缀的动态请求到后端应用服务器。

  非静态文件请求就默认是动态请求。

location / {
    proxy_pass http://tomcat_server;
}

三、Nginx Rewrite 的概述

1. rewrite 的功能

  rewrite功能就是，使用nginx提供的全局变量或自己设置的变量，结合正则表达式和标记位实现URL重写以及重定向。
  
比如：更换域名后需要保持旧的域名能跳转到新的域名上、某网页发生改变需要跳转到新的页面、网站防盗链等等需求。

2. rewrite 的用法

  rewrite只能放在server{}，location{}，if{}中，并且默认只能对域名后边的除去传递的参数外的字符串起作用，例如 http://www.accp.com/abc/bbs/index.php?a=1&b=2 只对 /abc/bbs/index.php 重写。

2.1 执行顺序

• 执行 server 块里面的 rewrite 指令。
• 执行 location 匹配。
• 执行选定的 location 中的 rewrite 指令。

3. rewrite 跳转实现

• Nginx 是通过 ngx_http_rewrite_module模块支持url重写、支持if条件判断，但不支持else。
• 另外该模块需要 PCRE支持，应在编译Nginx时指定PCRE 支持，默认已经安装。
• 根据相关变量重定向和选择不同的配置，从一个location跳转到另一个location，不过这样的循环最多可以执行10次，超过后Nginx将返回500错误。
• 重写模块包含set指令，来创建新的变量并设其值，这在有些情景下非常有用的，如记录条件标识、传递参数到其他location、记录做了什么等等。
• rewrite功能就是使用Nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。

4. rewrite 的语法格式

rewrite < regex > < replacement > [flag]

regex：正则表达式。

replacement ：跳转后的内容。

flag：rewrite支持的flag标记。

flag标记	说明
last	本条规则匹配完成后，不终止重写后的url匹配，一般用在 server 和 if 中。
break	本条规则匹配完成即终止，终止重写后的url匹配，一般使用在 location 中。
redirect	返回302临时重定向，浏览器地址会显示跳转后的URL地址。
permanent	返回301永久重定向，浏览器地址栏会显示跳转后的URL地址。

四、Rewrite 的实例

1. 基于域名的跳转

  现在公司旧域名www.accp.com有业务需求变更，需要使用新域名www.benet.com代替，但是旧域名不能废除，需要跳转到新域名上，而且后面的参数保持不变。

[root@localhost ~]# vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.accp.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.accp.com-access.log;		#日志修改
	location / {
	#添加域名重定向
        if ($host = 'www.accp.com'){						#$host为rewrite全局变量，代表请求主机头字段或主机名
			rewrite ^/(.*)$ http://www.benet.com/$1 permanent;	#$1为正则匹配的内容，即“域名/”之后的字符串
        }
        root   html;
        index  index.html index.htm;
    }
}

[root@localhost ~]# echo "192.168.145.45 www.accp.com www.benet.com" >> /etc/hosts
[root@localhost ~]# systemctl restart nginx

浏览器测试

浏览器输入模拟访问 http://www.accp.com(虽然这个请求内容是不存在的)
会跳转到www.benet.com，查看元素可以看到返回301，实现了永久重定向跳转，而且域名后的参数也正常跳转。

2. 基于客户端 IP 访问跳转

  今天公司业务新版本上线，要求所有 IP 访问任何内容都显示一个固定维护页面，只有公司 IP ：192.168.145 .45访问正常。

[root@localhost ~]# vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.accp.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.accp.com-access.log;		#日志修改

	#设置是否合法的IP标记
    set $rewrite true;							#设置变量$rewrite，变量值为boole值true
    #判断是否为合法IP
	if ($remote_addr = "192.168.145.45"){		#当客户端IP为192.168.145.45时，将变量值设为false，不进行重写
        set $rewrite false;
    }
	#除了合法IP，其它都是非法IP，进行重写跳转维护页面
    if ($rewrite = true){						#当变量值为true时，进行重写
        rewrite (.+) /weihu.html;				#将域名后边的路径重写成/weihu.html后转发，例如www.accp.com/weihu.html
    }
    location = /weihu.html {
        root /var/www/html;						#网页返回/var/www/html/weihu.html的内容
    }
	
	location / {
        root   html;
        index  index.html index.htm;
    }
}
[root@localhost ~]# mkdir -p /var/www/html/
[root@localhost ~]# echo "<h1>We are maintaining now!</h1>" > /var/www/html/weihu.html
[root@localhost ~]# systemctl restart nginx

如果rewrite (.+) /weihu.html; 换成rewrite (.+) /weihu.html permanent; 的话，若不是 192.168.145.45 的主机访问会使浏览器修改请求访问的 URL 成 http://www.accp.com/weihu.html 再请求访问，这样就会进入一直在 rewrite 的死循环，访问请求会一直被重写成 http://www.accp.com/weihu.html 再请求访问。

浏览器测试

用其他虚拟机访问
 http://www.accp.com

注意：访问的客户端也需要填写/etc/hosts

3. 基于旧域名跳转到新域名后面加目录

  现在访问的是 http://bbs.accp.com/post/，现在需要将这个域名下面的访问都跳转到http://www.accp.com/bbs/post/。

[root@localhost ~]# vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  bbs.accp.com www.accp.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.accp.com-access.log;
	location /bbs {
		root html;
	}
	#添加
	location /post {
		 
        rewrite (.+) http://www.accp.com/bbs$1 permanent;		#这里的$1为位置变量，代表/post
    }
	
	location / {
        root   html;
        index  index.html index.htm;
    }
}
}

[root@localhost ~]# mkdir -p /usr/local/nginx/html/bbs/post
[root@localhost ~]# echo "this is 1.html"  >> /usr/local/nginx/html/bbs/post/1.html
[root@localhost ~]# echo "192.168.145.45 bbs.accp.com"  >> /etc/hosts=

浏览器测试

使用浏览器访问 http://bbs.accp.com/post/1.html 跳转到 http://www.accp.com/bbs/post/1.html

4. 基于参数匹配的跳转

  现在访问http://www.accp.com/100-(100|200)-100.html 跳转到http://www.accp.com页面。

[root@localhost ~]# vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.accp.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.accp.com-access.log;
	
	if ($request_uri ~ ^/100-(100|200)-(\d+).html$) {
        rewrite (.+) http://www.accp.com permanent;
    }

	location / {
        root   html;
        index  index.html index.htm;
    }
}

[root@localhost ~]# systemctl restart nginx

• $request_uri：包含请求参数的原始URI，不包含主机名，如：http://www.accp.com/abc/bbs/index.html?a=1&b=2 中的 /abc/bbs/index.php?a=1&b=2
• $uri：这个变量指当前的请求URI，不包括任何参数，如:/abc/bbs/index.html
• $document_uri：与$uri相同，这个变量指当前的请求URI，不包括任何传递参数，如:/abc/bbs/index.html

浏览器测试

使用浏览器访问 http://www.accp.com/100-200-100.html 或 http://www.accp.com/100-100-100.html 跳转到http://www.accp.com页面。

5. 基于目录下所有 php 结尾的文件跳转

  要求访问 http://www.accp.com/upload/123.php 跳转到首页。

[root@localhost ~]# vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.accp.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.accp.com-access.log;
	
	location ~* /upload/.*\.php$ {
        rewrite (.+) http://www.accp.com permanent;
    }

	location / {
        root   html;
        index  index.html index.htm;
    }
}

[root@localhost ~]# systemctl restart nginx

浏览器测试

浏览器访问 http://www.accp.com/upload/123.php 跳转到http://www.accp.com页面。

6. 基于最普通一条 url 请求的跳转

  求访问一个具体的页面如 http://www.accp.com/abc/123.html 跳转到首页。

[root@localhost ~]# vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.accp.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.accp.com-access.log;
	
    location ~* ^/abc/123.html {
        rewrite (.+) http://www.accp.com permanent;
    }

	location / {
        root   html;
        index  index.html index.htm;
    }
}


[root@localhost ~]# systemctl restart nginx

浏览器测试

浏览器访问 http://www.accp.com/abc/123.html 跳转到http://www.accp.com页面。

总结

• location的分类（精确匹配、一般匹配、正则匹配）
• 掌握location的优先级(location = 完整路径) > (location ^~ 路径) > (location ,* 正则顺序) > (location 部分起始路径) > (location /)
• 掌握rewrite的几种使用方法：基于域名的跳转、基于客户端 IP 访问跳转、基于旧域名跳转到新域名后面加目录、基于参数匹配的跳转、基于目录下所有 php 结尾的文件跳转、基于最普通一条 url 请求的跳转