17.Nginx 重写(location rewrite)

Nginx 重写(location / rewrite)

目录

• Nginx 重写(location / rewrite)
  • 常见的nginx正则表达式
  • location
    • lication的分类
    • location 常用的匹配规则
    • location 匹配的优先级
    • location 示例
    • 通用匹配
    • 正则匹配
    • lcation 匹配
    • 实际网站使用中，至少有三个匹配规则定义
      • 第一个必选规则
      • 第二个必选规则
      • 第三个规则
  • rewrite
    • rewrite跳转场景
    • Rewrite 跳转实现
    • rewrite 执行顺序
    • 语法格式
      • rewrite 示例
        • 基于域名的跳转
        • 基于客户端 IP 访问跳转
        • 基于旧域名跳转到新域名后面加目录
        • 基于参数匹配的跳转
        • 基于目录下所有 php 结尾的文件跳转
        • 基于最普通一条 url 请求的跳转

常见的nginx正则表达式

^	匹配输入字符串的起始位置（已什么开头）。
$	匹配输入字符串的结束位置（已什么结尾）。
*	匹配前面的字符零次或多次。如"01*"能够匹配到"0"、"01"、"011"、"0111......."。
+	匹配前面的字符一次或多次。如"01*"能够匹配到"01"、"011"、"0111......."。
?	匹配前面字符零次或一次。如01？只能能够匹配到"0"、"01"。
.	匹配除”\n“之外的任意一个字符，若要匹配包括”\n“在内的任意字符则使用”[.\n]“之类的表达式
\	转义符
\d	匹配出数字效果于[0-9]一致
\s	空白符
\w	任意单词字符包括下划线
{n}	匹配前面表字符n次
{n,}	匹配前面字符不少于n次
{n,m}	匹配前面字符n到m次
[]	定义匹配的字符范围
[c]	匹配单个字符c
[a-z]	匹配a-z小写字母任意一个
[a-zA-Z0-9]	匹配范围大小写字母及数字
()	看成整体匹配
|	或运算符

location

lication的分类

精准匹配	location = / {...}
一般匹配	location / {...}
正则匹配	location ~ / {...}

location 常用的匹配规则

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

location 匹配的优先级

• 首先精准匹配=
• 其次前缀匹配^~
• 其次是按文件中顺序的正则匹配 或*
• 然后匹配不带任何修饰的前缀匹配
• 最后是交给 / 通用匹配

location 示例

示例1：精准匹配

[root@www ~]# vim /usr/local/nginx/conf/nginx.conf

此时浏览器访问http://www.kgc.com/test1则访问的是根目录下test1目录内的index.html

如果访问http://www.kgc.com则会访问根目录下的index.html

通用匹配

location / {}

• 因为所有的地址都以 / 开头，所以这条规则将匹配到所有请求 比如访问 / 和 /data, 则 / 匹配， /data 也匹配，

location /test/ {}

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

location /test/abc {}

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

示例

新建网页站点目录，新建index.html文件

[root@www data]# systemctl restart nginx

此时网页测试说明除去优先级匹配通用匹配内后缀长的优先级高

正则匹配

location ^~ /images/ {}

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

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

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

示例：

分别把狗和猫的图片放入/opt/test/gou.gif、/data/test/gou.gif取名为一样的，狗在opt猫在data。

重启服务测试明显可以看出访问的是opt目录所以说正则匹配前缀的优先级要比后缀高。

[root@www test]# systemctl restart nginx

优先级总结：

(location = 完整路径) > (location ^~ 路径) > (location ,* 正则顺序) > (location 部分起始路径) > (location /)

lcation 匹配

• 首先看 优先级：精确= > 前缀^~ > 正则,* > 一般 > 通用/
• 优先级相同：正则看上下顺序，上面的优先；一般匹配看长度，最长匹配的优先
• 精确、前缀、正则、一般 都没有匹配到，最后再看通用匹配

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

第一个必选规则

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

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

第二个必选规则

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

location ^~ /static/ {
    root /webroot/static/;
}

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{}中，并且默认只能对域名后边的除去传递的参数外的字符串起作用，

rewrite跳转场景

Rewrite 跳转场景主要包括以下几种

• 可以调整用户浏览的 URL，看起来更规范，合乎开发及产品人员的需求
• 为了让搜索引擎搜录网站内容及用户体验更好，企业会将动态 URL 地址伪装成静态地址提供服务
• 网址换新域名后，让旧的访问跳转到新的域名上。例如，访问京东的 360buy.com会跳转到 jd.com
• 根据特殊变量、目录、客户端的信息进行 URL 调整等。

Rewrite 跳转实现

• Nginx 是通过 ngx_http_rewrite_module 模块支持 url 重写、支持 if 条件判断，但不支 持 else。
• 另外该模块需要 PCRE 支持，应在编译 Nginx 时指定 PCRE 支持，默认已经安装。
• 根据相关变量重定向和选择不同的配置，从一个 location 跳转到另一个 location，不过这样 的循环最多可以执行 10 次，超过后 Nginx 将返回 500 错误。
• 同时，重写模块包含 set 指令，来创建新的变量并设其值，这在有些情景下非常有用的，如记录条件标识、传递参数到其他location、记录做了什么等等。

rewrite 执行顺序

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

语法格式

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

flag标记说明

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

rewrite 示例

基于域名的跳转

要求：现在公司旧域名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  /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;
    }
}

echo "192.168.80.10 www.kgc.com www.benet.com" >> /etc/hosts
systemctl restart nginx

此时重启服务网页输入http://www.kgc.com会跳转到http://www.benet.com

基于客户端 IP 访问跳转

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

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;		

set $rewrite true;
if ($remote_addr = "192.168.239.10"){
    set $rewrite false;
}

if ($rewrite = true){
    rewrite (.+) /weihu.html;
}

location = /weihu.html {
    root /var/www/html;
}

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

}

mkdir -p /var/www/html/
echo "hello" > /var/www/html/weihu.html
systemctl restart nginx

---

注：如果rewrite (.+) /weihu.html; 改成rewrite (.+) /weihu.html permanent; 的话，如果是非 192.168.80.10 的主机访问会使浏览器修改请求访问的URL成 http://www.kgc.com/weihu.html 再请求访问，这样就会进入一直在 rewrite 的死循环，访问请求会一直被重写成 http://www.kgc.com/weihu.html 再请求访问

新建站点目录文件重启服务

在其他主机写入本主机的映射关系![1652018588958]

网页测试

本主机访问

其他主机访问

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

现在访问的是 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/nginx/www.kgc.com-access.log;
	location /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 test"  >> /usr/local/nginx/html/bbs/post/index.html
echo "192.168.80.10 bbs.kgc.com"  >> /etc/hosts
systemctl restart nginx

创建站点目录文件

添加域名映射关系重启服务

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

基于参数匹配的跳转

现在访问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

systemctl restart nginx

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

基于目录下所有 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页面。

基于最普通一条 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;
}

}

systemctl restart nginx

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