Nginx 的 location 匹配与 rewrite 重写跳转

Posted 2021-06-26 我一个月改一次名

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Nginx 的 location 匹配与 rewrite 重写跳转相关的知识，希望对你有一定的参考价值。

前言

一、nginx中的正则表达式

^ ：匹配输入字符串的起始位置
$ ：匹配输入字符串的结束位置
* ：匹配前面的字符零次或多次。如“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] ：匹配所有大小写字母或数字
() ：表达式的开始和结束位置
| ：或运算符

二、location 匹配

从功能看 rewrite 和 location 似乎有点像，都能实现跳转，主要区别在于：

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

2.1 location常用的匹配规则

匹配分类：

精准匹配：location = / {}             #精准、完全匹配
正则匹配：location ~ / {}             #和 正则表达式搭配使用
一般匹配：location / {}               #从根目录开始的路径

匹配规则：

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

2.2 location 优先级

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

2.3 location 示例说明

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

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

（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 /)

2.4 必选规则

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

第一个必选规则：

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

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

第二个必选规则：

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

location ^~ /static/ {               #目录匹配
    root /webroot/static/;         
} 

#后缀匹配，如果是这些文件名后缀的，就访问 /webroot/res/ 目录
location ~* \\.(html|gif|jpg|jpeg|png|css|js|ico)$ {       
    root /webroot/res/;
}

比如 www.daun.com/static/1.jpg、www.daun.com/static/abc/1.jpg 都被上面的目录匹配匹配了。

第三个必选规则：

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

location / {
    proxy_pass http://tomcat_server;
}

一个网站的匹配规则设置：

一般先给首页做个静态匹配（备胎匹配），再给静态页面写几个可能性的静态匹配，剩下的就是动态的通用匹配规则了。

三、rewrite 转发

3.1 Rewrite 介绍

rewrite 功能：使用 nginx 提供的全局变量或自己设置的变量，结合正则表达式和标记实现 URL重写以及重定向。

例如：

更换域名后需要保持旧的域名能够转到新的域名上；
某网页发生改变需要跳转到新的页面；
网站防盗链；
等等

Rewrite 跳转场景：

为了让搜索引擎搜录网站内容及用户体验更好，企业会将动态URL地址伪装成静态地址提供服务；
网址换新域名后，让旧的访问跳转到新的域名上。比如访问 www.360buy.com 就能重定向到 www.jd.com/；
服务端某些业务调整，比如根据特殊变量、目录、客户端的信息进行URL调整等。

注意：rewrite 只能放在配置文件中的 server{}，location{}，if{} 模块中，并且默认只能对域名后面的除去传递的参数外的字符串起作用。

例如：http://www.lisi.com/a/we/index.php?id=1&u=str
只会对 /a/we/index.php 重写。

3.2 Rewrite 实现

在这里插入图片描述

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

3.3 rewrite 执行顺序

优先：执行 server{} 块里面的 rewrite 指令
其次：执行 location 匹配
最后：执行选定的 location{} 中的 rewrite 指令

3.4 rewrite 语法格式

语法： rewrite <regex> <replacement> <flag>;

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

3.5 flag 标记说明

last ：本条规则匹配完成后，继续向下匹配新的location URI规则，一般用在 server 和 if 中。
break ：本条规则匹配完成即终止，不再匹配后面的任何规则，一般使用在 location 中。
redirect ：返回302临时重定向， 浏览器地址会显示跳转后的URL地址。
permanent ：返回301永久重定向，浏览器地址栏会显示跳转后的URL地址。
[ˈpɜːmə nənt]

3.6 rewrite 示例

3.6.1 基于域名的跳转

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

思考：肯定要先有监听 www.test.com 域名的这个站点 server

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

server {
	listen       80;
	server_name  www.test.com;     #域名修改
	charset utf-8;
	access_log  /var/log/nginx/www.test.com.access.log;     #日志修改
	location / {
	    #添加域名重定向
	    # $host 为 rewrite全局变量，代表请求主机头字段或主机名
	    #^/(.*)$  以根目录为开头 结尾不管有没有目录和参数
	    #$1为正则表达式匹配的内容，即"域名/"之后的字符串，就是rewrite的正则
	    #因为rewrite只能对域名后面的除去传递的参数外的字符串起作用,所以http://www.域名.com/ 要输写
	    
	    if ($host = 'www.test.com'){
	        rewrite ^/(.*)$ http://www.lisi.com/$1 permanent;
	    }
        root   html;         #访问页面还是主站点下的主页
        index  index.html index.htm;
    }
}

