Nginx-rewrite模块概述

更新时间：2023年06月05日 09:54:52 作者：善良的狼人

从功能上看 rewrite 和 location 似乎有点像，都能实现跳转，主要区别在于 rewrite 是在同一域名内更改获取资源的路径，这篇文章主要介绍了Nginx-rewrite模块详细介绍,需要的朋友可以参考下

前言

现在 Nginx 已经成为很多公司作为前端反向代理 (proxy pass) 服务器的首选，在实际工作中往往会遇到很多跳转（重写URL）的需求。比如，更换域名后需要保持旧的域名能跳转到新的域名上、某网页发生改变需要跳转到新的页面、网站防盗链等等需求。如果在后端使用的Apache服务器，虽然也能做跳转，规则库也很强大，但是用 Nginx 跳转效率会更高。

一、Nginx-rewrite模块概述

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

rewrite：对访问的域名或者域名内的URL路径地址重写
location：对访问的路径做访问控制或者代理转发

1、rewrite场景

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

2、rewrite实现

Nginx是通过ngx_http_rewrite_module模块支持URL重写、支持if条件判断，但不支持else。
该模块需要PCRE支持，应在编译Nginx时指定PCRE支持，默认已经安装。根据相关变量重定向和选择不同的配置，从一个location跳转到另一个location，不过这样的循环最多可以执行10次，超过Nginx将返回500错误。
PCRE支持：perl兼容正则表达式的语法规则匹配
同时，重写模块包括set指令，来创建新的变量并设其值，这在有些情境下非常有用的，如记录条件标识、传递参数到其他location、记录做了什么等等。
rewrite功能就是，使用Nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现URL的重写及重定向。比如：更换域名后需要保持旧的域名能跳转到新的域名上、某网页发生改变需要跳转到新的页面、网站防盗链等等需求。

3、rewrite执行顺序

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

4、语法格式

rewrite <regex> <replacement> [flag];

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

flag标记说明：

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

二、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  /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/test/1.html(虽然这个请求内容是不存在的)
会跳转到www.benet.com/test/1.html，查看元素可以看到返回301，实现了永久重定向跳转，而且域名后的参数也正常跳转。

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

今天公司业务新版本上线，要求所有 IP 访问任何内容都显示一个固定维护页面，只有公司 IP ：192.168.80.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;		#日志修改
	#设置是否合法的IP标记
    set $rewrite true;							#设置变量$rewrite，变量值为boole值true
    #判断是否为合法IP
	if ($remote_addr = "192.168.80.10"){		#当客户端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;
    }
}
mkdir -p /var/www/html/
echo "<h1>We are maintaining now!</h1>" > /var/www/html/weihu.html
systemctl restart nginx

只有 IP 为 192.168.80.10 能正常访问，其它地址都是维护页面
如果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 再请求访问

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 /bbs {
        root   /var/www/;
        index  index.html index.htm;
    }
	location /post {
	    root /var/www
        rewrite (.+) http://www.kgc.com/bbs$1 permanent;		#这里的$1为位置变量，代表/post
    }
}
mkdir -p /var/www/bbs/post
echo "this is 1.html"  >> /var/www/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

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
d o c u m e n t u r i ：与 document_uri：与document
u
ri：与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页面。

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

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;
    }
}
systemctl restart nginx

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

到此这篇关于Nginx-rewrite模块概述的文章就介绍到这了,更多相关Nginx-rewrite模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Nginx实现不同域名输出不同的服务器头信息方法
这篇文章主要介绍了Nginx实现不同域名输出不同的服务器头信息方法,本文使用了一个ngx_headers_more模块实现这个特殊需求,需要的朋友可以参考下
2015-02-02
Prometheus 和 Grafana 通过nginx-exporter监控nginx的
nginx-exporter 是 Prometheus 用来从 Nginx 收集指标的组件,这篇文章给大家介绍Prometheus 和 Grafana 通过nginx-exporter监控nginx的详细步骤,感兴趣的朋友跟随小编一起看看吧
2024-08-08
Nginx开启Brotli压缩算法实现过程详解
这篇文章主要介绍了Nginx开启Brotli压缩算法实现过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-11-11
NGINX中浏览器的盗链与防止被盗的实现
本文介绍在局域网内实现盗链与防盗链的配置方法,通过Nginx设置valid_referers限制资源访问来源,非法引用返回403禁止访问,感兴趣的可以了解一下
2025-07-07
nginx容器配置文件独立的实现
本文主要介绍了nginx容器配置文件独立，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-12-12
Nginx配置allow和deny指令的使用
在Nginx配置中,allow和deny指令用于基于IP地址的访问控制,帮助管理员灵活管理资源访问权限,具有一定的参考价值,感兴趣的可以了解一下
2025-05-05
Nginx map 实现时间格式转换的方法
最近我们需要把 Nginx 的日志接入到自研的日志采集平台上，但是这个平台只支持 JSON 格式，所以需要把 Nginx 日志格式改成 JSON 格式，这篇文章主要介绍了Nginx map 实现时间格式转换,需要的朋友可以参考下
2023-09-09
nginx+ingress 413问题排查过程
处理413错误需调整Nginx的client_max_body_size及Ingress配置,合理设置body-size,若无效,检查后端限制,注意过大可能影响安全
2025-08-08
Nginx 1.28.0 源码编译安装与自定义网页部署详细指南
本文介绍了Nginx1.28.0的安装过程,提供了自定义HTML文件部署步骤、安装后核心目录说明、常用管理命令、部署前端项目示例等内容,感兴趣的朋友跟随小编一起看看吧
2026-05-05
nginx设置上传目录无执行权限的方法
在windows+iis下，可以设置上传目录，类似:upload,uploadfile,attachments，这样的目录下面无脚本执行权限，从而防止非法用户上传脚本得到webshell
2010-11-11