Nginx Rewrite

一、常用的Nginx 正则表达式
二、location 匹配的范围
- 2.1location实验
三、rewrite模块
- 3.1rewrite跳转
- 3.2rewrite执行顺
- 3.3flag标记说明
- 3.4rewrite中常用的全局变量
- 3.5rewrite实验
- - 3.5.1 基于域名的跳转
  - 3.5.2基于客户端IP访问跳转
  - 3.5.3基于旧域名跳转到新域名后面加目录
  - 3.5.4基于参数匹配的跳转
  - 3.5.5基于目录下所有 php 结尾的文件跳转
  - 3.5.6基于最普通的一跳url请求跳转

一、常用的Nginx 正则表达式

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

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

二、location 匹配的范围

location 大致可以分为三类：
精准匹配：location = / {…}
一般匹配：location / {…}
正则匹配：location ~ / {…}

location 常用的匹配规则：
= ：进行普通字符精确匹配，也就是完全匹配。
^~ ：表示普通字符匹配。使用前缀匹配。如果匹配成功，则不再匹配其它正则匹配location。
~ ：区分大小写的匹配。
~* ：不区分大小写的匹配。
!~ ：区分大小写的匹配取非。
!~* ：不区分大小写的匹配取非。

location 优先级：
首先精确匹配 =
其次前缀匹配 ^~
其次是按文件中顺序的正则匹配 ~或~*
然后匹配不带任何修饰符的一般前缀匹配
最后是交给 / 通用匹配
在没有精准匹配的情况下，先看前缀匹配的长度，然后根据最长的前缀匹配的优先级去确定是否再去看其它正则匹配location，

如果最长的前缀匹配带有 ^~ 则不再看其它正则匹配location，如果最长的前缀匹配是没有修饰符的一般匹配则会再看其它正则匹配location

前缀匹配看长度，最长的优先匹配
正则匹配看上下顺序，由上往下依次匹配，当有匹配成功时候，停止匹配，按当前匹配规则处理请求

只有在精准、前缀、正则、一般都没有匹配到的时候才会看通用匹配

2.1location实验

精确匹配“=”

=为精确匹配 / ，主机名后面不能带任何字符串，比如访问 / 和 /data，则 / 匹配，/data 不匹配

在这里插入图片描述

前缀匹配

location ^~ /images/ {}
匹配任何以 /images/ 开头的地址，匹配符合以后，停止往下搜索正则，采用这一条
前缀匹配看长度，最长的优先匹配

在这里插入图片描述

正则匹配匹配

一般匹配

只有在精准、前缀、正则都没有匹配到的时候才会采用这条匹配，一般匹配看长度，长度越长优先级越高

在这里插入图片描述

实际网站使用中，至少有三个匹配规则定义：
#第一个必选规则
直接匹配网站根目录首页，通过域名访问网站首页比较频繁，使用这个会加速处理，比如说官网。
可以是一个静态首页，也可以直接转发给后端应用服务器
location = /index.html {
root html;
index index.html index.htm;
}

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

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

#第三个规则就是通用规则，比如用来转发带.php、.jsp后缀的动态请求到后端应用服务器非静态文件请求就默认是动态请求 location / {
proxy_pass http://tomcat_server; }

三、rewrite模块

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

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

3.1rewrite跳转

Nginx：通过ngx_http_rewrite_module 模块支持URL重写、支持if条件判断，但不支持else
跳转：从一个 location跳转到另一个location，循环最多可以执行10次，超过后nginx将返回500错误
PCRE支持：perl兼容正则表达式的语法规则匹配
重写模块 set 指令：创建新的变量并设其值

在这里插入图片描述

3.2rewrite执行顺

(1) 执行 server 块里面的 rewrite 指令。
(2) 执行 location 匹配。
(3) 执行选定的 location 中的 rewrite 指令。

语法格式：rewrite\ <regex> <replacement> [flag];
regex ：表示正则匹配规则。
replacement ：表示跳转后的内容。
flag ：表示 rewrite 支持的 flag 标记

3.3flag标记说明

last ：本条规则匹配完成后，不终止重写后的url匹配，一般用在 server 和 if 中。
break ：本条规则匹配完成即终止，终止重写后的url匹配，一般使用在 location 中。
redirect ：返回302临时重定向，浏览器地址会显示跳转后的URL地址。
permanent ：返回301永久重定向，浏览器地址栏会显示跳转后的URL地址。

