Nginx-Rewrite

 官网：https://nginx.org/en/docs/http/ngx_http_rewrite_module.html

 ngx_http_rewrite_module模块指令

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

if指令

 Context: server, location

用于条件匹配判断，并根据条件判断结果选择不同的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: #判断请求的文件或目录是否存在和是否不存在(包括文件，目录，软链接)。

.      匹配除换行符以外的任意字符
\w     匹配字母或数字或下划线或汉字
\s     匹配任意的空白符
\d     匹配数字
\b     匹配单词的开始或结束
^      匹配字符串的开始
$      匹配字符串的结束

*         重复零次或更多次
+         重复一次或更多次
?         重复零次或一次
{n}       重复n次
{n,}      重复n次或更多次
{n,m}     重复n到m次
*?        复任意次，但尽可能少重复
+?        重复1次或更多次，但尽可能少重复
??        重复0次或1次，但尽可能少重复
{n,m}?    重复n到m次，但尽可能少重复
{n,}?     重复n次以上，但尽可能少重复

\W        匹配任意不是字母，数字，下划线，汉字的字符
\S        匹配任意不是空白符的字符
\D        匹配任意非数字的字符
\B        匹配不是单词开头或结束的位置
[^x]      匹配除了x以外的任意字符
[^aeiou]  匹配除了aeiou这几个字母以外的任意字符

Examples

if ($http_user_agent ~ MSIE) {
    rewrite ^(.*)$ /msie/$1 break;
}

if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
    set $id $1;
}

if ($request_method = POST) {
    return 405;
}

if ($slow) {
    limit_rate 10k;
}

if ($invalid_referer) {
    return 403;
}

location /main {
  index index.html;
  default_type text/html;
  if ( $scheme = http ){
    echo "if-----> $scheme";
  }
  if ( $scheme = https ){
    echo "if ----> $scheme";
 }
 
  #if (-f $request_filename) {
  #  echo "file is exist";
  #}
  if (!-f $request_filename) {
    echo "file is not exist";
    #return 409;
 }
}

set指令

Context: server, location, if

指定key并给其定义一个变量，变量可以调用Nginx内置变量赋值给key，另外set定义格式为set $key $value，及无论是key还是value都要加$符号

location /main {
  root /data/nginx/html/pc;
  index index.html;
  default_type text/html;
  set $name magedu;
  echo $name;
  set $my_port $server_port;
  echo $my_port;
}

break指令

Context: server, location, if

用于中断当前相同作用域(location)中的其他Nginx配置，与该指令处于同一作用域的Nginx配置中，位于它前面的配置生效，位于后面的指令配置就不再生效了，Nginx服务器在根据配置处理请求的过程中遇到该指令的时候，回到上一层作用域继续向下读取配置，该指令可以在server块和location块以及if块中使用，使用语法如下：

