Nginx Rewrite

前言

nginx的rewrite功能在企业里应用非常广泛，它可以调整用户浏览的url，看起来更规范，提高用户体验，也更加合乎产品人员的需求。

一、nginx rewrite概述

(1)概述

​location是为了匹配访问的路径(URL)​

if 做为分支判断，并且if分支，仅支持单分支​

​rewrite:对访问路径进行改写大分支；

1、改写的路径​

在Nginx服务器上-改写路径​

2、​改写的路径​ 

在后端/其他服务器上-跳转​

• URI（Uniform Resource Identifier ），统一资源标识符；
• URL（Uniform Resource Locator ），统一资源定位符，不仅标识了资源，还指定了操作或者获取方式，同时指出了主要访问机制和网络位置；
• URN（Uniform Resource Name ），统一资源名称，用特定命名空间的名字标识资源，使用URN可以在不知道其网络位置及访问方式的情况下讨论资源。

(2)跳转场景

1、可以调整用户浏览的URL，看起来更规范，合理​

​2、为了让搜索引擎搜录网站内容及用户体验更好，企业会将动态URL地址伪装成静态地址提供服务。​

​3、网址换新域名后，让旧的访问跳转到新的域名上。例如，访问京东的360buy.com会跳转到jd.com。​

​4、服务端某些业务调整​

​5、根据特殊变量、目录、客户端的信息进行URL调整等

(3)跳转实现

1、​Nginx是通过ngx_http_rewrite_module模块支持url重写、支持if条件判断，但不支持else。

2、另外该模块需要 PCRE支持，应在编译Nginx时指定PCRE 支持，默认已经安装。

3、根据相关变量重定向和选择不同的配置，从一个location跳转到另一个location，不过这样的循环最多可以执行10次，超过后Nginx将返回500错误。

4、重写模块包含set指令，来创建新的变量并设其值，这在有些情景下非常有用的，如记录条件标识、传递参数到其他location、记录做了什么等等。

5、rewrite功能就是使用Nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。​

(4)rewrite实际场景

①nginx跳转需要的实现方式

使用rewrite进行匹配跳转（防盗链）

使用if匹配全局变量后跳转

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

②rewrite放在server{}, if{},location{}段中

（多个server模块 sever模块里包含location location包含if if里面包含rewrite）
location只对域名后边的除去传递参数外的字符串起作用

③对域名或参数字符串

使用if全局变量匹配
使用proxy_pass反向代理

二、常见的Nginx正则表达式

(1)常见的正则表达式的元字符

^ ：匹配输入字符串的起始位置
$ ：匹配输入字符串的结束位置
* ：匹配前面的字符零次或多次。如“ol*”能匹配“o”及“ol”、“oll”
\+ ：匹配前面的字符一次或多次。如“ol+”能匹配“ol”及“oll”、“olll”，但不能匹配“o”
? ：匹配前面的字符零次或一次，例如“do(es)?”能匹配“do”或者“does”，”?”等效于”{0,1}”
. ：匹配除“\n”之外的任何单个字符，若要匹配包括“\n”在内的任意字符，请使用诸如“[.\n]”之类的模式
 \ ：将后面接着的字符标记为一个特殊字符或一个原义字符或一个向后引用。如“\n”匹配一个换行符，而“\$”则匹配“$”
\d ：匹配纯数字
{n} ：重复 n 次
{n,} ：重复 n 次或更多次
{n,m} ：重复 n 到 m 次
[] ：定义匹配的字符范围
[c] ：匹配单个字符 c
[a-z] ：匹配 a-z 小写字母的任意一个
[a-zA-Z0-9] ：匹配所有大小写字母或数字
() ：表达式的开始和结束位置
| ：或运算符

(2)正则表达的优势

1、精确匹配，减少遍历的消耗

2、节省服务响应的资源消耗

3、提高用户体验感

4、提高服务器并发时、处理效率/性能

③Nginx使用正则的作用

Nginx作为运维角度前段接受、想用客户请求的直接对服务器所以需要考虑到Nginx的执行效率（精确匹配-类比）、性能（资源消耗）、抗压能力（高并发时处理能力）、用户体验感（用户访问群体）

三、rewrite

(1)rewrite语法

rewrite < regex > < replacement > [flag]
regex：正则表达式
replacement ：跳转后的内容
flag：rewrite支持的flag标记

• flag标记说明

标记	说明
last	相当于Apache的【L】标记，表示完成rewrite
break	本条规则匹配完成即终止，不在匹配后面的任何规则
redirect	返回302临时重定向，浏览器地址栏会显示跳转后的URL地址，爬虫不会更新url
permanent	返回301永久重定向，浏览器地址栏会显示跳转后的URL地址，爬虫更新url

• last与break比较

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

(2)rewrite执行顺序

执行server块里面的rewrite指令

执行location匹配

执行选定的location中的rewrite指令

四、location分类和优先级

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

(1)location匹配规则格式

location= patt {} [精准匹配]
location patt {} [一般匹配]
location ~ patt {} [正则匹配]

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

(2)location优先级

相同类型的表达式，字符串长的会优先匹配
按优先级排列
① = 类型
② ^~类型表达式
③ 正则表达式 （和 *） 类型

④常规字符串匹配类型，按前缀匹配
⑤ 通用匹配（/），如果没有其他匹配，任何请求都会匹配到
匹配某个具体文件
(location=完整路径) > (location 完整路径) > (location *完整路径) >(location~完整路径) > (location完整路径) > (location /)