3.4rewrite中常用的全局变量

$args

变量中存放了请求URL中的请求参数。比如http://192.168.200.133/server?arg1=value1&args2=value2中
的"arg1=value1&arg2=value2"，功能和$query_string一样。

$http_user_agent

变量存储的是用户访问服务的代理信息(如果通过浏览器访问，记录的是浏览器的相关版本信息)

$host

变量存储的是访问服务器的server_name值

$document_uri

变量存储的是当前访问地址的URI。比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server"，功能和$uri一样

$document_root

变量存储的是当前请求对应location的root值，如果未设置，默认指向Nginx自带html目录所在位置

$content_length

变量存储的是请求头中的Content-Length的值

$content_type

变量存储的是请求头中的Content-Type的值

$http_cookie

变量存储的是客户端的cookie信息，可以通过add_header
Set-Cookie’cookieName=cookieValue’来添加cookie数据

$limit_rate

变量中存储的是Nginx服务器对网络连接速率的限制，也就是Nginx配置中对limit_rate指令设置的值，默认是0，不限制。

$remote_addr

变量中存储的是客户端的IP地址

$remote_port

变量中存储了客户端与服务端建立连接的端口号

$remote_user

变量中存储了客户端的用户名，需要有认证模块才能获取

$scheme

变量中存储了访问协议

$server_addr

变量中存储了服务端的地址

$server_name

变量中存储了客户端请求到达的服务器的名称

$server_port

变量中存储了客户端请求到达服务器的端口号

$server_protocol

变量中存储了客户端请求协议的版本，比如"HTTP/1.1"

$request_body_file

变量中存储了发给后端服务器的本地文件资源的名称

$request_method

变量中存储了客户端的请求方式，比如"GET","POST"等

$request_filename

变量中存储了当前请求的资源文件的路径名

$request_uri
变量中存储了当前请求的URI，并且携带请求参数，比如http://192.168.200.133/server?id=10&name=zhangsan中的"/server?id=10&name=zhangsan"

3.5rewrite实验

3.5.1 基于域名的跳转

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

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

在这里插入图片描述

3.5.2基于客户端IP访问跳转

需求：今天公司业务新版本上线，要求所有 IP 访问任何内容都显示一个固定维护页面，只有公司 IP ：192.168.243.102访问正常。

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;		#日志修改

	#设置是否合法的IP标记
    set $rewrite true;							#设置变量$rewrite，变量值为boole值true
    #判断是否为合法IP
	if ($remote_addr = "192.168.243.107"){		#当客户端IP为192.168.80.10时，将变量值设为false，不进行重写
        set $rewrite false;
    }
	#除了合法IP，其它都是非法IP，进行重写跳转维护页面
    if ($rewrite = true){						#当变量值为true时，进行重写
        rewrite (.+) /weihu.html;				#将域名后边的路径重写成/weihu.html后转发，例如www.kgc.com/weihu.html
    }
    location = /weihu.html {
        root /var/www/html;						#网页返回/var/www/html/weihu.html的内容
    }
	
	location / {
        root   html;
        index  index.html index.htm;
    }
}

在这里插入图片描述

3.5.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 www.kgc.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.kgc.com-access.log;
	#添加
	location /post {
        rewrite (.+) http://www.kgc.com/bbs$1 permanent;		#这里的$1为位置变量，代表/post
    }
	
	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.80.10 bbs.kgc.com"  >> /etc/hosts
systemctl restart nginx
使用浏览器访问 http://bbs.kgc.com/post/1.html 跳转到 http://www.kgc.com/bbs/post/1.html

在这里插入图片描述

3.5.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;
    }
}

$request_uri：包含请求参数的原始URI，不包含主机名，如：http://www.kgc.com/abc/bbs/index.html?a=1&b=2 中的 /abc/bbs/index.php?a=1&b=2
$uri：这个变量指当前的请求URI，不包括任何参数，如:/abc/bbs/index.html
$document_uri：与$ uri相同，这个变量指当前的请求URI，不包括任何传递参数，如:/abc/bbs/index.html

在这里插入图片描述

3.5.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;
    }
}

在这里插入图片描述

3.5.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;
    }

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