Nginx Rewrite（重写跳转）

一.Nginx Rewrite概述

1.Rewrite跳转场景

rewrite功能： 使用nginx提供的全局变量或自己设置的变量，结合正则表达式和标记位实现URL重写以及重定向。
比如： 更换域名后需要保持旧的域名能跳转到新的域名上、某网页发生改变需要跳转到新的页面、网站防盗链等等需求。

rewrite只能放在server{},location{},if{}中，并且默认只能对域名后边的除去传递的参数外的字符串起作用， 例如http://www.kgc.com/abc/bbs/index.php?a=1&b=2 只对/abc/bbs/index.php重写。

2.Rewrite跳转场景

（1）URL看起来更规范、合理

• URL: 就是一个具体路径/位置
• URI: 指的是一个拥有相同类型/特性的对象集合
• URN:用名称定位

（2）企业会将动态URL地址伪装成静态地址提供服务

（3）网址换新域名后，让旧的访问跳转到新的域名上

（4）服务端某些业务调整

3.Rewrite跳转实现

4.Rewrite实际场景

4.1Nginx跳转需求的实现方式

(1)使用rewrite进行匹配跳转(例如防盗链)

(2)使用if匹配全局变量后跳转（此匹配全局变量是nginx服务本身全局变量）

(3)使用location匹配再跳转（匹配的访问URL路径，location可以匹配本地重写以及跨服务器跳转）

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

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

4.3对域名或参数字符串

(1)使用if全局变量匹配
(2)使用proxy_pass反向代理

5.nginx正则表达式

5.1 常用的正则表达式元字符

字符	说明^
^	匹配输入字符串的起始位置
$	匹配输入字符串的结束位置
*	匹配前面的字符零次或多次
+	匹配前面的字符一次或多次
?	匹配前面的字符零次或一次
.	匹配除“\n"之外的任何单个字符
\	将后面接着的字符标记为一个特殊字符或一个原义字符或一个向后引用
\d	匹配纯数字
{n}	重复n次
{n,}	重复n次或更多次
[c]	匹配单个字符c
[z-a]	匹配a-z小写字母的任意一个
[z-aA-Z]	匹配a-z小写字母或A-Z大写字母的任意一个
（）	表达式的开始和结束位置
|	或运算符

6.Rewrite 命令

6.1 Rewrite 命令语法

rewrite [fiag];

regex:正则

replacement：跳转后的内容

fiag：rewrite支持的flag标记（进行判断）

6.2flag标记说明

标记	说明	特点
last	相当于apache的[L]标记，表示完成rewrite	在本条规则完成后，继续向下匹配新的location URL规则，一般或者用在server和if当中
break	本条规则匹配完成即终止，不在匹配后面的任何规则	break在location下面用的多，与last类似，但是不会重新发起一次处理过程，而是直接放回处理结果
redirect	返回302临时重定向，浏览器地址会显示跳转后的URL地址，爬虫不会更新url	该标记表示当前规则匹配成功后会立即进行重定向操作
permanent	返回301永久重定向，浏览器地址栏会显示跳转后的URL地址，爬虫更新url	该标记和redirect类似，他是永久重定向

set：标记表示当前规则匹配成功设置的一个变量，并把变量传入下一条规则

6.3last和break比较

	last	break
使用场景	一般写在server和if中	一般使用在location
URL匹配	不终止重写后的url匹配	终止重写后的url匹配

总：从功能看，rewrite和location似乎有点像，都能实现跳转，主要区别在于rewrite是在同一域名内更改获取资源的路径，而location是对一类路径做控制访问或反向代理，还可以proxy_pass到其他机器。
rewrite 对访问的域名或者域名内的URL路径地址重写
location对访问的路径做访问控制或者代理转发

二.location

1.location分类

1.1精确匹配

location = patt {}

1.2一般匹配

location patt {}

1.3正则匹配

location ~ patt {}

2.正则匹配的常用的表达式

标记	说明
~	执行一个正则匹配，区分大小写
~*	执行一个正则匹配，不区分大小写
!~	执行一个正则匹配，区分大小写不匹配
!~*	执行一个正则匹配，不区分大小写不匹配
^~	普通字符匹配，使用前缀匹配，如果匹配成功，则不再匹配其他的location
=	普通字符精确匹配，也就是完全匹配
@	定义一个命令的location，使用在内部定向时

3.location优先级

（1）首先精确匹配:=

（2）其次前缀匹配:^~

（3）其次是按文件中顺序的正则匹配:_或*

（4）然后匹配不带任何修饰的前缀匹配