用目录做匹配访问某个文件
(location=目录) > (location ^ 目录/) > (location 目录 ) > (location~*目录) > (location目录)

示例：

• location = / {}

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

• location / {}

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

• location /documents/ {}

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

• location /documents/abc {}

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

• location ^~ /images/ {}

匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条

• location ~* .(gif|jpg|jpeg)$ {}

匹配所有以 gif、jpg或jpeg 结尾的请求，然而，所有请求 /images/ 下的图片会被 location /images/ 处理，因为 的优先级更高，所以到达不了这一条正则。

• location /images/abc {}

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

• location ~ /images/abc {}

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

• location /images/abc/1.html {}

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

(3)比较rewrite和location

相同点：

都能实现跳转

不同点：

rewrite是在同一域名内更改获取资源的路径
location是对一类路径做控制访问或反向代理，还可以proxy_pass到其他机器

执行顺序:

执行server块里面的rewrite指令——》执行location匹配——》执行选定location中的rewrite指令

rewrite改写访问的URL路径（被访问的HTML、htm、css文件）

location 对一类地址进行权限控制（认证控制）跳转（跨服务器进行一个URL跳转）

(4)实际网站使用中，至少有三个匹配规则定义

①第一个必选规则

直接匹配网站根，通过域名访问网站首页比较频繁，使用这个会加速处理，比如说官网。
这里是直接转发给后端应用服务器了，也可以是一个静态首页​

location = / {
    proxy_pass http://tomcat_server/;
}

②第二个必选规则

处理静态文件请求，这是nginx作为http服务器的强项
有两种配置模式，目录匹配或后缀匹配,任选其一或搭配使用​

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

③第三个规则

通用规则，比如用来转发带.php、.jsp后缀的动态请求到后端应用服务器
非静态文件请求就默认是动态请求​

location / {
    proxy_pass http://tomcat_server;
}

五、rewrite跳转

(1)基于域名跳转

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

vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.youzi.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/youzi.com.access.log;		#日志修改
	location / {
	#添加域名重定向
        if ($host = 'www.youzi.com'){						            #$host为rewrite全局变量，代表请求主机头字段或主机名
			rewrite ^/(.*)$ http://www.wei.com/$1 permanent;		#$1为正则匹配的内容，即域名后边的字符串
        }
        root   html;
        index  index.html index.htm;
    }
}

(2)基于旧域名跳转新域名后面加目录

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

vim /usr/local/nginx/conf/nginx.conf
server {
        listen       80;
  server_name  www.youzi.com;  #域名地址 
  charset utf-8;
  access_log  /var/log/nginx/youzi.com.access.log;  #日志文件地址 
location /wei {
	rewrite (.+) http://www.youzi.com/bbs$1 permanent;
	#将bbs.youzi.com/wei/(.+)跳转到新的域名地址；.+为一到多个字符
	#$1为 /wei/（.+） 
	}
location / {
            root   html;
            index  index.html index.htm;
        }
  mkdir -p /usr/local/nginx/html/bbs/wesi

(3)基于客户端IP的跳转

要求所有 IP 访问任何内容都显示一个固定维护页面，只有IP ：192.168.159.230访问正常。

vim /usr/local/nginx/conf/nginx.conf
server {
        listen       80;
        server_name  www.youzi.com;
       charset utf-8;
        access_log  /var/log/nginx/youzi.com.access.log;
        set $rewrite true;   #设置rewrite变量值为true
        if ($remote_addr = "192.168.159.230"){  #当客户端为次ip时，不进行跳转
        set $rewrite false;                   #设置rewrite值为false
        }
        if ($rewrite = true){     #当rewrite值为真，则进行跳转 
        rewrite (.+) /test.html;  #将所有地址跳转到 www.youzi.com/text.html界面
        }
        location / {
            root   html;
            index  index.html index.htm;
        }
  
cd /usr/local/nginx/html
echo "hellow weihu" > test.html
systemctl restart nginx

(4)基于参数匹配跳转

vim /usr/local/nginx/conf/nginx.conf
server {
listen       80;
        server_name  www.youzi.com;
        charset utf-8;
        access_log  /var/log/nginx/youzi.com.access.log;
  	if ($request_uri ~ ^/100-(100|200)-(\d+).html$) {
  	#$request_uri：包含请求参数的原始URI，不包含主机名
  	rewrite (.+) http://www.youzi.com permanent;
  	}
  	location / {
  	root   html;
        index  index.html index.htm;
        }
}

systemctl restart nginx

浏览器访问

​​http://www.youzi.com/100-200-100.html 或 http://www.youzi.com/100-100-100.html 跳转到http://www.lic.com页面。

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

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

浏览器访问

​http://www.youzi.com/upload/123.php 跳转到http://www.youzi.com页面

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

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

浏览器访问

​http://www.youzi.com/abc/123.html 跳转到www.youzi.com

总结

• location的分类（精确匹配、一般匹配、正则匹配）
• 掌握location的优先级(location = 完整路径) > (location ^~ 路径) > (location _,* 正则顺序) > (location 部分起始路径) > (location /)
• 掌握rewrite的几种使用方法：基于域名的跳转、基于客户端 IP 访问跳转、基于旧域名跳转到新域名后面加目录、基于参数匹配的跳转、基于目录下所有 php 结尾的文件跳转、基于最普通一条 url 请求的跳转