nginx之rewrite相关功能

Posted 2020-11-23 An.amazing.rookie

nginx Rewrite相关功能

Nginx服务器利用ngx_http_rewrite_module 模块解析和处理rewrite请求，此功能依靠 PCRE(perl compatible regular expression)，因此编译之前要安装PCRE库，nginx的正则表达式底层依赖于PCRE库，PCRE是用perl语言写的；rewrite是nginx服务器的重要功能之一，用于实现URL的重写，URL的重写是非常有用的功能，比如它可以在我们改变网站结构之后，不需要客户端修改原来的书签，也无需其他网站修改我们的链接，就可以设置为访问，另外还可以在一定程度上提高网站的安全性。

if指令

用于条件匹配判断，并根据条件判断结果选择不同的Nginx配置，可以配置在server或location块中进行配置，Nginx的if语法仅能使用if做单次判断，不支持使用if else或者if elif这样的多重判断，用法如下：
if （条件匹配） { 
action
}

使用正则表达式对变量进行匹配，匹配成功时if指令认为条件为true，否则认为false，变量与表达式之间使用以下符号链接：
=： #比较变量和字符串是否相等，相等时if指令认为该条件为true，反之为false。
!=: #比较变量和字符串是否不相等，不相等时if指令认为条件为true，反之为false。
~： #表示在匹配过程中区分大小写字符，（可以通过正则表达式匹配），满足匹配条件为真，不满足为假。
!~：#为区分大小写字符且匹配结果不匹配，不满足为真，满足为假。
~*: #表示在匹配过程中不区分大小写字符，（可以通过正则表达式匹配），满足匹配条件为真，不满足为假。
!~*: #为不区分大小字符且匹配结果不匹配，满足为假，不满足为真。
-f 和 !-f: #判断请求的文件是否存在和是否不存在
-d 和 !-d: #判断请求的目录是否存在和是否不存在。
-x 和 !-x: #判断文件是否可执行和是否不可执行。
-e 和 !-e: #判断请求的文件或目录是否存在和是否不存在(包括文件，目录，软链接)。

示例：
location / {
       root /data/nginx/pc/html;
       index index.html;
       if ( $scheme = http ) {       #如果协议是http则打印http
          echo "if---->$scheme";
       }
       if ( $scheme = https ) {     #如果协议是https，则打印https
          echo "if---->$scheme";
       }
       if ( -f $request_filename ) {    #如果请求的/下的资源存在，则访问/下所请求的资源；这个示例只能判断/下的index.html
           root /data/nginx/pc/html;
       }
       if ( !-f $request_filename ) {    #如果请求的/下的资源不存在，则打印不存在
           echo "not exists";
       }
   }
第一个if成立会判断第二个if，直到判断完所有的if；如果第二个if的值也成立，就执行第二个if，会把第一个if覆盖，相当于第一个if没有执行，以此类推直到最后

注： 如果$变量的值为空字符串或是以0开头的任意字符串，则if指令认为该条件为false，其他条件为true。

set指令

location / {
  set $name user1;
  set $file $request_filename;
  echo "$name $file";
}

break指令