（5）最后是交给/通用匹配

总结：
（1）优先级总结：（location=完整路径）>（location ^~ 路径）>（location~,~*正则顺序）>（location不分起始路径）>（location /）
（2）location匹配：
首先看优先级：精确（=）>前缀（^~）>正则（~,~*）>一般>通用（/）
优先级相同：正则看上下顺序，上面的优先，一般匹配看长度，最长匹配的优先
精确，前缀，正则，一般都没有匹配到，最后再看通用匹配，一般匹配

4.location示例

（1）location = / {}
=为精确匹配 / ，主机名后面不能带任何字符串，比如访问 / 和 /data，则 / 匹配，/data 不匹配
再比如 location = /abc，则只匹配/abc ，/abc/或 /abcd不匹配。若 location /abc，则即匹配/abc 、/abcd/ 同时也匹配 /abc/。

（2）location / {}
因为所有的地址都以 / 开头，所以这条规则将匹配到所有请求 比如访问 / 和 /data, 则 / 匹配， /data 也匹配，
但若后面是正则表达式会和最长字符串优先匹配（最长匹配）

（3）location /documents/ {}
匹配任何以 /documents/ 开头的地址，匹配符合以后，还要继续往下搜索其它 location
只有其它 location后面的正则表达式没有匹配到时，才会采用这一条

（4）location /documents/abc {}
匹配任何以 /documents/abc 开头的地址，匹配符合以后，还要继续往下搜索其它 location
只有其它 location后面的正则表达式没有匹配到时，才会采用这一条

（5）location ^~ /images/ {}
匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条

（6）location ~* .(gif|jpg|jpeg)$ {}
匹配所有以 gif、jpg或jpeg 结尾的请求
然而，所有请求 /images/ 下的图片会被 location ^~ /images/ 处理，因为 ^~ 的优先级更高，所以到达不了这一条正则

（7）location /images/abc {}
最长字符匹配到 /images/abc，优先级最低，继续往下搜索其它 location，会发现 ^~ 和 ~ 存在

（8）location ~ /images/abc {}
匹配以/images/abc 开头的，优先级次之，只有去掉 location ^~ /images/ 才会采用这一条

（9）location /images/abc/1.html {}
匹配/images/abc/1.html 文件，如果和正则location ~ /images/abc/1.html 相比，正则优先级更高

5.实际网站使用中，至少有三个匹配规则定义

5.1第一个必选规则

直接匹配网站根，通过域名访问网站首页比较频繁，使用这个会加速处理，比如说官网。

可以是一个静态首页，也可以直接转发给后端应用服务器

location = / {

​ root html;

​ index index.html index.htm;

}

5.2第二个必选规则

处理静态文件请求，这是nginx作为http服务器的强项
有两种配置模式，目录匹配或后缀匹配,任选其一或搭配使用
location ^~ /static/ {
root /webroot/static/;
}

location ~* .(html|gif|jpg|jpeg|png|css|js|ico)$ {
root /webroot/res/;
}

5.3第三个规则就是通用规则

比如用来转发带.php、.jsp后缀的动态请求到后端应用服务器

非静态文件请求就默认是动态请求

location / {

​ proxy_pass http://tomcat_server;

}

三.rewrite 实例

1.基于域名的跳转