#添加域名解析
echo "192.168.31.101 www.lisi.com www.test.com" >> /etc/hosts

systemctl restart nginx

浏览器输入模拟访问 http://www.test.com/1.html（内容不存在的）
会跳转到www.lisi.com/1.html，查看元素可以看到返回301，实现了永久重定向跳转，而且域名后的参数也正常跳转。

在这里插入图片描述

添加域名解析

nginx -t , 重启 nginx 服务，清楚浏览器缓存。

浏览器访问 www.test.com 。会发现被 rewrite 重定向到了 www.lisi.com ，标记说明用的 permanent ，所以会返回 301，如果改成 redirect ，返回就是302.
在这里插入图片描述

因为rewrite 只对域名后面的除去传递的参数外的字符串起作用，因为后面的 /test/.html 会被直接作为 $1 拼接到 www.lisi.com/ 后面。

3.6.2 基于客户端 IP 访问跳转

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

通过 set 命令来设置自己的变量，来进行判断。

vim /usr/local/nginx/conf/nginx.conf
server {
	listen       80;
	server_name  www.test.com;
	charset utf-8;
	access_log  /var/log/nginx/www.test.com.access.log;

	#设置是否合法的IP标记;设置变量$rewrite，变量值为boole值true
    set $rewrite true;
    #判断是否为合法IP;当客户端IP为 192.168.31.101 时，将变量值设为false，不进行重写
    if ($remote_addr = "192.168.31.101"){
        set $rewrite false;
    }
    
	#除了合法IP，其它都是非法IP，进行重写跳转维护页面
	#当变量值为true时，进行重写
    if ($rewrite = true){
        #重写在访问IP后边插入/weihu.html，例如192.168.31.111/weihu.html
        #(.+) 表示正则能够匹配所有路径
        rewrite (.+) /weihu.html;
    }
    
    #维护之后，需要加一个location 进行精确匹配到weihu.html
    #不写这个location 的话就转到下面的location中去了
    location = /weihu.html {
        #网页返回/var/www/html/weihu.html的内容
        root /var/www/html;
    }
    
	location / {
        root   html;
        index  index.html index.htm;
    }
}

mkdir -p /var/www/html/
echo "<h1>As server maintenance, please visit later, thank you.</h1>" > /var/www/html/weihu.html
echo "192.168.163.10 www.test.com" >> /etc/hosts

nginx -t
systemctl restart nginx

在这里插入图片描述

浏览器访问
只有 IP 为 192.168.31.101 能正常访问，其它地址都会重定向到维护页面。
在这里插入图片描述
这时候比如打开一台同一网段的Windows 主机，添加 192.168.31.101 www.test.com 到 C:\\Windows\\System32\\drivers\\etc\\hosts 中。

访问 www.test.com
在这里插入图片描述
成功转到 weihu.html 页面。

访问 http://www.test.com/test/1.html 结果也一样。

注意：

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

因此页面跳转 不因该加上 permanent

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

比如，现在访问的是 http://bbs.test.com/post/，现在需要将这个域名下面的访问都跳转到 http://www.test.com/bbs/post/。

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

server {
	listen       80;
	server_name  bbs.test.com;
	charset utf-8;
	access_log  /var/log/nginx/bbs.test.com.access.log;
	
	#添加;这里的$1为位置变量，代表的就是： /post
	#匹配访问路径，根目录出发的目录
	location /post {
        rewrite (.+) http://www.test.com/bbs$1 permanent;
    }
    
	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.31.101 bbs.test.com www.test.com" >> /etc/hosts

基于Nginx Rewrite 与 Location 的网页匹配 跳转
 nginx与location规则
 Nginx中的location匹配与rewrite重写跳转
 Nginx_location的匹配规则的使用方法与实例
 Nginx 的 location 匹配 与 rewrite 重写跳转
 Nginx Rewrite 与 Location 的网页匹配

Nginx 的 location 匹配 与 rewrite 重写跳转

目录

前言

一、nginx中的 正则表达式