Nginx Rewrite location

180 阅读6分钟

1. 介绍

location指令是http模块当中最核心的一项配置,根据预先定义的URL匹配规则来接收用户发送的请求,根据匹配结果,将请求转发到后台服务器、非法的请求直接拒绝并返回403、404、500错误处理等。本文结合语法、[优先级]、匹配规则做描述。

1.2. 常用的 Nginx 正则表达式

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

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

rewrite

对访问的域名或者域名内的URL路径地址重写

location

对访问的路径做访问控制或者代理转发

location 匹配用户的url访问路径,跳转页面(根据root alias定义的页面)

rewrite 对用户访问的域名或者URL路径进行地址重写,然后再根据location的匹配再跳转页面

2. location

location大致可以分为三类: 精清住匹配:location = / {...} 一般匹配:location / {...} 正则匹配: location ~ / {... }

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

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

location优先级:

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

3. location 示例说明:

  1. location = / { }
  • =为精确匹配/,主机名后面不能带任何字符串,比如访问/和/data,则/匹配,/data不匹配
  • 再比如location = /abc,则只匹配/abc , /abc/或/abcd不匹配。若location/abc,则即匹配/ abc ,/abcd/同时也匹配laool 。
  1. location / { }
  • 因为所有的地址都以 / 开头,所以这条规则将匹配到所有请求比如访问 / 和 /data,则/匹配 / /data 也匹配,
  • 但若后面是正则表达式会和最长字符串优先匹配(最长匹配)
  1. location /documents/ {}
  • 匹配任何以 /documents/ 开头的地址,匹配符合以后,还要继续往下搜索其它 location
  • 只有其它 location 后面的正则表达式没有匹配到时,才会采用这一条
  1. location /documents/abc { }
  • 匹配任何以 /documents/abc 开头的地址,匹配符合以后,还要继续往下搜索其它 location
  • 只有其它 location 后面前缀路径没有匹配到时,才会采用这一条
  1. location ^~ /images/ { } 匹配任何以 /images/ 开头的地址,匹配符合以后,停止往下搜索正则,采用这一条

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

  • 匹配所有以 gif、 jpg 或 jpeg 结尾的请求
  • 然而,所有请求 /images/ 下的图片会被 location ^~ /images/ 处理,因为 ^~ 的优先级更高,所以到达不了这一条正则
  1. location /images/ abc { }
  • 最长字符匹配到 /images/abc,优先级最低,继续往下搜索其它 location,会发现 ^~ 和 ~ 存在
  1. location /images/ { }
  • 字符匹配到 /images/,继续往下,会发现 ^~ 存在
  1. location ~* /js/.*/.js { }
  • 不区分大小写匹配
