目录
一、理论
1.Nginx正则表达式
2.location匹配
3.rewrite重写
二、实验
1.基于域名的跳转
2.基于客户端 IP访问跳转
3.基于旧域名跳转到新域名后面加目录
4.基于参数匹配的跳转
5.基于目录下所有 php结尾的文件跳转
6.基于最普通一条url请求的跳转
三、总结
一、理论
1.Nginx正则表达式
(1)元字符及说明
^ :匹配输入字符串的起始位置
$ :匹配输入字符串的结束位置
* :匹配前面的字符零次或多次。如“ab*”能匹配“a”及“ab”、“abb”
+ :匹配前面的字符一次或多次。如“ab+”能匹配“ab”及“abb”、“abbb”,但不能匹配“a”
? :匹配前面的字符零次或一次,例如“ab(cd)?”能匹配“ab”或者“abcd”,”?”等效于”{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] :匹配所有大小写字母或数字
() :表达式的开始和结束位置
| :或运算符
2.location匹配
(1)概念
在Nginx定义的每一个server中,还可以定义多个不同的location。这些不同的location根据请求中的URI的不同对HTTP请求进一步细分,提供不同的处理方法和服务。比如,根据请求中的URI不同,对于有些服务Nginx可以通过提供本地静态文件,而对于另外的动态内容请求可以转发到另外的动态服务进程中。
在实际的成产环境中,一个server 中可以定义非常多的location。而且在定义location时,不同的前缀可以对匹配的结果产生不同影响。如何正确地配置生产环境中总多location就变成一项很复杂的任务。
(2)分类
location可分为三类:
表1 location分类
类别 | 代码 |
精准匹配 | location = / {…} |
一般匹配 | location / {…} |
正则匹配 | location ~ / {…} |
(3)常用匹配规则
表2 常用匹配规则
规则 | 描述 |
= | 进行普通字符精确匹配,也就是完全匹配 |
^~ | 表示普通字符匹配。使用前缀匹配。如果匹配成功,则不再匹配其它 location |
~ | 区分大小写的匹配 |
~* | 不区分大小写的匹配 |
!~ | 区分大小写的匹配取非 |
!~* | 不区分大小写的匹配取非 |
(4)匹配优先级
表3 匹配优先级
优先级 | 匹配 |
1 | 精确匹配 = |
2 | 前缀匹配 ^~ |
3 | 按文件中顺序的正则匹配 ~或~* |
4 | 匹配不带任何修饰的前缀匹配(一般匹配) |
5 | 交给 / 通用匹配 |
(5)匹配流程
location匹配的核心原则,是最长匹配,具体流程是:
表4 匹配流程
流程顺序 | 具体流程 |
1 | 先对前缀location执行最长前缀匹配。 |
2 | 若最长前缀location前携带有=或者^~,那么使用此location配置块处理请求,不再进行正则匹配。对于=前缀,要求完全相等,对于^~前缀,只有最长匹配前有^~符号,才能跳过正则表达式。 |
3 | 按server{ }中正则表达式的出现顺序,依次匹配。成功后就选中此location。正则表达式的查找是按照在配置文件中的顺序进行的。因此正则的顺序很重要,建议越精细的放的越靠前。 |
4 | 若所有正则表达式皆未匹配上,则使用第1步中检索出的最长前缀location处理请求。 |
5 | 如果在第1步中也没有匹配到最长location,则返回404。 |
(6)匹配应用
表5 匹配应用说明
配置文件 | 匹配过程 |
| 请求/精准匹配A,不再往下查找。 |
| 请求/index.html匹配B。首先查找匹配的前缀字符,找到最长匹配是配置B,接着又按照顺序查找匹配的正则。结果没有找到,因此使用先前标记的最长匹配,即配置B。 |
请求/documents/about.html匹配B。因为B表示任何以/开头的URL都匹配。在上面的配置中,只有B能满足,所以匹配B。 | |
| 请求/user/index.html匹配C。首先找到最长匹配C,由于后面没有匹配的正则,所以使用最长匹配C。 |
| 请求/images/1.jpg匹配D。首先进行前缀字符的查找,找到最长匹配D。但是,特殊的是它使用了^~修饰符,不再进行接下来的正则的匹配查找,因此使用D。这里,如果没有前面的修饰符,其实最终的匹配是E。 |
| 请求/user/1.jpg匹配E。首先进行前缀字符的查找,找到最长匹配项C,继续进行正则查找,找到匹配项E。因此使用E。 |
(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 相比,正则优先级更高
(7)匹配规则定义
实际网站使用中,至少有三个匹配规则定义:
① 直接匹配网站根,通过域名访问网站首页比较频繁,使用这个会加速处理,比如说官网。 这里是直接转发给后端应用服务器了,也可以是一个静态首页。
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;
}
(8)数据结构
与location匹配相关的数据结构有:ngx_http_core_loc_conf_s,ngx_listening_t, ngx_http_port_t, ngx_http_in_addr_t, ngx_http_addr_conf_t, ngx_http_server_name_t, ngx_http_conf_port_t, ngx_http_conf_addr_t, ngx_http_request_t, ngx_http_connection_t,ngx_http_location_queue_t等。它们的关联关系如下图所示:
结构体 | 功能 |
ngx_http_core_loc_conf_s | ngx_http_core_loc_conf_s结构对应一个location块的配置,结构中的named, noname, exact_match和noregex flag用来区分location定义中的几个修饰符。 |
ngx_http_location_queue_t | 结构体ngx_http_location_queue_t用于临时保存location的队列。其中如果location是exact_match, regex, named或者noname类型的,则会把location结构存放到exact成员变量中。如果是非exact类型,则存放到inclusive变量中。 |
(9)源码分析
与配置平面有关的逻辑就是解析location指令并且构建用于查找的URI数据结构。
指令location的解释函数是ngx_http_core_location。
函数流程为:
流程顺序 | 流程内容 |
1 | 完整性检测,比如判断locations queue是否为空,如果是空则直接返回。 |
2 | 因为location可以嵌套,所以,函数ngx_http_init_locations递归调用,去处理嵌套情况。 |
3 | 调用ngx_http_join_exact_locations把location queue中将当前虚拟主机中 URI字符串完全一致的exact 和inclusive 类型的location 进行合并。 |
4 | 调用ngx_http_create_locations_list把locations queue变成locations list。如下图所示就是ngx_http_create_locations_list调用前后的效果。 |
调用函数ngx_http_create_locations_tree,在上述创建的list的基础上,进一步生成查找树。首先确定locaiton队列的中间节点,然后从中间节点把location分成两部分。分别再构造左右子树。最后把inclusive类型的location放入到成员tree中。
ngx-location-create-locations-tree调用前后的效果:
3.rewrite重写
(1)概念
rewrite功能就是使用nginx提供的全局变量或自己设置的变量,结合正则表达式和标记实现URL重写以及重定向。
rewrite只能放在server{},location{},if{}中,并且默认只能对域名后面的除去传递的参数外的字符串起作用。
(2)rewrite 跳转场景
① URL看起来更规范、合理;
② 企业会将动态URL地址伪装成静态地址提供服务;
③ 网址换新域名后,让旧的访问跳转到新的域名上;
④ 服务端某些业务调整。
备注:
URL是一个具体路径/位置;
URI是一个拥有相同类型/特性的对象集合;
URN用名称定位。
(3)rewrite 跳转实现
原理图:
(4)rewrite 实际场景
(5)rewrite正则表达式
(6)rewrite语法格式
rewrite <regex> <replacement> [flag];
(7)rewrite执行顺序
① 执行server块里面的rewrite指令
② 执行location匹配
③ 执行选定的location中的rewrite指令
(8)flag标记说明
表4 flag标记说明
标记 | 说明 |
last | 本条规则匹配完成后,继续向下匹配新的location URI规则,一般用在 server 和 if 中 |
break | 本条规则匹配完成即终止,不再匹配后面的任何规则,一般使用在 location 中 |
redirect | 返回302临时重定向,浏览器地址会显示跳转后的URL地址 |
permanent | 返回301永久重定向,浏览器地址栏会显示跳转后的URL地址 |
(9)rewrite和location比较
从功能看 rewrite 和 location 似乎有点像,都能实现跳转,主要区别于rewrite是在同一域名内更改获取资源的路径,而 loction 是对一类路径做控制访问或反向代理,还可以proxy_pass到其他机器。
二、实验
1.基于域名的跳转
公司旧域名www.david.com有业务需求变更,需要使用新域名www.jack.com代替,但是旧域名不能废除,需要跳转到新域名上,而且后面的参数保持不变。
vim /usr/local/nginx/conf/nginx.conf
server {
listen 80;
server_name www.david.com; #域名修改
charset utf-8;
access_log /var/log/nginx/www.david.com.access.log; #日志修改
location / {
#添加域名重定向
if ($host = 'www.david.com'){ #$host为rewrite全局变量,代表请求主机头字段或主机名
rewrite ^/(.*)$ http://www.jack.com/$1 permanent; #$1为正则匹配的内容,即域名后边的字符串
}
root html;
index index.html index.htm;
}
}
2.基于客户端 IP访问跳转
公司业务新版本上线,要求所有 IP 访问都显示一个固定维护页面,只有公司 IP :192.168.204.200访问正常。
vim /usr/local/nginx/conf/nginx.conf
server {
listen 80;
server_name www.david.com; #域名修改
charset utf-8;
access_log /var/log/nginx/www.david.com-access.log main; #日志修改
#设置是否合法的IP标记
set $rewrite true; #设置变量$rewrite,变量值为boole值true
#判断是否为合法IP
if ($remote_addr = "192.168.204.200"){ #当客户端IP为192.168.204.150时,将变量值设为false,不进行重写
set $rewrite false;
}
#除了合法IP,其它都是非法IP,进行重写跳转维护页面
if ($rewrite = true){ #当变量值为true时,进行重写
rewrite (.+) /weihu.html; #重写在访问IP后边插入/weihu.html
}
location = /weihu.html {
root /var/www/html; #网页返回/var/www/html/weihu.html的内容
}
location / {
root html;
index index.html index.htm;
}
}
3.基于旧域名跳转到新域名后面加目录
访问 http://www.david.com,现在需要将这个域名下面的访问都跳转到http://www.david.com/center
vim /usr/local/nginx/conf/nginx.conf
server {
listen 80;
server_name www.david.com; #域名修改
charset utf-8;
access_log /var/log/nginx/david.com-access.log;
#添加
location /post {
rewrite (.+) http://www.jack.com/mcure$1 permanent; #这里的$1为位置变量,代表/post
}
location / {
root html;
index index.html index.htm;
}
}
4.基于参数匹配的跳转
vim /usr/local/nginx/conf/nginx.conf
server {
listen 80;
server_name www.david.com; #域名修改
charset utf-8;
access_log /var/log/nginx/david.com-access.log main;
if ($request_uri ~ ^/100-(100|200)-(\d+).html$) {
rewrite (.+) http://www.david.com permanent;
}
location / {
root html;
index index.html index.htm;
}
}
5.基于目录下所有 php结尾的文件跳转
vim /usr/local/nginx/conf/nginx.conf
server {
listen 80;
server_name www.david.com; #域名修改
charset utf-8;
access_log /var/log/nginx/david.com-access.log main;
location ~* /upload/.*\.php$ {
rewrite (.+) http://www.david.com permanent;
}
location / {
root html;
index index.html index.htm;
}
}
6.基于最普通一条url请求的跳转
vim /usr/local/nginx/conf/nginx.conf
server {
listen 80;
server_name www.david.com; #域名修改
charset utf-8;
access_log /var/log/nginx/david.com-access.log main;
location ~* ^/abc/123.html {
rewrite (.+) http://david.com permanent;
}
location / {
root html;
index index.html index.htm;
}
}
三、总结
匹配server和location是Nginx进行请求转发的核心过程。把某一个请求正确匹配到server和location以后,就可以通过server和location的配置开始对此请求开始服务了。对于location的匹配,为了提高匹配效率,Nginx把正则表达式和非正则表达式配置的location进行了区分,并且把非正则表达式组织成了多叉树,把正则表达式组织成了list。对于前者,匹配的原则是最长匹配,而对于后者是采用优先匹配,也就是第一个匹配到的就是匹配结果。
匹配优先级总结: (location =) > (location 完整路径) > (location ^~ 路径) > (location ~,~* 正则顺序) > (location 部分起始路径) > (location /)