NGINX -5 nginx的rewrite指令

1、 rewrite功能简要介绍

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

2、重要选项

2.1 if指令

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

格式

if (条件匹配){
action
}

if命令的正则表达式

= #比较变量和字符串是否相等，相等时if指令认为该条件为true，反之为false
!=  #比较变量和字符串是否不相等，不相等时if指令认为条件为true，反之为false
~ #区分大小写字符，可以通过正则表达式匹配，满足匹配条件为真，不满足匹配条件为假
!~ #区分大小写字符,判断是否匹配，不满足匹配条件为真，满足匹配条件为假

~* #不区分大小写字符，可以通过正则表达式匹配，满足匹配条件为真，不满足匹配条件为假
!~* #不区分大小字符,判断是否匹配，满足匹配条件为假，不满足匹配条件为真


-f 和 !-f #判断请求的文件是否存在和是否不存在
-d 和 !-d #判断请求的目录是否存在和是否不存在
-x 和 !-x #判断文件是否可执行和是否不可执行
-e 和 !-e #判断请求的文件或目录是否存在和是否不存在(包括文件，目录，软链接)

实例

server{
listen 80;
server_name www.ailun.com;
root /data/;

     if (!-e $request_filename ){
     return 302  /index.html;
     }
location /main {
     index index.html;
     default_type text/html;
     if ( $scheme = http ){
     return 803  "if-----> $scheme";
     }
}
location /test {
    #default_type text/plain;
    return 403;
}


}

代码解释

这段代码是 Nginx 服务器的配置文件片段，其作用在于定义服务器的监听端口、域名、根目录以及路由规则等内容。下面为你详细解释代码里的各个部分：

1. 全局配置

