Rewrite 是 Nginx 服务器提供的一个重要基本功能，是 Web 服务器产品中几乎必备的功能，主要的作用是用来实现 URL 的重写。

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

1. 地址重写与地址转发

  重写和转发的区别：

  • 地址重写浏览器地址会发生变化而地址转发则不变；
  • 一次地址重写会产生两次请求而一次地址转发只会产生一次请求；
  • 地址重写到的页面必须是一个完整的路径而地址转发则不需要；
  • 地址重写因为是两次请求所以request范围内属性不能传递给新页面而地址转发因为是一次请求所以可以传递值；
  • 地址转发速度快于地址重写。

2. Rewrite规则

2.1 set指令

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

语法 set $variable value;
默认值 -
位置 server、location、if
  • variable：变量的名称，该变量名称要用 “$” 作为变量的第一个字符，且不能与 Nginx 服务器预设的全局变量同名。
  • value：变量的值，可以是字符串、其他变量或者变量的组合等。

2.1.1 Rewrite常用全局变量

变量 说明
$args 变量中存放了请求URL中的请求指令。比如http://10.7.2.205:8080?arg1=value1&args2=value2中的arg1=value1&arg2=value2，功能和 $query_string 一样
$http_user_agent 变量存储的是用户访问服务的代理信息（如果通过浏览器访问，记录的是浏览器的相关版本信息）
$host 变量存储的是访问服务器的server_name值
$document_uri 变量存储的是当前访问地址的 URI。比如http://10.7.2.205/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://10.7.2.205/server?id=10&name=zhangsan中的/server?id=10&name=zhangsan

2.2 if指令

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

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

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

  1. 变量名，如果变量名对应的值为空或者是 0，if 都判断为 false，其他条件为 true。 
    1
    2
    3
    if ($param){

    }
  2. 使用 “=” 和 “!=” 比较变量和字符串是否相等，满足条件为 true，不满足为 false。 
    1
    2
    3
    if ($request_method = POST){
    	return 405;
    }
  3. 使用正则表达式对变量进行匹配，匹配成功返回 true，否则返回 false。变量与正则表达式之间使用~，~*，!~，!~*来连接。
    1
    2
    3
    4
    5
    6
    7
    "~"代表匹配正则表达式过程中区分大小写，
    "~*"代表匹配正则表达式过程中不区分大小写
    "!~"和"!~*"刚好和上面取相反值，如果匹配上返回false,匹配不上返回true

    if ($http_user_agent ~ MSIE){
    	#$http_user_agent的值中是否包含MSIE字符串，如果包含返回true
    }
    注意：正则表达式字符串一般不需要加引号，但是如果字符串中包
    含"}"或者是";"等字符时，就需要把引号加上。
  4. 判断请求的文件是否存在使用"-f"和"!-f"，当使用"-f"时，如果请求的文件存在返回 true，不存在返回 false；当使用"!-f"时，如果请求文件不存在，但该文件所在目录存在返回 true，文件和目录都不存在返回 false，如果文件存在返回 false。 
    1
    2
    3
    4
    5
    6
    if (-f $request_filename){
    	#判断请求的文件是否存在
    }
    if (!-f $request_filename){
    	#判断请求的文件是否不存在
    }
  5. 判断请求的目录是否存在使用"-d"和"!-d"，当使用"-d"时，如果请求的目录存在，if 返回 true，如果目录不存在则返回 false；当使用"!-d"时，如果请求的目录不存在但该目录的上级目录存在则返回 true，该目录和它上级目录都不存在则返回 false，如果请求目录存在也返回 false。
  6. 判断请求的目录或者文件是否存在使用"-e"和"!-e"，当使用"-e"，如果请求的目录或者文件存在时，if 返回 true，否则返回 false；当使用"!-e"，如果请求的文件和文件所在路径上的目录都不存在返回 true，否则返回 false。
  7. 判断请求的文件是否可执行使用"-x"和"!-x"，当使用"-x"，如果请求的文件可执行，if 返回 true，否则返回 false；当使用"!-x"，如果请求文件不可执行，返回 true，否则返回 false。

