Nginx的Rewrite模块的介绍及实现

一、 Nginx-Rewrite 概述

现在 Nginx 已经成为很多公司作为前端反向代理服务器的首选，在实际工作中往往会 遇到很多跳转（重写 URL）的需求。比如：更换域名后需要保持旧的域名能跳转到新的域名上、某网页发生改变需要跳转到新的页面、网站防盗链等等需求。 和Apache相比Nginx 跳转效率会更高。

1.1 Rewrite 跳转场景

Rewrite 跳转场景主要包括以下几种：

• 可以调整用户浏览的 URL，看起来更规范，合乎开发及产品人员的需求。
• 为了让搜索引擎搜录网站内容及用户体验更好，企业会将动态 URL 地址伪装成静态地
  址提供服务。
• 网址换新域名后，让旧的访问跳转到新的域名上。
• 根据特殊变量、目录、客户端的信息进行 URL 调整等。

1.2 Rewrite 跳转实现

1. Nginx 是通过 ngx_http_rewrite_module 模块支持 url 重写、支持 if 条件判断，但不支持else。该模块需要 PCRE 支持，再编译时候就安装。
2. 从一个 location 跳转到另一个 location，不过这样 的循环最多可以执行 10 次，超过后 Nginx 将返回 500 错误。
3. 重写模块包含 set 指令，来创建新的变量并设其值。

rewrite功能就是使用 Nginx 提供的全局变量或自己设置的变量，结合正则表达式和标志位实现 url 重写以及重定向。

1.3 Rewrite 实际应用场景

• Nginx 跳转需求有三种方式可实现

  • 直接用 rewrite 进行匹 配跳转
  • 使用 if 匹配全局变量后跳转。
  • 使用 location 匹配再跳转。

• rewrite放在server{}，if{}，location{}段中

location只对域名后边的出去传递参数外的字符串起作用

• 对域名或参数字符串
  • 使用if全局变量匹配
  • 使用proxy_pass反向代理

二、Nginx的正则表达式

字符	描述
^	匹配输入字符串的起始位置
$	匹配输入字符串的结束位置
*	匹配前面的字符零次或多次.如“sx*”能匹配“s”及“sx”、“sxx”
+	匹配前面的字符一次或多次。如“sx+”能匹配“sx”及“sxx”，但不能匹配“s”
?	匹配前面的字符零次或一次，例如“do(es)?”能匹配“do”或者“does”，”?”等效于”{0,1}”
.	匹配除“\n”之外的任何单个字符，若要匹配包括“\n”在内的任意字符，请使用诸如“[.\n]” 之类的模式
\	将后面接着的字符标记为一个特殊字符或一个原义字符或一个向后引用。如“\n”匹配一 个换行符，而“$”则匹配“$”
\d	匹配纯数字
{n}	重复 n 次
{n,}	重复 n 次或更多次
[c]	匹配单个字符 c
[a-z]	匹配 a-z小写字母的任意一个
[a-zA-Z]	匹配 a-z小写字母或 A-Z 大写字母的任意一个

三、 Rewrite 语法

rewrite <regex> <replacement> [flag];
  regex 表示正则匹配规则
  replacement 表示跳转后的内容
  flag 表示rewrite支持的flag标记。

3.1 flag 标记说明：

• last：相当于 Apache 的[L]标记，表示完成 rewrite
• break：本条规则匹配完成即终止，不再匹配后面的任何规则
• redirect：返回302临时重定向，浏览器地址会显示跳转后的 URL 地址，爬虫不会更新 url（因为是临时）
• permanent：返回301永久重定向，浏览器地址栏会显示跳转后的 URL 地址，爬虫更新url。
• 如果后面不跟 flag 标记，那么默认是 302 临时重定向。

在实际工作场景中，还有另一 种 return 指定。因为301和302不能简单的只返回状态码，还必须有重定向的 URL，这就是return指令无法返回 301 和 302 的原因。

• last 和 break 区别

last 一般写在server和if中，而break一般使用在 location 中。 last 不终止重写后的 url 匹配，即新的url会再从server走一遍匹配流程，而break终止重写后的匹配。

3.2 Location 分类

location = patt {} [精准匹配]
location patt {} [一般匹配]
location ~ patt {} [正则匹配]

字符	描述
~	表示执行一个正则匹配，区分大小写
~ *	表示执行一个正则匹配，区分大小写
!~	表示执行一个正则匹配，区分大小写不匹配
!~*	表示执行一个正则匹配，不区分大小写不匹配
^~	表示执行一个正则匹配，不区分大小写不匹配
=	进行普通字符精确匹配，也就是完全匹配
@	它定义一个命名的 location，使用在内部定向时，例如 error_page,try_files

3.3 Location 优先级

相同类型的表达式，字符串长的会优先匹配

• 等号类型（=）的优先级最高。一旦匹配成功，则不再查找其他匹配项。
• ^~类型表达式。一旦匹配成功，则不再查找其他匹配项。
• 正则表达式类型（~ 和~*）的优先级次之。
• 常规字符串匹配类型。按前缀匹配。
• 通用匹配（/），如果没有其它匹配，任何请求都会匹配到。

rewrite 也会写在 location

1. 执行 server 块里面的 rewrite 指令。
2. 执行 location 匹配。
3. 执行选定的 location 中的 rewrite 指令

如果是匹配某个具体文件

(location = 完整路径) > (location ^~ 完整路径) > (location ~* 完整路径) > (location ~ 完整路径) > (location 完整路径) > (location /)

如果是用目录做匹配访问某个文件

(location = 目录) > (location ^~ 目录/) > (location ~ 目录) > (location ~* 目录) > (location 目录) > (location /)

四、 Rewrite应用

Nginx的安装过程不再赘述，具体请看之前的博客

4.1 基于域名的跳转

公司旧域名www.test-1.com,因业务需求有变更，需要使用新域名www.test-2.com代替

[root@nginx ~]# vi /etc/nginx 
    server {
        listen       80;
        server_name  www.test-1.com;

        charset utf-8;

        access_log  logs/host.access.log  main;

        location / {
        
                if ($host = 'www.test-1.com'){
            rewrite ^/(.*)$ http://www.test-2.com/$1 permanent;
            }		# 实现跳转

            root   /web/web1/;
            index  index.html index.htm;
        }
    }
    
    server {
        listen       80;
        server_name  www.test-2.com;

        charset utf-8;

        #access_log  logs/host.access.log  main;

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

访问www.test-1.com结果如下

4.2 基于客户端IP访问跳转

[root@nginx ~]# vi /etc/nginx 
		set $rewrite true;
        if ($remote_addr = "10.0.0.71"){		# 10.0.0.71为本机IP
            set $rewrite false;
        }
        if ($rewrite = true){
            rewrite (.+) /error.html;
        }
        location = /error.html {
            root /web/error/;
        }

本机地址访问

4.3 基于旧，新域名跳转并加目录

[root@nginx ~]# vi /etc/nginx
	location /abc {
  		rewrite (.+) http://www.test-1.com/bcd$1 permanent;
  	}
  		

域名www.test-1.com/abc.html跳转到www.test-1.com/bcd/abc.html

4.4 基于参数匹配的跳转

[root@nginx ~]# vi /etc/nginx 
        if ($request_uri ~ ^/100-(100|200)-(\d+).html$) {
                rewrite (.*) http://www.test-2.com permanent;
        }