现在公司旧域名www.kgc.com有业务需求变更，需要使用新域名www.benet.com代替，但是旧域名不能废除，需要跳转到新域名上，而且后面的参数保持不变。
目的：业务变更

  vim /usr/local/nginx/conf/nginx.conf
    server {
        listen       80;
#域名修改	
        server_name  www.kgc.com;
  charset utf-8;
#日志修改
    access_log  logs/www.kgc.access.log;

    location / {
 #添加域名重定向
       #$host为rewrite全局变量，代表请求主机头字段或主机名
        if ($host = 'www.kgc.com'){
#$1为正则匹配的内容，即“域名/”之后的字符串
         rewrite ^/(.*)$ http://www.benet.com/$1 permanent;
        }
        root   html;
        index  index.html index.htm;
 }

echo "192.168.198.13 www.kgc.com www.benet.com" >> /etc/hosts
nginx -t
nginx: the configuration file /usr/local/nginx/conf/nginx.conf syntax is ok
nginx: configuration file /usr/local/nginx/conf/nginx.conf test is successful
systemctl restart nginx.service

浏览器输入模拟访问 http://www.kgc.com/test/1.html(虽然这个请求内容是不存在的)
会跳转到www.benet.com/test/1.html，查看元素可以看到返回301，实现了永久重定向跳转，而且域名后的参数也正常跳转。

访问www.kgc.com域名时跳转到新的域名www.benet.com

跳转之前

跳转之后

2.基于客户端 IP 访问跳转

今天公司业务新版本上线，要求所有 IP 访问任何内容都显示一个固定维护页面，只有公司 IP ：192.168.198.13访问正常。
目的：需要别人禁止访问或网站维护，需要禁止别人访问

server {
        listen       80;
#域名修改	
        server_name  www.txbb.com;
        charset utf-8;
#日志修改
        access_log  /var/log/www.txbb.com-access.log;
#设置是否合法的IP标记
#设置变量$rewrite，变量值为boole值true（boole就是判断真假
        set $rewrite true;
#判断是否为合法IP
        if ($remote_addr = "192.168.198.13"){
        set $rewrite false;
}
#除了合法IP，其它都是非法IP，进行重写跳转维护页面
#当变量值为true时，进行重写
        if ($rewrite = true){
#将域名后边的路径重写成/weihu.html，例如www.txbb.com/weihu.html
        rewrite (.+) /weihu.html;
}
        location = /weihu.html {
#网页返回/var/www/html/weihu.html的内容
            root   /var/www/html;
        }
        location / {
            root html;

            index  index.html index.htm;
}
}

mkdir -p /var/www/html/
echo '<h1>We are maintaining now!</h1>' > /var/www/html/weihu.html
nginx -t
systemctl restart nginx

只有 IP 为 192.168.10.19 能正常访问，其它地址都是维护页面

3.基于旧域名跳转到新域名后面加目录

现在访问的是 http://bbs.kgc.com/post/，现在需要将这个域名下面的访问都跳转到http://www.kgc.com/bbs/post/

vim /usr/local/nginx/conf/nginx.conf
server {
        listen       80;
#域名修改	
        server_name  bbs.kgc.com;
        charset utf-8;
        access_log  /var/log/www.kgc.com-access.log;
        location /post {
#这里的$1为位置变量，代表/post
        rewrite (.+) http://www.kgc.com/bbs/$1 permanent;
}

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

mkdir -p /usr/local/nginx/html/bbs/post
echo "this is 1.html"  >> /usr/local/nginx/html/bbs/post/1.html
echo "192.168.198.13 bbs.kgc.com"  >> /etc/hosts
echo "192.168.198.13 ww.kgc.com"  >> /etc/hosts
nginx -t
systemctl restart nginx

使用浏览器访问 http://bbs.kgc.com/post/1.html 跳转到 http://www.kgc.com/bbs/post/1.html

4.基于参数匹配的跳转

现在访问http://www.kgc.com/100-(100|200)-100.html 跳转到http://www.kgc.com页面。

vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
#域名修改	
	server_name  www.kgc.com;	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	
	if ($request_uri ~ ^/100-(100|200)-(\d+).html$) {
        rewrite (.+) http://www.kgc.com permanent;
    }
	
	location / {
        root   html;
        index  index.html index.htm;
    }
}

systemctl restart nginx

使用浏览器访问 http://www.kgc.com/100-200-100.html 或 http://www.kgc.com/100-100-100.html 跳转到http://www.kgc.com页面。

5.基于目录下所有 php 结尾的文件跳转

要求访问 http://www.kgc.com/upload/123.php 跳转到首页。

vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
#域名修改
	server_name  www.kgc.com;			
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	
	location ~* /upload/.*\.php$ {
        rewrite (.+) http://www.kgc.com permanent;
    }
    
	location / {
        root   html;
        index  index.html index.htm;
    }
}

systemctl restart nginx

浏览器访问 http://www.kgc.com/upload/123.php 跳转到http://www.kgc.com页面。

6.基于最普通一条 url 请求的跳转

要求访问一个具体的页面如 http://www.kgc.com/abc/123.html 跳转到首页

vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
#域名修改
	server_name  www.kgc.com;	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	
    location ~* ^/abc/123.html {
        rewrite (.+) http://www.kgc.com permanent;
    }
#或者 if （ $request_uri ~* ^/abc/abc.html$){
rewrite (.+) http://www.kgc.com permanent;
}

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

systemctl restart nginx

浏览器访问 http://www.kgc.com/abc/123.html 跳转到http://www.kgc.com页面。

总

1.重要：
Rewrite的实际场景，实现方式，flag标记说明，last和break的比较
location的匹配规则，优先级
Rewrite和location的比较
2.遇到的问题
配置文件的细致优化，配置错误
域名映射问题
echo传参未生效