2.3 break指令

  该指令用于中断当前相同作用域中的其他 Nginx 配置。与该指令处于同一作用域的 Nginx 配置中，位于它前面的指令配置生效，位于后面的指令配置无效。

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

  例子：

1
2
3
4
5
6
7
location /{
	if ($param){
		set $id $1;
		break;
		limit_rate 10k;
	}
}

2.4 return指令

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

语法 return code [text]
return code URL
return URL
默认值 -
位置 server、location、if
  • code：为返回给客户端的 HTTP 状态代理。可以返回的状态代码为 0~999 的任意 HTTP 状态代理；
  • text：为返回给客户端的响应体内容，支持变量的使用；
  • URL：为返回给客户端的 URL 地址；

2.5 rewrite指令

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

1
2
URI：统一资源标识符
URL：统一资源定位符
语法 rewrite regex replacement [flag]
默认值 -
位置 server、location、if

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

  • last
  • break
  • redirect
  • permanent

2.6 rewrite_log指令

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

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

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

3. Rewrite的案例

3.1 域名跳转

问题分析

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

环境准备

  • 准备两个域名www.360buy.com|www.jd.com 
    1
    2
    3
    4
    vim /etc/hosts

    10.7.2.205 www.360buy.com
    10.7.2.205 www.jd.com
  • 在/usr/local/nginx/html/hm目录下创建一个访问页面： 
    1
    2
    3
    4
    5
    6
    <html>
    	<title></title>
    	<body>
    		<h1>欢迎来到我们的网站</h1>
    	</body>
    </html>
  • 通过 Nginx 实现当访问www.hm.com访问到系统的首页： 
    1
    2
    3
    4
    5
    6
    7
    8
    server {
    	listen 80;
    	server_name www.hm.com;
    	location /{
    		root /usr/local/nginx/html/hm;
    		index index.html;
    	}
    }
  • 通过 Rewrite 完成将www.360buy.com的请求跳转到www.jd.com： 
    1
    2
    3
    4
    5
    server {
    	listen 80;
    	server_name www.360buy.com;
    	rewrite ^/ http://www.jd.com permanent;
    }

问题描述：如何在域名跳转的过程中携带请求的URI？

  修改配置信息：

1
2
3
4
5
server {
	listen 80;
	server_name www.itheima.com;
	rewrite ^(.*) http://www.hm.com$1 permanent;
}

问题描述：我们除了上述说的www.jd.com、www.360buy.com其实还有我们也可以通过www.jingdong.com来访问，那么如何通过 Rewrite 来实现多个域名的跳转?

  添加域名：

1
2
vim /etc/hosts
10.7.2.205 www.jingdong.com

  修改配置信息：

1
2
3
4
5
server{
	listen 80;
	server_name www.360buy.com www.jingdong.com;
	rewrite ^(.*) http://www.jd.com$1 permanent;
}

3.2 域名镜像

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

1
2
3
4
5
6
7
8
9
10
server {
	listen 80;
	server_name rewrite.myweb.com;
	location ^~ /source1{
		rewrite ^/resource1(.*) http://rewrite.myweb.com/web$1 last;
	}
	location ^~ /source2{
		rewrite ^/resource2(.*) http://rewrite.myweb.com/web$1 last;
	}
}

3.3 独立域名

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

1
2
3
http://search.hm.com	访问商品搜索模块
http://item.hm.com 		访问商品详情模块
http://cart.hm.com 		访问商品购物车模块
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
server{
	listen 80;
	server_name search.hm.com;
	rewrite ^(.*) http://www.hm.com/bbs$1 last;
}
server{
	listen 81;
	server_name item.hm.com;
	rewrite ^(.*) http://www.hm.com/item$1 last;
}
server{
	listen 82;
	server_name cart.hm.com;
	rewrite ^(.*) http://www.hm.com/cart$1 last;
}

3.4 目录自动添加“/”

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

