Nginx(五) break，if，return，rewrite和set指令的执行顺序深究

已于 2023-11-18 14:16:36 修改
阅读量1.4k 收藏 1
点赞数 3
分类专栏： nginx 文章标签： nginx 服务器 linux
于 2023-11-15 20:25:24 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shendaisun/article/details/134428468
版权
本文深入探讨了 Nginx 中 break, if, return, rewrite 和 set 指令的执行顺序。在 server 层，指令按配置顺序执行，若执行 break 或 rewrite ... break/last 后会根据 URI 匹配 location。return 指令会立即结束请求处理并返回指定状态码和 URI。在 location 层，break 和 rewrite ... break 会终止当前 location 的重写循环，而 rewrite ... last 则会立即匹配下一个 location。循环重写不超过 10 次，超过会引发 500 错误。" 87868825,8180645,C#与AutoCAD二次开发实战,"['C#编程', 'AutoCAD开发', '二次开发', 'ObjectARX', '数据库扩展']
摘要由CSDN通过智能技术生成

       本篇文章主要对break，if，return，rewrite和set这5个指令的执行顺序进行深究，如需了解这5个指令的功能和配置，请参考另一篇文章 Nginx(三) 配置文件详解

最终结论

        由于文章篇幅较长，所以我就先把结论贴出来，再看测试结果。

        1.server层ngx_http_rewrite_module模块相关指令按照配置顺序依次执行；

        2.server层执行完break指令后，该层级所有跟ngx_http_rewrite_module模块相关的指令都不再被执行，但不影响location层ngx_http_rewrite_module模块相关指令的继续执行，所以请求处理过程会继续向下；

        3.location层执行完break指令后，当前server所有层级跟ngx_http_rewrite_module模块相关的指令都不再被执行（换言之就是，最终URI就这吧，别再找了），nginx根据最终请求路径将请求结果返回给客户端；

        4.无论在哪个层级执行完return指令后，请求处理过程都会立刻终止并将指定的code、重定向URL或响应正文文本返回给客户端。

        5.虽然Nginx在循环重写过程中最多是可以执行11次循环，但在第11次循环中执行rewrite后会抛500异常，所以严格意义上来说，正常情况下Nginx请求重写循环过程最多就是10次。强烈建议亲自做下测试10。

        6.rewrite regex /xxx break指令与单独break指令的中断效果一样，只是执行完重写后再执行中断，类似于先执行rewrite regex /xxx，再执行break。

        7.rewrite regex /xxx last指令是执行完重写后，立即开始(下一轮)匹配location，server层或当前location层其它指令不再执行。

执行顺序

        说完上面的结论后，我们再来重新总结下break，if，return，rewrite和set这5个指令的执行顺序，总体分为两大步骤。

        第一步：按序执行。server层按照配置循序依次执行，请求该重写重写，且无次数限制。server层指令按序执行完毕后进入第二步，根据URI匹配location，开始请求重写循环。在此过程中，如果server层执行了return指令，请求处理过程立刻终止并将指定code和URI或正文返回给客户端；如果server层执行了break或rewrite regex /xxx break/last指令，立即结束第一步，根据URI匹配location，开始请求重写循环。

        第二步：循环执行。根据第一步确认的URI去匹配location，匹配到location后，进入到对应的location中按序执行该模块下的指令。如果请求又被重写，则再匹配location，循环执行上述任务（循环过程不能超过10次），直到找到最终URI。最后再根据最终URI处理请求并将结果返回给客户端。在此过程中，如果执行了return指令，请求处理过程立刻终止并将指定code和URI或正文返回给客户端；如果执行了break或rewrite regex /xxx break指令，循环终止，根据最后一次重写的URI处理请求并将结果返回给客户端；如果执行了rewrite regex /xxx last指令，会立即开始匹配下一个location，当前location下的其它指令不再被执行。

