nginx rewrite 模块

nginx rewrite模块

nginx官方用户手册：http://nginx.org/en/docs/http/ngx_http_rewrite_module.html

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

执行server块中的rewrite；
执行location；
执行location中的rewrite；

如果其中某步url被重写，则重新循环执行2-3步，直到找到按该url可以访问的文件，循环次数不超过10。

rewrite 中用到的指令

if (条件) {} #设定条件,再进行重写
set #设置变量
return #返回状态码
break #跳出rewrite
rewrite #重写
rewrite_log
uninitialized_variable_warn
Internal Implementation

break

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

配置位置: if, server, location

示例:

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

测试链接：http://10.0.0.2/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，如下图：

set

配置位置: if, server, location

用于为变量赋值

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

if

配置位置: server, location

用于依据指定的条件,决定是否执行 if 块中的语句

语法:

#判断条件为 ture 时,执行{}块中语句,为 false 时,不执行.
if (判断条件) {
    ... ...;
}

判断条件:

变量值

变量值为空或为0，都为false

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

变量与字符串比较

= 为等于,!= 为不等于

set $if_value_test “hello”;
    if ($if_value_test = "hello") {
        #变量和字符相等,逻辑为true,执行
        return 200;
    }

变量与正则表达式匹配

参数	说明
~	与指定正则表达式匹配时返回 True,判断匹配与否时区分字符大小写
~*	与指定正则表达式匹配时返回 True,判断匹配与否时不区分字符大小写
!~	与指定正则表达式不匹配时返回 True,判断匹配与否时区分字符大小写
!~*	与指定正则表达式不匹配时返回 True,判断匹配与否时不区分字符大小写

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

参数	说明
-f , !-f	判断指定的路径是否为存在且为文件
-d , !-d	判断指定的路径是否为存在且为目录
-e , !-e	判断指定的路径是否存在,文件或目录均可
-x , !-x	判断指定路径的文件是否存在且可执行

return

配置位置: if, server, location

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

if ($request_uri ~ "^/breaktest$") {
#测试链接http://10.0.0.2/breaktest，最终返回http200
return 200 http://www.baidu.com/;
}

rewrite

配置位置:if, server, location

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

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

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

location / {
    #测试链接http://10.0.0.2/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://10.0.0.2/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";
        }

flag:

用于设置重写url后的进一步操作，有break，last，redirect，permanent，不带flag

标记	特点	说明
无flag	不改变浏览器地址,**返回200或404等,对用户透明	多个rewrite指令顺序执行，当location中没有可执行的rewrite模块指令时，重新发起一次location匹配，下面说明各个flag的用途
last ( default )	不改变浏览器地址,返回200或404等,对用户透明	终止执行rewrite模块指令集，并开始搜寻重写url后匹配的location
break	不改变浏览器地址,返回200或404等,对用户透明	用于停止执行rewrite模块的指令，但是其他模块不受影响。
redirect	改变浏览器地址	返回302临时重定向
permanent	改变浏览器地址	返回301永久重定向

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

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

正则匹配 URL 的参数传递

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

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

nginx 内置全局变量

$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，不包含主机名，如：”/api/data?arg=abc”。
$uri ： 不带请求参数的当前URI，$uri不包含主机名，如”/html/abc.html”。
$document_uri ： 与$uri相同。

例子

请求文件或目录不存在时重定向

if (!-e $request_filename) {
    rewrite ^(.*) http://www.baidu.com/ break;
}

用户使用IE浏览器时重定向

if ($http_user_agent ~ MSIE) {
    rewrite ^(.*) /nginx-ie/%1 break;
}