nginx Rewrite

• Nginx使用的是ngx_http_rewrite_module模块来解析和处理Rewrite功能的相关配置。
• Rewrite常用全局变量：

相关指令

set指令

1. 设置一个新的变量。
   • variable:变量的名称，该变量名称要用"$“作为变量的第一个字符，且不要与Nginx服务器预设的全局变量同名。
   • value:变量的值，可以是字符串、其他变量或者变量的组合等。

if指令

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

# 1) $param 为空字符串或"0"，if都判断为false
if ($param){}

# 2) "="和"!="比较变量和字符串是否相等，满足条件为true，注意=前后空格
if ($request_method = POST){}

# 3) 正则表达式对变量进行匹配，匹配成功返回true，否则返回false。
#   - "~"代表匹配正则表达式过程中区分大小写
#   - "~\*"代表匹配正则表达式过程中不区分大小写
#   - "!~"和"!~\*"刚好和上面取相反值，如果匹配上返回false,匹配不上返回true
# 正则表达式字符串一般不需要加引号，但是如果字符串中包含"}"或者是";"等字符时，就需要把引号加上。
if ($http_user_agent ~ MSIE){} # $http_user_agent的值中是否包含MSIE字符串，如果包含返回true

# 4)  判断请求的文件是否存在使用"-f"和"!-f"
if (-f $request_filename){} # 判断请求的文件是否存在
if (!-f $request_filename){} # 判断请求的文件是否不存在

# 5) 判断请求的目录是否存在使用"-d"和"!-d"
if (-d $request_dir){}

# 6) 判断请求的目录或者文件是否存在使用"-e"和"!-e"
# 7) 判断请求的文件是否可执行使用"-x"和"!-x"

break指令

1. 用于中断当前相同作用域中的其他Nginx配置。
2. 与该指令处于同一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指令配置无效。
3. 并且break还有另外一个功能就是终止当前的匹配并把当前的URI在本location进行重定向访问处理。

location /testbreak{
    default_type text/plain;
    set $username TOM;
    if ($args){
        Set $username JERRY;
        break;
        set $username ROSE;
    }
    add_header username $username;
    return 200 $username;
}

return指令

1. 用于完成对请求的处理，直接向客户端返回。在return后的所有Nginx配置都是无效的。
   • code:为返回给客户端的HTTP状态代理。可以返回的状态代码为0~999的任意HTTP状态代理。
   • text:为返回给客户端的响应体内容，支持变量的使用。
   • URL:为返回给客户端的URL地址。

location /testreturn {
    return 200 success;
}

location /testreturn {
    return https://www.baidu.com; # 302重定向到百度
}

location /testreturn {
    return 302 https://www.baidu.com;
}

location /testreturn {
    return 302 www.baidu.com; # 不允许这么写
}

rewrite指令

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

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

location rewrite {
    rewrite ^/rewrite/url\w*$ https://www.baidu.com;
    rewrite ^/rewrite/(test)\w*$ /$1;
    rewrite ^/rewrite/(demo)\w*$ /$1;
}
location /test{
    default_type text/plain;
    return 200 test_success;
}
location /demo{
    default_type text/plain;
    return 200 demo_success;
}

4. flag:用来设置rewrite对URI的处理行为：
   last、break、redirect、permanent

   1. last:终止继续在本location块中处理接收到的URI，并将此处重写的URI作为一个新的URI，使用各location块进行处理。该标志将重写后的URI重写在server块中执行，为重写后的URI提供了转入到其他location块的机会。

   location rewrite {
     rewrite ^/rewrite/(test)\w*$ /$1 last;
     rewrite ^/rewrite/(demo)\w*$ /$1 last;
   }
   
   # http://localhost/rewrite/testabc 能命中这
   location /test{
     default_type text/plain;
     return 200 test_success;
   }
   location /demo{
     default_type text/plain;
     return 200 demo_success;
   }
   

   2. break：将此处重写的URI作为一个新的URI,在本块中继续进行处理。该标志将重写后的地址在当前的location块中执行，不会将新的URI转向其他的location块。

   # http://localhost/rewrite/demoabc 报错
   location rewrite {
     #/test   /usr/local/nginx/html/test/index.html
     rewrite ^/rewrite/(test)\w*$ /$1 break;
     rewrite ^/rewrite/(demo)\w*$ /$1 break;
   }
   location /test{
     default_type text/plain;
     return 200 test_success;
   }
   location /demo{
     default_type text/plain;
     return 200 demo_success;
   }
   

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

   # http://localhost/rewrite/testabc`请求会被临时重定向，浏览器地址也会发生改变
   location rewrite {
     rewrite ^/rewrite/(test)\w*$ /$1 redirect;
     rewrite ^/rewrite/(demo)\w*$ /$1 redirect;
   }
   location /test{
     default_type text/plain;
     return 200 test_success;
   }
   location /demo{
     default_type text/plain;
     return 200 demo_success;
   }
   

   4. permanent：将重写后的URI返回给客户端，状态码为301，指明是永久重定向URI,主要用在replacement变量不是以"http://“或者"https://“开头的情况。

   # http://localhost/rewrite/testabc`请求会被永久重定向，浏览器地址也会发生改变
   location rewrite {
     rewrite ^/rewrite/(test)\w*$ /$1 permanent;
     rewrite ^/rewrite/(demo)\w*$ /$1 permanent;
   }
   location /test{
     default_type text/plain;
     return 200 test_success;
   }
   location /demo{
     default_type text/plain;
     return 200 demo_success;
   }
   

rewrite_log指令

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

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

rewrite_log on;
error_log  logs/error.log notice;

域名跳转

1. 将 www.it.cn、www.it.vip 跳转到 www.ix.com。

server {
    listen 80;
    server_name www.it.cn www.it.vip;
    # (.*)捕获请求的URI和相关参数
    rewrite ^(.*) http://www.ix.com$1；
}

独立域名

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

http://search.xxss.com:81  访问商品搜索模块
http://item.xxss.com:82	  访问商品详情模块
http://cart.xxss.com:83	  访问商品购物车模块

server{
    listen 81;
    server_name search.xxss.com;
    rewrite ^(.*) http://www.xxss.cn/search$1;
}
server{
    listen 82;
    server_name item.xxss.com;
    rewrite ^(.*) http://www.xxss.cn/item$1;
}
server{
    listen 83;
    server_name cart.xxss.com;
    rewrite ^(.*) http://www.xxss.cn/cart$1;
}

防盗链

1. 当出现防盗链的情况，我们可以使用rewrite将请求转发到自定义的一张图片和页面，给用户比较好的提示信息。

location /images {
    root html;
    valid_referers none blocked www.baidu.com;

    if ($invalid_referer){
        #return 403;
        rewrite ^/ /images/forbidden.png break;
    }
}