Nginx中 Rewrite规则的学习笔记

路由重写是Web服务器中的一个很重要的基本功能。通过路由重写，可以结构化URL，更具语义化（对SEO有益）。另外，分享出去的URL可能会因程序路由变动而导致URL失效，而路由的重写可以很好的解决这类问题。

适当的使用Rewrite功能，可以更我们带来很多的好处。Nginx中Rewrite的功能是基于perl语言兼容的正则表达式，所以在编译安装nginx之前，需要安装PREC库。Nginx中Rewrite功能实现是基于ngx_http_rewrite_module，所以确保安装了此模块。

Rewrite 规则

Rewrite的核心在于正在表达式，所以想熟练运用Nginx的Rewrite需要对正则表达式比较熟悉。推荐一款比较好的正则表达式测试工具，Regex Match Tracer。

除了正则之外，Nginx中还内置了一些Rewirte指令和相关变量，提供了一套比较完整的功能。

if指令

if指令支持条件判断，基本语法如下:

if(condition) {
    // do something
}
以上代码中，花括号代表作用域，表示为条件为真的时候应用的配置。condition中支持变量名，如果变量为空或以"0"开头的任意字符串，都表示为false，否则为true

if($isTrue){
    //do something
}
另外，也可以用"="和"!="来对比较变量和字符串，如下：

if($request_method = POST) {
    return 405;
}
注意：与字符串对比时，不需要给字符串加上引号。

除了以上几种方式，也可以通过正则表达式来匹配处理，通常有如下几种表达符号：~表示区分大小写匹配；~*表示不区分大小写；!~表示区分大小写并把匹配结果取反；同理，!~*表示不区分大小写并把最终匹配结果取反。在正则表达式中，我们也可以通过小括号来捕获对应变量的值，并可以通过$1······$9得到对应变量值，

if($http_user_agent ~ MSIE) {
    ## 检测浏览器用户代理是否包含MSIE这个字符串
}
 
 
if($http_cookie ~* "id=([^;]+)(?:|$)"){
    ## Nginx 配置，可以使用$1, $2来获取对应匹配的值，如
    ## set $id $1;         将捕获的结果保存在$id中，以便后续使用
}
注意：正则表达式一般是不需要加引号，但如果正则表达式中包含了`}`、`;`时，就必须给整个表达式加上引号。

判断请求文件或目录是否存在，在if语句中使用也是非常多的。通常代码如下：

if(-f $request_filename){
    ## 判断请求文件是否存在
}
 
if(!-f $request_filename){
    ## 判断请求的文件是否不存在
}
如以上代码所示，-f是用来表示请求的文件是否存在，当然还有判断目录等，具体如下表：

参数名 功能 示例
-f 判断请求的文件是否存在，如果存在，则为true;在其前加上"!"即表示取反 
-d 请求的目录是否存在；在其前加上"!"即表示取反 

if(-d $request_filename){
    ## 判断请求的目录是否存在
}
-e 判断请求的目录或文件是否存在，如果存在，则为true。 
-x 判断当前请求文件是否为可执行文件。 
break 指令

break指令用来终止当前相同作用域下的其后的Nginx配置。Nginx服务器在根据配置处理请求的过程中遇到这个指令时，会回到上一层作用域，继续向下读取配置；也就是说在同一作用域下的Nginx配置，位于该指令之后，都将失效。

基本语法如下：

break;
示例如下：

location / {
    if ($slow){                  ## 产生作用域
        set $id $1;              ## 位于break之前，有效
        break;
        limit_rate 10k;          ## 位于break之后，配置无效
    }
 
    ## Nginx其他配置（依旧有效）
}
return 指令

return指令用于完成对请求的处理，可以直接向客户端返回响应状态代码。所有处理该指令后的Nginx都将无效。该指令通常在server块和location块配合if指令使用，具体语法如下：