location /main {
 root /data/nginx/html/pc;
 index index.html;
 default_type text/html;
 set $name magedu;
 echo $name;
 break;  //下面的并不会生效
 set $my_port $server_port;
 echo $my_port;

return指令

Context: server, location, if

从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 {
 root /data/nginx/html/pc;
 default_type text/html;
 index index.html;
   if ( $scheme = http ){
    #return 666;
    #return 666 "not allow http";
    #return 301 http://www.baidu.com;
   return 500 "service error";
    echo "if-----> $scheme"; #return后面的将不再执行
  }
  if ( $scheme = https ){
   echo "if ----> $scheme";
 }

 https跳转示例

server {
        listen 443 ssl;
        server_name mobile.magedu.net;

        charset utf-8;

        location / {
            root /data/nginx/html/mobile;
            index index.html;
        }
        location /about {
          root /data/nginx/html/mobile;
          default_type text/html;
          index index.html;
          #if ( $scheme = http ){
          #  return 301 http://www.baidu.com;
          #}
          if ( $scheme = https ){
            return 301 https://www.360buy.com;
          }
        }
}

server {
        listen 80;
        server_name mobile.magedu.net;

        charset utf-8;

        location / {
            root /data/nginx/html/mobile;
            index index.html;
        }
        location /about {
          root /data/nginx/html/mobile;
          default_type text/html;
          index index.html;
          if ( $scheme = http ){
            return 301 http://www.baidu.com;
          }
          #if ( $scheme = https ){
          #  return 301 https://www.360buy.com;
          #}
        }
}

rewrite_log指令

设置是否开启记录ngx_http_rewrite_module模块日志记录到error_log日志文件当中，可以配置在http、server、location或if当中，需要日志级别为notice。

Context: http, server, location, if

location /main {
  index index.html;
  default_type text/html;
  set $name magedu;
  echo $name;
  rewrite_log on;
  break;
  set $my_port $server_port;
  echo $my_port;
}

 重启nginx，访问并验证error_log

[root@s2 ~]# tail -f /apps/nginx/logs/error.log
2019/02/27 15:10:02 [warn] 5815#0: *3 using uninitialized "my_port" variable, client:
192.168.0.1, server: www.magedu.net, request: "GET /main HTTP/1.1", host:"www.magedu.net"

 rewrite指令

 Context: server, location, if

通过正则表达式的匹配来改变URI，可以同时存在一个或多个指令，按照顺序依次对URI进行匹配，rewrite主要是针对用户请求的URL或者是URI做具体处理，以下是URL和URI的具体介绍：

URI(universal resource identifier)：通用资源标识符，标识一个资源的路径，可以不带协议。
URL(uniform resource location):统一资源定位符，是用于在Internet中描述资源的字符串，是URI的子集，
主要包括传输协议(scheme)、主机(IP、端口号或者域名)和资源具体地址(目录和文件名)等三部分，一般格式为
scheme://主机名[:端口号][/资源路径],如：http://www.a.com:8080/path/file/index.html就是一个URL路径，URL必须带访问协议。

每个URL都是一个URI，但是URI不都是URL。 
例如： 
http://example.org:8080/path/to/resource.txt  #URI/URL 
ftp://example.org/resource.txt  #URI/URL 
/absolute/path/to/resource.txt  #URI

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

rewrite flag使用介绍

Syntax: rewrite regex replacement [flag]; #通过正则表达式处理用户请求并返回替换后的数据包

Context: server, location, if

利用nginx的rewrite的指令，可以实现url的重新跳转，rewrtie有四种不同的flag，分别是redirect(临时重定向)、permanent(永久重定向)、break和last。其中前两种是跳转型的flag，后两种是代理型，跳转型是指有客户端浏览器重新对新地址进行请求，代理型是在WEB服务器内部实现跳转的。

redirect； #临时重定向，重写完成后以临时重定向方式直接返回重写后生成的新URL给客户端，由客户端重新发起请求；使用相对路径,或者http://或https://开头，状态码：302

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

last；     #重写完成后停止对当前URI在当前location中后续的其它重写操作，而后对新的URL启动新一轮重写检查，不建议在location中使用

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

rewrite案例

域名永久与临时重定向

要求：因业务需要，将访问源域名 www.magedu.net 的请求永久重定向到www.magedu.com 。
临时重定向不会缓存域名解析记录(A记录)，但是永久重定向会缓存。

location / {
  root /data/nginx/html/pc;
  index index.html;
  rewrite /  http://www.magedu.com permanent;
  #rewrite /  http://www.magedu.com redirect;
}

临时重定向

域名临时重定向，告诉浏览器域名不是固定重定向到当前目标域名，后期可能随时会更改，因此浏览器不会缓存当前域名的解析记录，而浏览器会缓存永久重定向的DNS解析记录，这也是临时重定向与永久重定向最大的本质区别。

rewrite案例--brak与last 

要求：访问about的请求被转发至images，而访问images传递请求再次被转发至images1，以此测试last和break分别有什么区别：

break案例

当客户端访问break的时候，测试通过rewrite将URL重写为test1，然后再通过rewrite将test1重写为test2测试两条write规则最终哪一条生效，并且测试重写后的URL会不会到其他location重新匹配。

  location /break {
    #return 666 "break";
    root /data/nginx;
    index index.html;
    rewrite ^/break/(.*) /test1/$1 break;  #break匹配成功后不再向下匹配，也不会跳转到其他的location，即直接结束匹配并给客户端返回结果数据。
    rewrite ^/test1/(.*) /test2/$1 break;  #break不会匹配后面的rewrite规则也不匹配其他location
  }
  
  location = /test1 {
    return 999 "new test1";
    #index index.html;
    #root /data/nginx;
  }
 
  location = /test2 {
    return 666 "new test2";
    #root /opt/nginx;
    #index index.html;
  }

创建资源路径：
# mkdir /data/nginx/break
# mkdir /data/nginx/test1
# mkdir /data/nginx/test2
# cat /data/nginx/break/index.html
break
# cat /data/nginx/test1/index.html
test1
# cat /data/nginx/test2/index.html
test2
# /apps/nginx/sbin/nginx -t
# /apps/nginx/sbin/nginx -s reload

break访问测试：
[root@s3 ~]# curl  -L http://www.magedu.net/break/index.html
test1 #最终的结果不会超出break的location而且不会继续匹配当前location后续的write规则，而且直接返回数据给客户端。

break适用于不改变客户端访问方式，但是要将访问的目的URL做单次重写的场景，比如有V1/V2两个版本的网站前端页面并存，旧版本的网站数据已经保存到了statics不能丢失，但是要将访问新版本的资源重写到新的静态资源路径到新的目录static：
  location /statics {
    root /data/nginx;
    index index.html;
    rewrite ^/statics/(.*) /static/$1 break;
  }

 last案例

last：对某个location的URL匹配成功后会停止当前location的后续rewrite规则，并结束当前location，然后将匹配生成的新URL跳转至其他location继续匹配，直到没有location可匹配后将最后一次location的数据返回给客户端。

  location /test1 {
    #return 999 "new test1";
    index index.html;
    root /data/nginx;
    rewrite ^/test1/(.*) /test2/$1 last;
  }
 
  location /test2 {
    return 666 "new test2";
    #root /opt/nginx;
    #index index.html;
  }

  location /last {
    root /data/nginx;
    index index.html;
    rewrite ^/last/(.*) /test1/$1 last;
    #rewrite ^/test1/(.*) /test2/$1 last; #如果第一条rewrite规则匹配成功则不执行本条，否则执行本条rewrite规则。
  }
 

last访问测试：
[root@s3 ~]# curl  -L  http://www.magedu.net/last/index.html
new test2 #会匹配多个location，直到最终全部匹配完成，返回最后一个location的匹配结果给客户端。

last适用于要不改变客户端访问方式但是需做多次目的URL重写的场景，场景不是很多。

 rewrite案例-自动跳转https

要求：基于通信安全考虑公司网站要求全站https，因此要求将在不影响用户请求的情况下将http请求全部自动跳转至https，另外也可以实现部分location跳转。

配置生效从上往下匹配

server {
  listen 443 ssl;
  listen 80;
  ssl_certificate /apps/nginx/certs/www.magedu.net.crt;
  ssl_certificate_key /apps/nginx/certs/www.magedu.net.key;
  ssl_session_cache shared:sslcache:20m;
  ssl_session_timeout 10m;
  server_name www.magedu.net;
  
  location / {
    root /data/nginx/html/pc;
    index index.html;
    if ($scheme = http ){  #未加条件判断，会导致死循环
      rewrite / https://www.magedu.net permanent;
    } 
　　#if ($server_port !~ 443){
　　#  rewrite ^(/.*)$ https://$host$1 permanent;  # 通配匹配
  #}
}

 

 如果是因为规则匹配问题导致的陷入死循环，则报错如下：

 

 

 优化-rewrite案例-判断文件是否存在自动跳转官网

要求：当用户访问到公司网站的时输入了一个错误的URL，可以将用户重定向至官网首页。

location / {
  root /data/nginx/html/pc;
  index index.html;
  if (!-f $request_filename) {
    #return 404 "linux35";
    rewrite (.*) http://www.magedu.net/index.html;
  }
}

 更换目录访问方式

 要求：/20200106/static -> /static?id=20200106

rewrite ^/(\d+)/(.+)/ /$2?id=$1 last;

 多目录转换访问方式

 要求：www.magedu.com/images/20200106/1.jpg => www.magedu.com/index.do?name=images&dir=20200106=&file=1.jpg

if ($host ~* (.*)\.magedu\.com) { 
    rewrite ^/(.*)\/(\d+)\/(.*)$ /index.do?name=$2&dir=$1&file=$3 last; 
}