server {
    listen 80;
    server_name www.ailun.com;
    root /data/;

• server：此为 Nginx 配置中的关键指令，用于定义一个虚拟主机。借助它，你能够在同一台服务器上运行多个网站。
• listen 80;：该指令让 Nginx 监听 80 端口，这是 HTTP 协议的默认端口。
• server_name www.ailun.com;：这里指定了该虚拟主机所对应的域名，也就是当用户访问 www.ailun.com 时，Nginx 会依据这个配置来处理请求。
• root /data/;：此指令设置了该虚拟主机的根目录。当用户发起请求时，Nginx 会在 /data/ 目录下查找对应的文件。

2. 文件存在性检查

    if (!-e $request_filename ){
        return 302  /index.html;
    }

• if (!-e $request_filename )：这里运用 if 指令进行条件判断，-e 代表检查文件或目录是否存在，$request_filename 是 Nginx 的内置变量，它表示请求的文件路径。该条件意味着若请求的文件或目录不存在，就执行后续操作。
• return 302 /index.html;：一旦请求的文件或目录不存在，Nginx 会返回一个 302 临时重定向响应，将用户重定向到 /index.html 页面。

3. /main 路径的处理

location /main {
    index index.html;
    default_type text/html;
    if ( $scheme = http ){
        return 803  "if-----> $scheme";
    }
}

• location /main：location 指令用于匹配请求的 URI。这里表示当用户请求的 URI 以 /main 开头时，采用此 location 块内的配置来处理请求。
• index index.html;：该指令指定了默认的索引文件。当用户请求的是一个目录时，Nginx 会尝试返回该目录下的 index.html 文件。
• default_type text/html;：此指令设定了默认的 MIME 类型。若 Nginx 无法根据文件扩展名确定文件的 MIME 类型，就会使用 text/html 作为默认类型。
• if ( $scheme = http )：这里通过 if 指令判断请求使用的协议是否为 HTTP。$scheme 是 Nginx 的内置变量，代表请求使用的协议（如 http 或 https）。
• return 803 "if-----> $scheme";：若请求使用的是 HTTP 协议，Nginx 会返回一个状态码为 803 的响应，响应内容为 "if-----> $scheme"。不过需要注意的是，803 并非标准的 HTTP 状态码。

4. /test 路径的处理

location /test {
    #default_type text/plain;
    return 403;
}

• location /test：该 location 块用于匹配以 /test 开头的请求。
• #default_type text/plain;：这是一行注释掉的代码，原本的作用是将默认的 MIME 类型设置为 text/plain。
• return 403;：当用户请求的 URI 以 /test 开头时，Nginx 会返回一个 403 禁止访问的响应。

呈现结果：
1、当我们访问路径出现错误时，网站会自动的回到主站点
192.168.107.190/maaa — 会跳转到主站点

2、如果我们访问main文件夹时，在使用http访问的前提下，我们会返回一个803的状态码，且在屏幕上输出 if-----> $scheme
http://192.168.107.190/main/

3、如果我们访问test文件时会返回一个403的状态码

http://192.168.107.190/test

2.2 renturn 指令

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

语法格式

www.kgc.com/test/
404
return code; #返回给客户端指定的HTTP状态码
return code [text]; #返回给客户端的状态码及响应报文的实体内容，可以调用变量,其中text如果有空格,需要用单或双引号
return code url; #返回给客户端的URL地址    

return   code  [text] 

location /test {
    default_type text/plain;
    return 403 "hello";
}

我们可以设置临时重定向，访问test的操作将被匹配到www.baidu.com

location /test {
        default_type text/plain;
        return 302 http://www.baidu.com;    
}

设置永久重定向，访问test的操作将被匹配到主站点页面

location /test {
        default_type text/plain;
        return 301 /index.html;    
}

2.3 set 指令

指定key并给其定义一个变量，变量可以调用Nginx内置变量赋值给key，另外set定义格式为set $key value，value可以是text, variables和两者的组合。

格式：

set   $变量名    变量值 


location /main {
   root /data/nginx/html/pc;
   index index.html;
   default_type text/html;
    set $name kgc;
    echo $name;
    set $my_port $server_port(nginx  自带的变量  服务端口 一般80);
    echo $my_port;
}

2.4 break

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

注意: 如果break指令在location块中后续指令还会继续执行,只是不执行 ngx_http_rewrite_module 模块的指令（set rewrit return if）,其它指令还会执行

实例

if ($slow) {
   limit_rate 10k;
   break;
}
location /main {
   root /data/nginx/html/pc;
   index index.html;
   default_type text/html;
    set $name kgc;
    echo $name;
    break;  #location块中break后面指令还会执行
    set $my_port $server_port;
    echo $my_port;
 }

location  /test  {
    set  naem 
    
    
}

3、rewrite

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

语法格式

rewrite可以配置在 server、location、if
语法格式 ：
rewrite regex               replacement（www.baidu.com）        [flag];
        正则匹配原始访问url    替代的url链接                  标志 ()premanent301   redirect302     break    last  死循环

正则表达式格式

. #匹配除换行符以外的任意字符
\w #匹配字母或数字或下划线或汉字
\s #匹配任意的空白符
\d #匹配数字    [0-9]   
\b #匹配单词的开始或结束
^ #匹配字符串的开始
$ #匹配字符串的结束
* #匹配重复零次或更多次
+ #匹配重复一次或更多次
? #匹配重复零次或一次
{n} #匹配重复n次
{n,} #匹配重复n次或更多次
{n,m} #匹配重复n到m次
*? #匹配重复任意次，但尽可能少重复
+? #匹配重复1次或更多次，但尽可能少重复
?? #匹配重复0次或1次，但尽可能少重复
{n,m}? #匹配重复n到m次，但尽可能少重复
{n,}? #匹配重复n次以上，但尽可能少重复
\W  #匹配任意不是字母，数字，下划线，汉字的字符
\S #匹配任意不是空白符的字符
\D #匹配任意非数字的字符
\B #匹配不是单词开头或结束的位置
[^x] #匹配除了x以外的任意字符
[^kgc] #匹配除了kgc 这几个字母以外的任意字符

flag的说明：

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

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



break;       www.bj.com
#重写完成后,停止对当前URL在当前location中后续的其它重写操作，而后直接跳转至重写规则配置块之后的其它配置;结束循环，建议在location中使用
#适用于一个URL一次重写 
 



last; 
#重写完成后,停止对当前URL在当前location中后续的其它重写操作，而后对新的URL启动新一轮重写检查，不建议在location中使用
#适用于一个URL多次重写，要注意避免出现超过十次以及URL重写后返回错误的给用户301

实例1：从bj跳转到beijng

server{
listen 80;
server_name www.ailun.com;
root /data/;

     if (!-e $request_filename ){
     return 302  /index.html;
     }
location /bj {
     root /data/;
     rewrite ^/bj/(.*)    /beijing/$1   permanent;
}
}


[root@localhost data]# mkdir bj
[root@localhost data]# mkdir beijing
[root@localhost data]# echo "bj" > bj/index.html
[root@localhost data]# echo "beijing" > beijing/index.html
[root@localhost data]# tree
.
├── a.jpg
├── beijing
│   └── index.html
├── bj
│   └── index.html
├── error.png
├── index.html
├── main
│   └── index.html
└── test

3 directories, 7 files
[root@localhost data]# 

结果展示

实例2：将访问的http协议都转变成更安全的https协议

我们先需要有一个https的网站，详情见https://blog.csdn.net/qq_69831828/article/details/147740848?spm=1001.2014.3001.5501

搭建完成

我们在配置文件中添加如下location语句块

 location / {
            root   html;
            index  index.html index.htm;
            if ($scheme = http) {
            rewrite /(.*) https://$host/$1 redirect;
}
        }

现在我们就可以通过访问192.168.107.190/index.html 自动跳转到https界面

在网页上看的不是很明显，从不安全的http到安全的https之间的跳转速度比较快