return [text];
return code URL;
return URL;
code，返回给客户端的状态码。可以为0~999之前的任意HTTP状态码（非标准的444可以强制关闭服务器与客户端之间的连接）。
text, 为返回给客户端的响应体内容，支持使用变量。
URL，返回给客户端一个URL地址
通常会配置return指令来处理域名重定向，代码如下：

if ($true){
    return 301 http://www.111com.net
}
rewrite 指令

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

该指令可以在server块中或使用location中配置，其语法结构如下：

rewrite regex replacement [flag];
regex，用于匹配URI的正则表达式。使用括号"()"标记要截取的内容。
以下是错误示例：

rewrite myblog.net http://www.111com.net permanent;
提示：rewrite中接收到的URI是不包含host地址。因此，regex不可能匹配到URL的Host地址。

对于以上的例子，rewrite重写http://111com.net/source是办不到的，因为rewrite指令接收到的URI是"/source"，是不包含"myblog.net"

另外，请求中的参数，也是不包含在rewrite所接收的URI中。如：

http://111com.net/source?arg1=value1&arg2=value2
rewrite中接收到的URI是"/source",不包含"arg1=value1&arg2=value2"

replacement，匹配成功后用于替换URI中被截取内容的字符串。默认情况下，如果该字符串是由"http://"或"https://"开头，则不会继续向下对URI进行其他处理，而是直接将重写后的URI返回给客户端。
如果你希望在匹配主机信息，可以在if条件中判断，

if ($host = '111com.net') {
    rewrite ^.*$ http://www.111com.net$request_uri? permanent;
}
flag，用来设置rewrite对URI的处理行为，可以为以下标志中的任意一个。
last,终止在本location块中处理接收到的URI，并将处理后的URI作为一个新的URI，使用各location块进行处理。该标志将重写后的URI重新在server块中执行，为重写后的URI提供了转入到其他location块的机会。通过如下例子来加深理解：