(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 文件,如果和正则 ~ /images/abc/1.html 相比,正则优先级更高

优先级总结:
(location =) > (location 完整路径) > (location ^~ 路径) > (location ~,~* 正则顺序) > (location 部分起始路径) > (location /)

3.1 优先级总结:

 精准匹配(location = 完整路径) > 前缀匹配(location ^~ 前缀路径)> 正则匹配(location ~,~* 正则表达式) > 一般匹配(location 前缀路径)>通用匹配(location /)

location 匹配总结

先看优先级 :精准= > 前缀^~ > 正则~ > 一般 > 通用 /

在没有精准匹配的情况下,先看前缀匹配的长度,然后根据最长的前缀匹配的优先级去确定是否再去看正则匹配 location 如果最长的前缀匹配带有 ^~ 则不看正则匹配 location,如果最长的前缀匹配是没有修饰符的一般匹配则会再去看正则匹配 location

  1. 前缀匹配看长度,最长的优先匹配
  2. 正则看上下顺序,上面的优先

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

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

5. rewrite

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

rewrite只能放在server{},location{},if{}中,并且默认只能对域名后面的除去传递的参数外的字符串起作用。 例如: www.lic.com/a/we/index.… 只对/a/we/index.php重写。

5.1 rewrite 跳转实现

  • Nginx:通过ngx_http_rewrite_module模块支持URL重写、支持if条件判断,但不支持else
  • 跳转:从一个location跳转到另一个location,循环最多可以执行10次,超过后nginx将返回500错误
  • PCRE支持:perl兼容正则表达式的语法规则匹配
  • 重写模块set指令:创建新的变量并为其赋值 rewrite使用Nginx全局变量或自己设置的变量,结合正则表达式和标志位实现URL重写以及重定向

5.2 rewrite执行顺序

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

5.3 rewrite语法格式

语法rewrite<regex><replacement><flag>;
regex:表示正则匹配规则
replacement:表示跳转后的内容
flag:表示rewrite支持的flag标记
5.4 flag标记说明
  • last :本条规则匹配完成后,继续向下匹配新的location URI规则,一般用在 server 和 if 中。 -break:本条规则匹配完成即终止,不再匹配后面的任何规则,一般使用在 location 中。
  • redirect :返回302临时重定向,浏览器地址会显示跳转后的URL地址。
  • permanent :返回301永久重定向,浏览器地址栏会显示跳转后的URL地址。
  1. 301:代表永久性转移(Permanently Moved):旧地址A的资源已经被永久地移除了(这个资源不可访问了),搜索引擎在抓取新内容的同时也将旧的网址交换为重定向之后的网址;。
  2. 302:代表暂时性转移(Temporarily Moved):旧地址A的资源还在(仍然可以访问),这个重定向只是临时地从旧地址A跳转到地址B,搜索引擎会抓取新的内容而保存旧的网址。

6. rewrite 示例

6.1 基于域名的跳转

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

vim /usr/local/nginx/conf/nginx.conf

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

QQ截图20221020145802.png

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

QQ截图20221020145642.png

重启服务后,浏览器查看

浏览器地址栏会显示跳转后的URL地址

QQ截图20221020145442.png

(2)基于客户端 IP 访问跳转

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

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

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

QQ截图20221020151224.png

mkdir -p /var/www/html/
echo "<h1>We are maintaining now!</h1>" > /var/www/html/weihu.html
systemctl restart nginx
只有 IP 为 192.168.80.60 能正常访问,其它地址都是维护页面

如果rewrite (.+) /weihu.html; 换成rewrite (.+) /weihu.html permanent; 的话,若不是 192.168.85.60 的主机访问会使浏览器修改请求访问的 URL 成 www.ww.com/weihu.html 再请求访问,这样就会进入一直在 rewrite 的死循环,访问请求会一直被重写成 www.ww.com/weihu.html 再请求访问

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

现在访问的是 bbs.ww.com/post/,现在需要将…

vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  bbs.ww.com www.ww.com;		#域名修改	
	charset utf-8;
	access_log  /var/log/nginx/www.ww.com-access.log;
	#添加
	location /post {
        rewrite (.+) http://www.ww.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.85.60 bbs.ww.com"  >> /etc/hosts
systemctl restart nginx
使用浏览器访问 http://bbs.ww.com/post/1.html 跳转到 http://www.ww.com/bbs/post/1.html
(4)基于参数匹配的跳转

现在访问www.ww.com/100-(100|20… 跳转到www.ww.com页面。

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

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

$request_uri:包含请求参数的原始URI,不包含主机名,如:http://www.ww.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 使用浏览器访问 www.ww.com/100-200-100…www.ww.com/100-100-100… 跳转到www.ww.com页面。

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

要求访问 www.ww.com/upload/123.… 跳转到首页。

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

	location / {
        root   html;
        index  index.html index.htm;
    }
}
systemctl restart nginx
浏览器访问 http://www.ww.com/upload/123.php 跳转到http://www.ww.com页面。
(6)基于最普通一条 url 请求的跳转

要求访问一个具体的页面如 www.ww.com/abc/123.htm… 跳转到首页

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

	location / {
        root   html;
        index  index.html index.htm;
    }
}
systemctl restart nginx
浏览器访问 http://www.ww.com/abc/123.html 跳转到http://www.ww.com页面。