本篇文章主要对break,if,return,rewrite和set这5个指令的执行顺序进行深究,如需了解这5个指令的功能和配置,请参考另一篇文章 Nginx(三) 配置文件详解
由于文章篇幅较长,所以我就先把结论贴出来,再看测试结果。
1.server层执行完break指令后,该层级所有跟ngx_http_rewrite_module模块相关的指令都不再被执行,但不影响location层ngx_http_rewrite_module模块相关的指令执行;
2.location层执行完break指令后,会直接终止整个请求处理过程(后续其它指令也不再被执行),且请求不会被重定向,nginx根据最终请求路径(此时不再匹配location)将请求结果返回给客户端;
3.无论在哪个层级执行完return指令后,请求处理过程都会立刻终止并将指定的code、重定向URL、响应正文文本返回给客户端。
4.server层ngx_http_rewrite_module模块相关的指令是按照配置顺序依次执行;
说完结论后,我们再将原文3.3章节的所有知识结合起来一起做个测试。
基本配置如下
http {log_subrequest on; # 开启将子请求日志记录到access.log中log_format format2 escape=json '{''"SN":"$sn",' #自定义变量sn '"http_host":"$http_host",''"remote_addr":"$remote_addr",''"time_iso8601":"$time_iso8601",''"request":"$request",''"http_referer":"$http_referer",''"request_time":"$request_time",''"request_length":"$request_length",''"status":"$status",''"bytes_sent":"$bytes_sent",'#'"body_bytes_sent":"$body_bytes_sent",''"user_agent":"$http_user_agent",''}';access_log logs/access.log format2;absolute_redirect on;server_name_in_redirect off;port_in_redirect on;root pages; # 根目录设置为psges,该目录下只有index.html、test.html、one.html、two.html、three.htmlserver {listen 8688;server_name www.read*******.cn;root pages;# 下面配置本次测试的指令······}
}
测试1:
server {···break;rewrite /t1 /test.html;set $sn 1; # 该变量最终值将记录到access.log中。if ($sn = 1) {set $sn 2;break;set $sn 3;}return 500;location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 404 |
error.log日志输出 | *878 open() "/usr/local/nginx/pages/t1" failed (2: No such file or directory) |
access.log日志输出 | {"SN":"" |
最终请求地址 | host:8688/t1 |
结论 | 1.在请求重写指令未执行前就执行了break,导致server层级下所有跟ngx_http_rewrite_module模块相关的指令都不再执行,所以请求并未重写,请求路径不变。if、set、return指令都未执行。 2.location中未匹配到/t1,且pages文件夹下没有t1文件,所以返回404。 |
测试2:
server {···rewrite /t1 /test.html;set $sn 1; # 该变量最终值将记录到access.log中。if ($sn = 1) {set $sn 2;break;set $sn 3;}return 500;location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 200 |
error.log日志输出 | 无 |
access.log日志输出 | {"SN":"2" |
最终请求地址 | host:8688/test.html |
结论 | 请求被重写,执行完break后,"set $sn 3"和"return"指令未执行。 server层,ngx_http_rewrite_module 模块相关指令按照配置顺序依次执行。 server层执行break后,该层级所有跟ngx_http_rewrite_module模块相关的指令都不再执行。 |
测试3:
server {···rewrite /t1 /test.html;return 500;set $sn 1; # 该变量最终值将记录到access.log中。location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 500 |
error.log日志输出 | 无 |
access.log日志输出 | {"SN":"" |
最终请求地址 | |
结论 | server层执行完return后,请求处理过程会立刻终止,并将指定code返回给客户端。 |
测试4:
server {···rewrite /t1 /t2;rewrite /t2 /t3;set $sn 1; # 该变量最终值将记录到access.log中。if ($sn = 1) {set $sn 2;break;set $sn 3;}location /t2 {rewrite /t2 /test.html;}location /t3 {rewrite /t3 /t4;if ($sn = 2) {set $sn 31;rewrite /t4 /t5;break;set $sn 32;rewrite /t5 /t6;}set $sn 33;rewrite /t5 /p1;rewrite /t6 /p2;}location /t5 {set $sn 51;rewrite /t5 /p3;}location /t6 {set $sn 61;rewrite /t6 /p4;}location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 404 |
error.log日志输出 | *890 open() "/usr/local/nginx/pages/t5" failed (2: No such file or directory) |
access.log日志输出 | {"SN":"31" |
最终请求地址 | host:8688/t5 |
结论 | 1.server或location层ngx_http_rewrite_module模块相关的指令正常情况下按照配置顺序依次执行; 2.server层执行break后,该层级所有跟ngx_http_rewrite_module模块相关的指令都不再执行,但不影响location层ngx_http_rewrite_module模块相关指令的执行。 3.location层执行完break指令后,会直接终止整个请求处理过程(后续其它指令也不再被执行),且请求不会被重定向,nginx根据最终请求路径(此时不再匹配location)将请求结果返回给客户端。 |
测试5:
server {···rewrite /t1 /t2;rewrite /t2 /t3;set $sn 1; # 该变量最终值将记录到access.log中。if ($sn = 1) {set $sn 2;break;set $sn 3;}location /t2 {rewrite /t2 /test.html;}location /t3 {rewrite /t3 /t4;return 502;if ($sn = 2) {set $sn 31;rewrite /t4 /t5;break;set $sn 32;rewrite /t5 /t6;}set $sn 33;rewrite /t5 /p1;rewrite /t6 /p2;}location /t5 {set $sn 51;rewrite /t5 /p3;}location /t6 {set $sn 61;rewrite /t6 /p4;}location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 502 |
error.log日志输出 | 无 |
access.log日志输出 | {"SN":"2" |
最终请求地址 | |
结论 | location层执行完return后,请求处理过程会立刻终止,并将指定code返回给客户端。 |
测试6:
server {···rewrite /t1 /t2;rewrite /t2 /t3;set $sn 1; # 该变量最终值将记录到access.log中。if ($sn = 1) {set $sn 2;break;set $sn 3;}location /t2 {rewrite /t2 /test.html;}location /t3 {if ($sn = 2) {rewrite /t3 /p1;rewrite /p1 /t4;}if ($sn = 3) {return 500;}}location /t5 {rewrite /t5 /t6;}location /t4 {rewrite /t4 /t5;}location /t6 {set $sn 61;rewrite /t6 /p2;}location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 404 |
error.log日志输出 | *897 open() "/usr/local/nginx/pages/p2" failed (2: No such file or directory) |
access.log日志输出 | {"SN":"61" |
最终请求地址 | host:8688/p2 |
结论 | 1.server指令按序执行完毕后,根据URI匹配location,如果匹配到就进入对应location再按序执行该模块下的指令。执行完毕后,如果URI被重写就继续匹配location,直到找到最终请求路径。循环匹配location这个过程的循环次数不得超过10次。 |
测试7:
server {···rewrite /t1 /t2;rewrite /t2 /t3;set $sn 1; # 该变量最终值将记录到access.log中。if ($sn = 1) {set $sn 2;break;set $sn 3;}location /t2 {rewrite /t2 /test.html;}location /t3 {rewrite /t3 /t4;return 502;if ($sn = 2) {set $sn 31;rewrite /t4 /t5 last;break;set $sn 32;rewrite /t5 /t6;}set $sn 33;rewrite /t5 /p1;rewrite /t6 /p2;}location /t5 {set $sn 51;rewrite /t5 /p3;}location /t6 {set $sn 61;rewrite /t6 /p4;}location / {index index.html index.htm;}
}
请求地址 | host:8688/t1 |
请求结果 | 404 |
error.log日志输出 | *897 open() "/usr/local/nginx/pages/p3" failed (2: No such file or directory) |
access.log日志输出 | {"SN":"51" |
最终请求地址 | host:8688/p3 |
结论 |
请求地址 | host:8688/t1 |
请求结果 | |
error.log日志输出 | |
access.log日志输出 | {"SN":"" |
最终请求地址 | |
结论 |