说完结论和执行顺序后，我们再将原文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",'
				      '}';
    
    absolute_redirect on;
    server_name_in_redirect off;
    port_in_redirect on; 
    
    server {
        listen 8688;
        server_name www.read*********.cn;
        access_log  logs/access.log  format2;
        error_log  logs/error.log  notice;	# 将error_log日志级别修改为notice，否则rewrite log无法记录。
        rewrite_log on;    # 开启记录请求重写日志，默认是关闭
        root pages;     # 根目录设置为psges，该目录下有index.html、test.html、one.html、two.html、three.html
        # 下面配置本次测试的指令
        ···
        ···

    }
}

测试1：server层rewrite前被break

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前被return

server {
    ···

    return 500;
    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
请求结果 500

error.log

日志输出

 无

access.log

日志输出

 {"SN":""
最终地址
结论 server层rewrite前return被执行后，请求处理过程立刻终止，并将指定code返回给客户端。

测试3：server层rewrite完被break

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模块相关的指令都不再执行。

 
2023/11/17 23:36:31 [notice] 11070#11070: *169 "/t1" matches "/t1", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:36:31 [notice] 11070#11070: *169 rewritten data: "/test.html", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"

测试4：server层rewrite完被return

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层rewrite完return被执行后，请求处理过程立刻终止，并将指定code返回给客户端。 
2023/11/17 23:38:45 [notice] 11140#11140: *172 "/t1" matches "/t1", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:38:45 [notice] 11140#11140: *172 rewritten data: "/test.html", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:38:45 [warn] 11140#11140: *172 using uninitialized "sn" variable while logging request, client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"

测试5：location层rewrite完被break

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

日志输出

 *173 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指令后，请求重写循环过程结束，break执行前确认的URI就是最终URI，nginx根据最终地址处理请求并结果返回给客户端。

 
2023/11/17 23:40:19 [notice] 11208#11208: *173 "/t1" matches "/t1", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 rewritten data: "/t2", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 "/t2" matches "/t2", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 rewritten data: "/t3", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 "/t3" matches "/t3", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 rewritten data: "/t4", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 "/t4" matches "/t4", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [notice] 11208#11208: *173 rewritten data: "/t5", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:40:19 [error] 11208#11208: *173 open() "/usr/local/nginx/pages/t5" failed (2: No such file or directory), client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"

测试6：location层rewrite完被return

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层rewrite完return被执行后，请求处理过程会立刻终止，并将指定code返回给客户端。 
2023/11/17 23:42:08 [notice] 11282#11282: *174 "/t1" matches "/t1", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:42:08 [notice] 11282#11282: *174 rewritten data: "/t2", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:42:08 [notice] 11282#11282: *174 "/t2" matches "/t2", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:42:08 [notice] 11282#11282: *174 rewritten data: "/t3", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:42:08 [notice] 11282#11282: *174 "/t3" matches "/t3", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"
2023/11/17 23:42:08 [notice] 11282#11282: *174 rewritten data: "/t4", args: "", client: 14.145.163.156, server: www.read*********.cn, request: "GET /t1 HTTP/1.1", host: "www.read*********.cn:8688"

测试7：location层rewrite前被break

server {
    ···

    set $sn 1;    
    rewrite /t0 /t1;
    break;
    rewrite /t1 /p1;
    location /t1 {
        set $sn 11;
        rewrite /t1 /t2;
    }
    location /t2 {
        set $sn 22;
        break;
        rewrite /t2 /t3;
    }
    location /t3 {
        set $sn 33;
        rewrite /t3 /test.html;
    }
    location /p1 {
        set $sn 500;
        return 500;
    }
    location / {
        index  index.html index.htm;
    }
}
最低0.47元/天 解锁文章
Eisen戴
关注
专栏目录
Nginx【Nginx核心指令(rewrite指令、实战rewrite 、if指令、set和break指令】(六)-全面详解（学习总结---从入门到深化）
07-03 688
Nginx【Nginx核心指令(rewrite指令、实战rewrite 、if指令、set和break指令】(六)-全面详解（学习总结---从入门到深化）
Nginx(8)_return和rewrite
renzhongrui的博客
01-18 3902
停止处理请求，直接返回响应码或重定向到其他URL；执行return指令后，location中后续指令将不会被执行
Nginx中return和rewrite的区别
最新发布
qq_43038960的博客
09-16 647
rewrite用于修改请求 URI，并将请求重定向到另一个地址，通常用于URL重写或内部转发。rewrite：重写请求的 URI，并根据新的 URI 重新进行一次请求。如果只是简单的重定向需求，推荐使用 return，而如果需要更复杂的 URI 重写逻辑，则可以使用 rewrite。return 比 rewrite 更高效，因为它在 Nginx 的内部进行处理，不会引起额外的请求-响应往返。在Nginx中，return和rewrite都用于重定向请求，但还是有区别，写法也不一样。
Nginx 配置指令的执行顺序（六）
weixin_34390996的博客
12-18 249
前面我们在 （五） 中提到，在一个 location 中使用 content 阶段指令时，通常情况下就是对应的 Nginx 模块注册该 location 中的“内容处理程序”。那么当一个 location 中未使用任何 content 阶段的指令，即没有模块注册“内容处理程序”时，content 阶段会发生什么事情呢？谁又来担负起生成内容和输出响应的重担呢？答案就是那些把当前请求的 URI 映射到...
Nginx的rewrite之break指令
weixin_54048131的博客
07-08 546
它最终重定向到了locatio 就是这个位置的/testbreak路径下的index.html页面，由于Ngnix中有一些默认的配置，root没有配，它会从当前文件的html文件进行寻找，index没有配，会找当前目录下的index.html。与该指令处于同 一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指 令配置无效。在break的配置中，出于break前面的内容还可以生效，break后面的内容，会失效。出错的原因是终止了当前匹配的所有结果，break下面的内容都不执行了。
nginx配置指令的执行顺序
anker_dream1的博客
05-09 739
Nginx 的请求处理阶段共有11个:post-readserver-rewrite ngx_rewrite 模块的配置指令直接书写在 server 配置块中时，基本上都是运行在 server-rewrite 阶段find-config 完成了当前请求与 location 的配对。在此阶段之前，请求并没有与任何 location 配置块相关联rewrite set, ngx_set_misc 的 ...
Nginx的rewrite之set指令
Leon_Jinhai_Sun的博客
11-02 932
set指令 该指令用来设置一个新的变量。 语法 set $variable value; 默认值 — 位置 server、location、if variable:变量的名称，该变量名称要用"$"作为变量的第一个字符，且不能与Nginx服务器预设的全局变量同名。 value:变量的值，可以是字符串、其他变量或者变量的组合等。 Rewrite常用全局变量 变量 说明 $args 变量中存放了请求URL中的请求指令。比如http://192.168.200
Nginx地址重定向 return rewrite if
bjgaocp的博客
03-24 3124
return指令 该指令用于结束规则的执行并返回状态码给客户端。 示例：如果访问的URL以".sh"或".bash"结尾，则返回403状态码 location ~ .*.(sh|bash)?$ { return 403; } rewrite 指令 使用nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向 rewrite 语法格式 rewrite regex（正则...
Nginx关于Rewrite执行顺序详解.docx
03-27
总结来说，理解Nginx Rewrite模块的执行顺序对于优化和调试Nginx配置至关重要。正确地编写和组织Rewrite规则可以确保Nginx服务器高效、稳定地处理各种URL请求。在实际应用中，要特别注意避免重写规则引起的循环和...
Nginx：rewrite指令(break,last,redirect,permanent)
Yummy的博客
04-19 1046
rewite指令 在 server 块下，会优先执行 rewrite 部分，然后才会去匹配 location 块。因为 server 块中 rewrite 的 break 和 last 没什么区别，执行完后都会再去匹配 location，所以 server 块中的 rewrite 标志可以留空，不需要用 last 再发起新的请求。 location中的rewirte： 不写 last 和 break，那么流程就是依次执行这些 rewrite。 1. rewrite break: url 重写后，直接
nginx里的break和last
成长的日子
11-20 586
break和last是nginx的rewrite_module里的指令，tengine翻译的文档里对这两个的指令解释是：   last停止执行当前这一轮的ngx_http_rewrite_module指令集，然后查找匹配改变后URI的新location；break停止执行当前这一轮的ngx_http_rewrite_module指令集；     就我所知，这两个指令都可以用来实现内部重定...
Nginx break指令怎么用？
Blue92120的博客
02-13 540
break指令该指令用于中断当前相同作用域中的其他Nginx配置。与该指令处于同一作用域的Nginx配置中，位于它前面的指令配置生效，位于后面的指令配置无效。并且break还有另外一个功能就是终止当前的匹配并把当前的URI在本location进行重定向访问处理。
Nginx 介绍，以及Nginx配置指令执行的顺序 11 个阶段
zzhongcy的专栏
01-08 3169
Nginx的产生 没有听过Nginx？那么一定听过它的"同行"Apache吧！Nginx同Apache一样都是一种WEB服务器。基于REST架构风格，以统一资源描述符(Uniform Resources Identifier)URI或者统一资源定位符(Uniform Resources Locator)URL作为沟通依据，通过HTTP协议提供各种网络服务。 ...
Nginx配置指令的执行顺序
baidu1966的博客
09-10 379
Nginx指令顺序：set与echo location /test { set $a 32; echo $a; set $a 56; echo $a; } # set 指令就是在 rewrite 阶段运行的，而 echo 指令就只会在 content 阶段运行 # rewrite 阶段总是在 content 阶段之前执行 #结果server-r...
nginx rewrite break last
alexgaoyihang的专栏
03-06 803
网友的给力解释： last：     重新将rewrite后的地址在server标签中执行 break：     将rewrite后的地址在当前location标签中执行 nginx官方解释：last：    stops processing the current set of ngx_http_rewrite_module directives followed by a searc
Nginx 配置指令的执行顺序（十）
weixin_34301132的博客
12-18 131
运行在 post-rewrite 阶段之后的是所谓的 preaccess 阶段。该阶段在 access 阶段之前执行，故名preaccess.       标准模块 ngx_limit_req 和 ngx_limit_zone 就运行在此阶段，前者可以控制请求的访问频度，而后者可以限制访问的并发度。这里我们仅仅和它们打个照面，后面还会有机会专门接触到这两个模块。       前面反复提到的...
nginx之if、break、last、return、rewrite规则语法
qq_37369726的博客
10-29 3512
nginx安装路径： /usr/local/nginx 虚拟主机所在路径： /usr/local/nginx/conf/vhost/ 接下来开始实验： 一.if nginx的if不支持嵌套、&&和|| 逻辑判断符号有： =，!=, ~, ~*(忽略大小写匹配），！~(不匹配），！~* !表示相反的意思，*表示忽略大小写。 例如： 访问www.1.com的域名，返回状态码403。 s...
Nginx 实战 day-36 (1.12 nginx的rewrite配置-if, nginx中的break和last, nginx中的return用法, 1.15 rewrite规则语法)
u011192615的博客
10-29 317
1.12 nginx的rewrite配置-if 1.13 rewrite中的break和last. 新建一个虚拟主机 vim www.1.com.conf 更改配置文件error_log级别 1.html 里面为11111 2.html 里面为22222 3.html 里面为33333 cutl测试打开1html，转到3.html 因为...
agentzh的Nginx教程系列：深入变量与指令执行顺序详解
此外，教程还涉及Nginx指令执行顺序的探讨，作者以实际案例阐述了不同指令的执行优先级，这对于理解Nginx配置的逻辑至关重要。 教程的前言部分，agentzh分享了自己在Nginx领域的长期经验，以及撰写此类教程的初衷。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值