location / {
    rewrite ^(/111cn/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 last;
    rewrite ^(/111cn/.*)/audio/(.*)\..*$ $1/mp3/$2.ra last;
}
对于以上的rewrite代码，如果一个请求过来，被以上第2行规则匹配成功，则Nginx会以匹配后的URI再重新到所有的location中再执行一遍。

break,将此处理重写的URI作为新的URI，在本块中继续进行处理。该标识将重写后的地址在当前的location块中执行，不会将新的URI转向其他location块中。请看如下示例：

location /111cn/ {
    rewrite ^(/111cn/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 break;
    rewrite ^(/111cn/.*)/audio/(.*)\..*$ $1/mp3/$2.ra break;
}
如果URI在第2行匹配成功并处理，Nginx服务器将新的URI继续在location中执行第3行规则中匹配处理，新的URI始终在同一个location块中。

redirect, 将重写后的URI返回给客户端，状态码为302，指明是临时重定向URI，主要用在replacement变量不是以"http://"或"https://"情况。

permanent,将重写后的URI返回给客户端，状态码为301，表示永久跳转。

当使用flag指令时，需要注意各个标识之间的配合。再翻看以上的例子，如果我们把break改成了last会怎么样？因为重写后的URI也是包含111cn，也就是说在location规则匹配可能会出现死循环。Nginx服务器遇到这种情况，会尝试10循环后，会返回500错误代码。

rewrite_log 指令

这个指令配置是否要开启URK重写日志的输出功能，具体语法如下：

rewrite_log on | off
默认值为off。如果配置为on,URL重写的相关日志将以notice级别输出到error_log指令的配置日志文件中。

set 指令

set指令主要是用来设置变量，其语法结构为：

set variable value
variable，变量名，必须以"$"符号作为变量的第一个字符，且不能与Nginx预设的变量同名
value，为变量赋值，可以为字符串，其他变量或变量组合
uninitialized_variable_warn 指令

该指令用于配置未初始化的变量时，是否记录警告日志（默认为on），其语法结构如下:

uninitialized_variable_warn on | off
Rewrite 常用全局变量

在Rewrite 功能配置的过程中，可能会使用到Nginx全局变量，方便查阅，特地记录一下（以下示例中均以"http://www.111com.net:8081/server/source?arg1=value1&arg2=value2"为例）：

变量名 说明 示例
$args 变量中存放了请求URL中的请求参数。 如: arg1=value1&arg2=value2
$content_length http头部中存放了请求头中的Content-length字段 
$content_type http头部中的Content-type字段 
$document_root 存放了针对当前请求的根路径 
$document_uri 存放了当前请求的URI，并且不包含请求参数。 如：/server/source
$host 请求字段的主机字段 如：www.111com.net
$http_user_agent 存放请求的客户端的用户代理信息 
$http_cookie 客户端中存在的cookie信息 
$limit_rate 存放Nginx服务器对网络连接速率的限制，也就是Nginx配置limit_rate指令的配置值 
$remote_addr 客户端的ip地址 
$remote_port 客户端与服务器建立连接的端口 如：8081
$remote_user 存放客户端用户名 
$request_body_file 存放了发给后端服务器的本地文件资源的名称 
$request_method 存放客户端的请求方式 如：GET,POST,OPTION等
$request_filename 当前请求的资源文件的路径名 
$request_uri 当前请求的URI，并且附带请求参数 如：/server/source?arg1=value1&arg2=value2
$query_string 与$args含义相同 
$scheme 客户端与服务器请求所用的协议，比如，http,https,ftp等 如：http
$server_protocol 客户端请求的协议版本。如："HTTP/1.0","HTTP/1.1" 
$server_addr 服务器的Ip地址 
$server_name 客户端请求到达服务器的名称 
$server_port 客户端请求到达服务器的端口号 
$uri 与$document_uri含义相同 
Rewrite 的使用

ngx_http_rewrite_module是Nginx服务器实现Rewrite的模块，通过Rewrite可以实现pathInfo，及常用的nginx的反向代理功能。下面我们通过一个个示例来说明以上指令的使用。

域名跳转

Rewrite可以实现一级域名或多级域名的跳转。示例如下：

## 示例1
...
server {
    listen 80;
    server_name 111com.net;
    rewrite ^/ http://www.111com.net/;             ## 域名跳转
    ...
}
...
 
## 示例2
...
server {
    listen 80;
    server_name 111com.net www.111com.net;
    if ($host ~ myweb\.net){
        rewrite ^(.*) http://www.111cn.org$1 permanent;          ## 多域名跳转
    }
}
 
 
## 示例3
...
server {
    listen 80;
    server_name demo1.111com.net demo2.111com.net;
    if ($http_host ~* ^(.*)\.111cn\.net$){
        rewrite ^(.*) http://demo.111com.net$1;                     ## 三级域名的跳转
    }
}
域名镜象

镜像网站是指将一个完全相同的网站分别放置到几个服务器上，并分别使用独立的URL，其中一个服务器上的网站叫主站，其他的都为镜像网站。镜像站就可以看作是主站的一个副本。可以在主站存在问题时，作备份服务器使用。另外，也可以提高不同地区网站的响应速度。镜像网站可以响应网站流量负载，解决网络带宽封锁等问题。

Nginx中的Rewrite功能可以轻松实现域名镜像的跳转。实现原理很简单，也就是把不同镜像URL重写到指定的URL就可以了。以下是示例配置：

server {
    ...
    listen 80;
    server_name google.111com.net;
    rewrite ^(.*) http://www.google.com$1 last;
}
server {
    ...
    listen 81;
    server_name bings.111com.net;
    rewrite ^(.*) http://bings.cn$1 last;
}
当然，我们也可以为某一个目录下镜像，实现如下：

server {
    listen 80;
    server_name cdn.111com.net;
    location ^~ /source {
        ...
        rewrite ^/source(.*) http://cdn.google.com/websrc2$1 last;
    }
}
 
server {
    listen 81;
    server_name cdn1.111com.net;
    rewrite ^(.*) http://cdn.baidu.com/
 
    location ^~ /source2 {
        ...
        rewrite ^/source2(.*) http://cdn.baidu.com/websrc2$1 last;
    }
}
目录前自动添加"/"

如果网站设定了默认资源文件，那么客户端访问时可以不加具体的资源文件名。如，你访问：http://www.111com.net时，直接就可以访问到"/index.html"文件。

如果访问一个二级目录，如：http://www.111com.net/category/index.html；则如果直接输入http://www.111com.net/category可能无法访问，必须在后面加上斜线http://www.111com.net/category/。像这种情况，也不可能去要求用户这么输入，可以通过Rewrite功能为末尾没有斜杠"/"：

server {
    ...
    listen 81;
    server_name www.111com.net;
    location ^~ /bbs {
        ...
        if (-d $request_filename){
            rewrite ^/(.*)([^/])$ http://$host/$1$2/ permanent;
        }
    }
}
目录合并

搜索引擎优化是一种利用搜索引擎的索引规则来提高网站排名。其中目录也是增强SEO的一种手段。如一个网站的路径如下：

[root]/server/12/34/56/78/9.html
如果用户访问这个资源，则URL也必须写成http://www.111com.net/server/12/34/56/78/9.html；这非常利于SEO，并且对用户的输入也存在难度。对于以上URL，可以改写成http://www.111com.net/server/12-34-56-78-9.html，具体配置如下：

server {
    ...
    listen 80;
    server_name www.111com.net;
    location ^~ /server {
        ...
        rewrite ^/server-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+)-([0-9]+)\.html$ /server/$1/$2/$3/$4/$5.html last;
        break;
    }
 
}
防盗链

盗链是一种损害原始网站合法利益，给原服务器造成额外负担。首先了解一下防盗链的原理。

客户端向服务器请求资源时，为了减少网络带宽，提高响应速度，服务器一般不会一次把所有资源完整的传给客户端。如，请求一个网页，首先传回网页文本文件，当服务器解析网页时，再开始下载资源文件，如图片，样式表，可执行脚本。如果这些资源文件不是放在该服务器上，而在其他服务器上。这就构成了盗链。

要防止盗链，需要了解HTTP协议中的请求头部的Referer头域和采用URL的格式表示访问当前网页或者文件的源地址。通过头域的值，可以检测到访问目标资源的源地址。这样，如果检测到Referer头域中的值并不是自己站点内的URL，就采取阻止措施，实现防盗链的目的。但是，Referer头域的值是可以更改的，因此该方法不能够完全阻止所有盗链。

Nginx配置中有一个指令 valid_referers，用来获取 Referer 头域中的值，并且根据该值的情况给$invalid_referer变量赋值。如果 Referer 头域中没有符合 valid_referers 指令配置的值，则$invalid_referer 变量将会被赋值为1。valid_referers 指令的语法结构为:

valid_referers none | blocked | server_names | string ...;
none，检测Referer头域不存在的情况
blocked，检测Referer头域的值被防火墙或代理服务器删除或伪装的情况。这种情况下，该头域的值不以"http://"或者"https://"开头
server_names，设置一个或多个URL，检测Referer头域的值是否是这些URL中的某个。在Nginx 0.5.33以后支持使用通配符"*"
有了valid_referers指令和$invalid_referer变量，配合Rewrite功能就可以实现防盗链。有两种实现方案：1、根据资源文件类型；2、根据请求的目录

以下是根据资源文件类型：

server {
    ...
    listen 80;
    server_name www.111com.net;
    location ~* ^.+\.(gif|jpg|png|swf|flv|rar|zip)$ {
        ...
        valid_referers none blocked server_names *.111com.net;
        if ($invalid_referer){
            rewrite ^/ http://www.111com.net/images/default.jpg;
        }
    }
 
}
下面是根据目录实现防盗链的配置：

server {
    ...
    listen 80;
    server_name www.111com.net;
    location /file/ {
        ...
        root /server/file/;
        valid_referers none blocked server_names *.myblog.net;
 
        if($invalid_referer){
            rewrite ^/ http://www.111com.net/images/default.jpg;
        }
    }
 
}