1
2
3
4
5
6
7
8
server {
	listen 80;
	server_name localhost;
	location / {
		root html;
		index index.html;
	}
}

  要想访问上述资源，很简单，只需要通过http://10.7.2.205直接就能访问，地址后面不需要加/，但是如果将上述的配置修改为如下内容：

1
2
3
4
5
6
7
8
server {
	listen 80;
	server_name localhost;
	location /hm {
		root html;
		index index.html;
	}
}

  这个时候，要想访问上述资源，按照上述的访问方式，我们可以通过http://10.7.2.205/hm/来访问，但是如果地址后面不加斜杠，页面就会出问题。如果不加斜杠，Nginx 服务器内部会自动做一个 301 的重定向，重定向的地址会有一个指令叫server_name_in_redirect on|off来决定重定向的地址：

1
2
3
4
如果该指令为on
	重定向的地址为: http://server_name/目录名/;
如果该指令为off
	重定向的地址为: http://原URL中的域名/目录名/;

  所以就拿刚才的地址来说，http://10.7.2.205/hm如果不加斜杠，那么按照上述规则，如果指令server_name_in_redirect为on，则 301 重定向地址变为http://localhost/hm/，如果为off，则 301 重定向地址变为http://10.7.2.205/ht/。后面这个是正常的，前面地址就有问题。
  注意server_name_in_redirect指令在 Nginx 的 0.8.48 版本之前默认都是on，之后改成了off，所以现在我们这个版本不需要考虑这个问题，但是如果是 0.8.48 以前的版本并且server_name_in_redirect设置为on，我们如何通过 rewrite 来解决这个问题？
  解决方案：
  我们可以使用 rewrite 功能为末尾没有斜杠的 URL 自动添加一个斜杠：

1
2
3
4
5
6
7
8
9
10
server {
	listen 80;
	server_name localhost;
	server_name_in_redirect on;
	location /hm {
		if (-d $request_filename){
			rewrite ^/(.*)([^/])$ http://$host/$1$2/permanent;
		}
	}
}

3.5 合并目录

  搜索引擎优化（SEO）是一种利用搜索引擎的搜索规则来提供目的网站的有关搜索引擎内排名的方式。我们在创建自己的站点时，可以通过很多中方式来有效的提供搜索引擎优化的程度。其中有一项就包含 URL 的目录层级一般不要超过三层，否则的话不利于搜索引擎的搜索也给客户端的输入带来了负担，但是将所有的文件放在一个目录下又会导致文件资源管理混乱并且访问文件的速度也会随着文件增多而慢下来，这两个问题是相互矛盾的，那么使用 rewrite 如何解决上述问题?
  举例：网站中有一个资源文件的访问路径是/server/11/22/33/44/20.html，也就是说20.html存在于第 5 级目录下，如果想要访问该资源文件，客户端的 URL 地址就要写成http://www.web.name/server/11/22/33/44/20.html。

1
2
3
4
5
6
7
server {
	listen 80;
	server_name www.web.name;
	location /server{
		root html;
	}
}

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

1
2
3
4
5
6
7
server {
	listen 80;
	server_name www.web.name;
	location /server{
		rewrite ^/server-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+)\.html$ /server/$1/$2/$3/$4/$5.html last;
	}
}

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

3.6 防盗链

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

1
2
3
4
5
6
7
8
9
10
server{
	listen 80;
	server_name www.web.com;
	locatin ~* ^.+\.(gif|jpg|png|swf|flv|rar|zip)${
		valid_referers none blocked server_names *.web.com;
		if ($invalid_referer){
			rewrite ^/ http://www.web.com/images/forbidden.png;
		}
	}
}

  根据目录实现防盗链配置：

1
2
3
4
5
6
7
8
9
10
11
server{
	listen 80;
	server_name www.web.com;
	location /file/{
		root /server/file/;
		valid_referers none blocked server_names *.web.com;
		if ($invalid_referer){
			rewrite ^/ http://www.web.com/images/forbidden.png;
		}
	}
}

参考文献

  【1】https://www.bilibili.com/video/BV1ov41187bq?p=66