Nginx rewrite

原文链接:https://blog.csdn.net/qq_41475058/article/details/89516051

一、rewrite介绍

rewrite和location的功能有点相像，都能实现跳转，主要区别在于rewrite常用于同一域名内更改获取资源的路径，而location是对一类路径做控制访问和反向代理，可以proxy_pass到其他服务器。

Nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。
rewrite只能放在server{},location{},if{}中，
并且只能对域名后边的除去传递的参数外的字符串起作用。
Rewrite主要的功能就是实现URL的重写，Nginx的Rewrite规则采用Pcre，perl兼容正则表达式的语法规则匹配，如果需要Nginx的Rewrite功能，在编译Nginx之前，需要编译安装PCRE库。
通过Rewrite规则，可以实现规范的URL、根据变量来做URL转向及选择配置。

二、ReWrite相关指令

指令	默认值	使用范围	作用
break	none	if,server,location	完成当前的规则集，不再处理rewrite指令，需要和last加以区分
if ( condition ) { … }	none	server,location	用于检测一个条件是否符合，符合则执行大括号内的语句。不支持嵌套，不支持多个条件&&或处理
return	none	server,if,location	用于结束规则的执行和返回状态码给客户端。状态码的值可以是：204,400,402,406,408,410,411,413,416以及500~504，另外非标准状态码444，表示以不发送任何的Header头来结束连接。
rewrite regex replacement flag		server,location,if	该指令根据表达式来重定向URI，或者修改字符串。指令根据配置文件中的顺序来执行。注意重写表达式只对相对路径有效。该指令根据表达式来重定向URI，或者修改字符串。指令根据配置文件中的顺序来执行。注意重写表达式只对相对路径有效。
uninitialized_variable_warn on/off	on	http,server,location,if	该指令用于开启和关闭未初始化变量的警告信息，默认值为开启。
set variable value	none		该指令用于定义一个变量，并且给变量进行赋值。变量的值可以是文本、一个变量或者变量和文本的联合，文本需要用引号引起来。

三、rewrite常用全局变量

四、Nginx rewrite语法

1、rewrite指令语法

指令语法： rewrite regex replacement [flag]
默认值： none
应用位置：server、location、if
rewrite是实现URL重写的关键指令，根据regex（正则表达式）部分的内容，重定向到replacement部分，结尾是flag标记。
下面是一个简单地URL rewrite跳转的例子：

rewrite ^/(.*) http://www.etiantian.org/$1 permanent;

• 1

在上述指令中，rewrite为固定关键字，表示开启一条rewrite匹配规则，regex部分是^/(.*)，这是一个正则表达式，表示匹配所有，匹配成功后跳转到http://www.etiantian.org/$1。这里的$1是取前面regex部分括号里的内容结尾的permanent；是永久301重定向标记，即跳转到后面的http://www.etiantian.org/$1地址上。

2、rewrite指令结尾的flag标记说明

flag标记符号	说 明
last	本条规则匹配完成后，继续向下匹配新的location URI规则
break	本条规则匹配完成即终止，不再匹配后面的任何规则
redirect	返回302临时重定向，浏览器地址栏会显示跳转后的URL地址
permanent	返回301永久重定向，浏览器地址栏会显示跳转后的URL地址

在以上的flag标记中，last和break用来实现URL重写，浏览器地址栏的URL地址不变，但在服务器访问的程序及路径发生了变化。redirect和permanent用来实现URL跳转，浏览器地址会显示跳转后的URL地址。
last和break标记的实现功能类似，但二者之间有细微的差别，使用alias指令时必须用last标记，使用proxy_pass指令时要使用break标记。last标记在本条rewrite规则执行完毕后，会对其所在的server{…}标签重新发起请求，而break标记则会在本条规则匹配完成后，终止匹配，不再匹配后面的规则。

五、例子

1、 break

参数项：break，用于停止执行rewrite模块的指令，但是其他模块不受影响。

配置位置：server，location，if
示例