用于中断当前相同作用域(location)中的其他Nginx配置，与该指令处于同一作用域的Nginx配置中，位于它前面的配置生效，位于后面的指令配置就不再生效了，Nginx服务器在根据配置处理请求的过程中遇到该指令的时候，回到上一层作用域继续向下读取配置，该指令可以在server块和location块以及if块中使用
location / {
  set $name user1;
  echo "$name";
  break;
  set $file $request_filename;
  echo "$file";   
break前的指令执行，break后的指令则不执行

return指令

从nginx版本0.8.2开始支持，return用于完成对请求的处理，并直接向客户端返回响应状态码，比如其可以指定重定向URL(对于特殊重定向状态码，301/302等) 或者是指定提示文本内容(对于特殊状态码403/500等)，处于此指令后的所有配置都将不被执行，return可以在server、if和location块进行配置

return code; #返回给客户端指定的HTTP状态码
return code "text"; #返回给客户端的状态码及响应体内容，可以调用变量
return code URL; #返回给客户端的URL地址

location /main {
       default_type text/html;
       root /data/nginx/pc/html;
       index index.html;
       if ( $scheme = http ) {
       #return 200;
       #return 666 "not allow http";
       return 301 http://study.magedu.com/;
       }
   }
return code;实际中不会使用，只会返回一个状态码，并且前面和后面的指令不会执行，如果有主页的话，主页也不会显示，只会返回一个装填码；
return code "text";实际中也不会使用，只能返回一个状态码和打印一些提示信息，return前后面的指令都会执行，主页也不会显示；
return code URL;实际中使用较多，当访问/main时，会跳转到所指定的网站；只有状态码时301/302是才进行跳转
301是永久跳转，302是临时跳转；状态码是301时，浏览器会把跳转信息缓存下来，302浏览器是不会缓存下来的；
return指令通常用于location中，不会单独设置在全局的配置文件中；

rewrite指令

通过正则表达式的匹配来改变URI，可以同时存在一个或多个指令，按照顺序依次对URI进行匹配，rewrite主要是针对用户请求的URL或者是URI做具体处理，每个URL都是一个URI，但是URI不都是URL
rewrite用于server、location、if中；一般用于if中，location一般只用于/下

rewrite regex replacement [flag];
rewrite将用户请求的URI基于regex所描述的模式进行检查，匹配到时将其替换为表达式指定的新的URI。 注意：如果在同一级配置块中存在多个rewrite规则，那么会自下而下逐个检查；被某条件规则替换完成后，会重新一轮的替换检查，隐含有循环机制,但不超过10次；如果超过，提示500响应码，[flag]所表示的标志位用于控制此循环机制，如果替换后的URL是以http://或https://开头，则替换结果会直接以重向返回给客户端, 即永久重定向301

rewrite flag使用介绍

利用nginx的rewrite的指令，可以实现url的重新跳转，rewrtie有四种不同的flag，分别是redirect(临时重定向)、permanent(永久重定向)、break和last。其中前两种是跳转型的flag，后两种是代理型，跳转型是指有客户端浏览器重新对新地址进行请求，代理型是在WEB服务器内部实现跳转的（从一个location跳转到另一个location中）。
永久重定向（301）和临时重定向（302）的区别：302不会记录缓存；301会把缓存记录到磁盘上，下次再访问指定地址后，会读取缓存。
redirect;
#临时重定向，重写完成后以临时重定向方式直接返回重写后生成的新URL给客户端，由客户端重新发起请求；使用相对路径,或者http://或https://开头，状态码：302

permanent;
#重写完成后以永久重定向方式直接返回重写后生成的新URL给客户端，由客户端重新发起请求，状态码：301

last;
#重写完成后停止对当前URI在当前location中后续的其它重写操作，而后对新的URL启动新一轮重写检查（针对当前server中的所有location启动新一轮检查），直到再无匹配后停止循环，不建议在location中使用

break;
#重写完成后停止对当前URL在当前location中后续的其它重写操作，而后直接将匹配结果返还给客户端即结束循环并返回数据给客户端，建议在location中使用

break示例

break测试案例：当客户端访问break的时候，测试通过rewrite将URL重写为test1，然后再通过rewrite将test1重写为test2测试两条write规则最终哪一条生效，并且测试重写后的URL会不会到其他location重新匹配。
location /break {
       root /data/nginx/pc/html;
       index index.html;
       rewrite ^/break/(.*) /test1/$1 break;  
       rewrite ^/test1/(.*) /test2/$1 break;  #上面的rewrite匹配后，不会执行下面的这条rewrite，也不会执行下面的location
   }
   location = /test1 {
       return 999 "new test1";
       root /data/nginx/pc/html;       
       index index.html;
   }
   location = /test2 {
       return 666 "new test2";
       root /data/nginx/pc/html;
       index index.html;
   }
break匹配成功后不再向下匹配，也不会跳转到其他的location，即直接结束匹配并给客户端返回数据；如果客户端访问的是/break/index.html，则直接重写到/test1/index.html，把站点页面直接返回给客户端，而不会执行/test1下面的return 999 "new test1"这步

实际中总是用到if + rewrite break + uri分组

last示例

对某个location的URL匹配成功后会停止当前location的后续rewrite规则，并结束当前location，然后将匹配生成的新URL跳转至其他location继续匹配，直到没有location可匹配后将最后一次location的数据返回给客户端。
location /last {
       root /data/nginx/pc/html;
       index index.html;
       rewrite ^/last/(.*) /test1/$1 last;
       rewrite ^/test1/(.*) /test2/$1 last;  #如果第一条rewrite规则匹配成功则不执行本条，否则执行本条rewrite规则。
   }
   location /test1 {
       return 999 "new test1";
       root /data/nginx/pc/html;
       index index.html;
   }
   location /test2 {
       return 666 "new test2";
       root /data/nginx/pc/html;
       index index.html;
   }
当用户访问/last/index.html时会重写为/test1/index.html，然后再使用/test1/index.html重新匹配/last，发现不匹配后再去匹配/test1，发现匹配，执行return 999 "new test1"之后，结束循环；
^/test1表示以/test1开头；