nginx rewrite/return用法

时间: 2019-10-28来源：OSCHINA

前景提要

来源： https://blog.csdn.net/Powerful_Fy
rewrite在if中的用法
格式：if (条件判断) { 具体的rewrite规则 } if条件判断语句由Nginx内置变量、逻辑判断符号和目标字符串三部分组成。其中，内置变量是Nginx固定的非自定义的变量，如，$request_method, $request_uri等。逻辑判断符号，有=, !=, ~, ~*, !~, !~* !表示相反的意思，~为匹配符号，它右侧为正则表达式，区分大小写，而~*为不区分大小写匹配。目标字符串可以是正则表达式，通常不用加引号，但表达式中有特殊符号时，比如空格、花括号、分号等，需要用单引号引起来。
示例1：当http请求方法为post时，返回403状态码 if ($request_method = POST) { return 403; }
示例2：通过浏览器标识匹配关键字，禁止IE浏览器访问 if ($http_user_agent ~* MSIE) { return 403; }
限制多个浏览器： if ($http_user_agent ~* "MSIE|firefox|Chrome") { return 403; }
示例3：当请求的文件不存在时，进行重定向或return状态码等处理操作 if(!-f $request_filename) { rewrite 语句; }
示例4：判断uri中某个参数的内容 if($request_uri ~* 'gid=\d{6,8}/') { rewrite 语句; }
#\d表示数字，{6,8}表示数字出现的次数是6到8次，当uri中gid参数的值包含6-8个数字那么执行rewrite语句
rewrite中break和last的用法
两个指令用法相同，但含义不同，需要放到rewrite规则的末尾，用来控制重写后的链接是否继续被nginx配置执行(主要是rewrite、return指令)。
1.break和last在location{}外部时
测试示例： server{ listen 80; server_name test.com; root /data/wwwroot/test.com; rewrite /1.html /2.html; rewrite /2.html /3.html; }
#请求1.html文件时，会被重定向到2.html，然后被重定向到3.html，最后返回的文件为3.html
示例1：在rewrite 指令后面添加break server{ listen 80; server_name test.com; root /data/wwwroot/test.com; rewrite /1.html /2.html break; rewrite /2.html /3.html; }
#请求1.html文件时，会被重定向到2.html，然后直接返回2.html，break在此处的作用就是当匹配第一个rewrite指令成功时，不执行后面的rewrite指令
示例2：当break后面还有location{}的情况 server{ listen 80; server_name test.com; root /data/wwwroot/test.com; rewrite /1.html /2.html break; rewrite /2.html /3.html; location /2.html { return 403; } }
#请求1.html文件时，会返回403状态码，当1.html被重定向到2.html时，break不会匹配后面的rewrite规则，但条件2.html匹配location{}定义的文件2.html，所以会执行return 403
#以上两个示例中，将break换成last效果一样
2.break和last在location{}内部时
测试示例： server{ listen 80; server_name test.com; root /data/wwwroot/test.com; location / { rewrite /1.html /2.html; rewrite /2.html /3.html; } location /2.html { rewrite /2.html /a.html; } location /3.html { rewrite /3.html /b.html; } }
#请求1.html，会经过两次重定向到3.html，3.html又刚好匹配location /3.html{}，所以返回b.html，当请求2.html时，会直接返回a.html，因为location /2.html {} 更精准，优先匹配
示例1：在rewrite后面添加break server{ listen 80; server_name test.com; root /data/wwwroot/test.com; location / { rewrite /1.html /2.html break; rewrite /2.html /3.html; } location /2.html { rewrite /2.html /a.html; } location /3.html { rewrite /3.html /b.html; } }
#请求1.html，会返回2.html，不会返回a.html，当break再location {} 内部时，遇到break后，当前location{} 以及后面的location{} 的指令都不再执行
示例2：在rewrite后面添加last server{ listen 80; server_name test.com; root /data/wwwroot/test.com; location / { rewrite /1.html /2.html last; rewrite /2.html /3.html; } location /2.html { rewrite /2.html /a.html; } location /3.html { rewrite /3.html /b.html; } }
#请求1.html时，会返回a.html，在location {} 内部遇到last，当前location {}中剩下的指令不会再执行，但被重定向的url会重新匹配一遍location {}
3.break和last用法总结
1.当rewrite规则在location{}外，break和last作用一样，遇到break或last后，其后续的rewrite/return语句不再执行。但后续有location{}的话，还会近一步执行location{}里面的语句,前提是请求能匹配该location 2.当rewrite规则在location{}里，遇到break后，本location{}与其他location{}的所有rewrite/return规则都不再执行 3.当rewrite规则在location{}里，遇到last后，本location{}里后续rewrite/return规则不执行，但重写后的url再次从头匹配所有location
return的用法
该指令一般用于对请求的客户端直接返回响应状态码。在该作用域内return后面的所有nginx配置都是无效的，可以使用在server、location以及if配置中，除了支持跟状态码，还可以跟字符串或者url链接。
示例1：直接返回状态码 server{ listen 80; server_name www.test.com; return 403; rewrite www.test.net; }
#访问时，直接返回403状态码，return返回内容后，后面的配置rewrite不会执行
示例2：当return在if 判断中时 server { ..... if ($request_uri ~ "\.password|\.bak") { return 404; rewrite /(.*) /index.html; } ..... }
#请求的文件包含.password或.bak时，直接返回404，rewrite不会执行，但if {}外的配置会继续执行，return只在当前作用域中生效
示例3：返回字符串 server{ listen 80; server_name www.test.com; return 200 "hello"; }
#返回字符串必须加上状态码，否则会报错
示例4：返回nginx变量 location /1.html { return 200 "$host $request_uri"; }
示例5：返回url server{ listen 80; server_name www.test.com; return http://www.test.com/index2.html; }
#返回url时，必须以 http://或https://开头
示例6：返回html代码 if ($http_referer ~ 'baidu.com') { return 200 "<html><script>window.location.href='//$host$request_uri';</script></html>"; }
#当网站被黑了的时候，从百度点进网站是链接都会跳转到其他网站，可以使用该方法暂时处理 #注意：return http://$host$request_uri ; 在浏览器中会提示"重定向的次数过多"
rewrite的语法规则
格式：rewrite regex replacement [flag]
rewrite 配置可以在server、location以及if配置段内生效
regex 是用于匹配URI的正则表达式，其不会匹配到$host（域名）
replacement 是目标跳转的URI，可以以 http://或者https://开头，也可以省略掉$host，直接写$request_uri部分
flag 用来设置rewrite对URI的处理行为，其中有break、last、rediect、permanent，其中break和last在前面已经介绍过，rediect和permanent的区别在于，前者为临时重定向(302)，而后者是永久重定向(301)，对于用户通过浏览器访问，这两者的效果是一致的。但是，对于搜索引擎爬虫来说就有区别了，使用301更有利于SEO。所以，建议replacemnet是以 http://或者https://开头的，flag使用permanent。
示例1：域名跳转 location / { rewrite /(.*) http://www.test.com/$1 permanent; }
# .*为正则表达式，表示uri，用()括起来，在后面的uri中可以调用它，第一次出现的()用$1调用，第二次出现的()用$2调用，以此类推。
示例2：域名跳转的第二种写法 location / { rewrite /.* http://www.test.com$request_uri permanent; }
示例3：文件跳转 server{ listen 80; server_name www.test.com; root /data/wwwroot/test.com; index index.html; if ($request_uri !~ '^/web/') { rewrite /(.*) /web/$1 redirect; } }
#将uri请求的文件重定向到web/目录中去寻找
错误写法1： server{ listen 80; server_name www.test.com; root /data/wwwroot/test.com; index index.html; rewrite /(.*) /web/$1 redirect; }
#这样写会反复循环，直到浏览器最大循环限制次数，哪怕uri包含web/目录了，也会继续重定向/web/web/$1
错误写法2： server{ listen 80; server_name www.test.com; root /data/wwwroot/test.com; index index.html; rewrite /(.*) /web/$1 break; }
#添加break后不会导致循环，但如果uri中包含web/目录的情况下也会被重定向一次，重定向后的uri就是web/web/$1