server {
        listen       80;
        server_name  localhost;
        #===== break && rewrite test =====
        #这里如果注释掉break，所有请求进来都是返回http200，this is breaktest...
        break;
        return 200 "this is breaktest...";
        location = /breaktest {
            break;
            return 200 $request_uri;
            proxy_pass http://192.168.88.38/other;
        }
        location / {
            return 200 $request_uri;
        }

测试链接：http://192.168.88.38/breaktest ，请求到达server块后，被break终止执行rewrite指令集，return属于rewrite模块指令集，所以return 200 “this is breaktest…”不会执行；因为没有返回结果，所以继续执行location匹配，请求匹配到location = /breaktest{}之后，break终止return 200 $request_uri，而proxy_pass属于ngx_http_proxy_module，仍会继续执行，反向代理后的新url匹配到location /{}，因此最终返回结果为 http200，/other，如下图：

2、set
配置位置：server，location，if，用于为变量赋值
示例：

server {
        listen       80;
        server_name  localhost;
        #===== break && rewrite test =====
        #这里如果注释掉break，所有请求进来都是返回http200，this is breaktest...
        break;
        return 200 "this is breaktest...";
        location = /breaktest {
            break;
            return 200 $request_uri;
            proxy_pass http://192.168.88.38/other;
        }
        location / {
            #set赋值，可以直接赋字符串，或是变量，如下是变量和字符串的组合
            set $set_value_test “112233 $request_uri”;
            return 200 $set_value_test;
        }

测试链接http://192.168.88.38/breaktest，使用效果如下图：

3.if

配置位置：server，location，用于依据指定的条件，决定是否执行if块中的语句

判断条件：

3.1.变量值为空或为0，都为false；

示例：

set $if_value_test “0”;
      #注意这里if、()和{}要空格，否则会报错..略坑，不过这也是代码规范了
      if ($if_value_test) {
         #不会执行，因为$if_value_test值为0，false
         return 200;
}

3.2.变量与字符串比较，=为等于，!=为不等

3.3.变量与正则表达式匹配，~ 为区分大小写匹配，~* 为不区分大小写匹配，!~ , !~*前面两者的非操作

示例：

if ($request_uri ~ “^/breaktest$”) {
      #测试链接http://192.168.88.38/breaktest，最终返回http200
      return 200;
}

3.4.检查文件是否存在，-f存在即为true，!-f不存在即为true

3.5.检查目录是否存在，-d存在即为true，!-d不存在即为true

3.6.检查文件或目录是否存在，-e存在即为true，!-e不存在即为true

3.7.检查文件是否可执行，-x可执行即为true，!-x不可执行即为true

示例：

if (-e /usr/local/nginx/conf) {
      return 200;
}

其他示例：

if ($http_user_agent ~ MSIE) {

    rewrite ^(.*)$ /msie/$1 break;

} //如果UA包含"MSIE"，rewrite请求到/msid/目录下


if ($http_cookie ~* "id=([^;]+)(?:;|$)") {

    set $id $1;

 } //如果cookie匹配正则，设置变量$id等于正则引用部分
  

if ($request_method = POST) {

    return 405;

} //如果提交方法为POST，则返回状态405（Method not allowed）。return不能返回301,302


if ($slow) {

    limit_rate 10k;

} //限速，$slow可以通过 set 指令设置


if (!-f $request_filename){

    break;

    proxy_pass  http://127.0.0.1; 

} //如果请求的文件名不存在，则反向代理到localhost 。这里的break也是停止rewrite检查

 
if ($args ~ post=140){

    rewrite ^ http://mysite.com/ permanent;

} //如果query string中包含"post=140"，永久重定向到mysite.com

if指令中，可以使用全局变量，这些变量有：
$ args： #这个变量等于请求行中的参数，同$query_string
$ content_length： 请求头中的Content-length字段。
$content_type： 请求头中的Content-Type字段。
$document_root： 当前请求在root指令中指定的值。
$host： 请求主机头字段，否则为服务器名称。
$http_user_agent： 客户端agent信息
$http_cookie： 客户端cookie信息
$limit_rate： 这个变量可以限制连接速率。
$request_method： 客户端请求的动作，通常为GET或POST。
$remote_addr： 客户端的IP地址。
$remote_port： 客户端的端口。
$remote_user： 已经经过Auth Basic Module验证的用户名。
$request_filename： 当前请求的文件路径，由root或alias指令与URI请求生成。
$scheme： HTTP协议（如http，https）。
$server_protocol： 请求使用的协议，通常是HTTP/1.0或HTTP/1.1。
$server_addr： 服务器地址，在完成一次系统调用后可以确定这个值。
$server_name： 服务器名称。
$server_port： 请求到达服务器的端口号。
$request_uri： 包含请求参数的原始URI，不包含主机名，如：”/foo/bar.php?arg=baz”。
$ uri： 不带请求参数的当前URI，$uri不包含主机名，如”/foo/bar.html”。
$ document_uri： 与$uri相同。

4.return

配置位置：server，location，if

参数值：return code [text]返回状态码及文本、return url重定向、return code url重定向

5.rewrite

配置位置：server，location，if

参数值：rewrite regex replacement [flag]，用于以正则表达式匹配特定格式的url并重写url.

regex为正则表达式，replacement为重写的内容，flag为rewrite的标识位

replacement：重写的url带http，表示重定向

示例：

location / {
    #测试链接http://192.168.88.38/test/，被重定向到百度首页，后面的语句不会再执行
    rewrite /test/(.*) http://www.baidu.com;
    set $set_value_test "112233 $request_uri";
    return 200 $set_value_test;
}

replacement：重写的url不带http，单纯的重写url
示例：

location / {
           #测试链接http://192.168.88.38/test/，匹配到location /{}后url被重写为http://192.168.88.38/breaktest，继续搜索匹配
           #匹配到location = /breaktest{}，最终返回http200及this is breaktest
           rewrite /test/(.*) /breaktest;
        }
        location = /breaktest {
           return 200 "this is breaktest";
        }

6、flag
flag：用于设置重写url后的进一步操作，有break，last，redirect，permanent，rewrite不带flag时，多个rewrite指令顺序执行，当location中没有可执行的rewrite模块指令时，重新发起一次location匹配，下面说明各个flag的用途：

break：和上面讲的break用途及用法一样，终止执行rewrite模块指令集；
last：终止执行rewrite模块指令集，并开始搜寻重写url后匹配的location；
redirect：临时重定向
permanent：永久重定向
示例：

 location / {
           #测试链接http://192.168.88.38/test1，匹配到location / {}
           rewrite ^/test1 /test2;#被重写为/test2，继续往下执行rewrite
           rewrite ^/test2 /test3;#被重写为/test3，往下没有可执行的rewrite模块指令，发起一次location匹配，匹配到location /test3 {}，最终返回http200及/test3
        }
        location /test2 {
            return 200 "/test2";
        }
        location /test3 {
            return 200 "/test3";
        }

last和break的区别在于，last会发起新的location匹配，而break不会。
示例：

location / {
           rewrite ^/test1 /test2;
           rewrite ^/test2 /test3 last;
           rewrite ^/test3 /test4;
        }
        location /test2 {
            return 200 "/test2";
        }
        location /test3 {
            return 200 "/test3";
        }
        location /test4 {
            return 200 "/test4";
        }

测试链接：http://192.168.88.38/test1 匹配到 location / {}后，被重写为/test2，顺序执行再次被重写为/test3，因为flag为last，所以不会继续重写为/test4，而是发起一次location匹配，匹配到location /test3{}，所以最终返回结果为http200及/test3;

如果把location /{}中的last改为break，被重写为/test3后，不再重写为/test4，也不会发起location，最终没有可匹配的资源，返回http404。

7、正则匹配URL的参数传递

小括号()之间匹配的内容，可以在后面通过 $下标 来引用，如1表示引用第一个小括号匹配的内容，1表示引用第一个小括号匹配的内容，1表示引用第一个小括号匹配的内容，表示引用第二个小括号匹配的内容。

示例：

location / {
           rewrite ^/(test1)/(test2)/(test3) /$2/$3;
           return 200 $2-$3;
        }

最终返回结果：