nginx参数location和rewrite

最新推荐文章于 2023-12-02 12:56:36 发布

OfficerGoodbody

最新推荐文章于 2023-12-02 12:56:36 发布

阅读量747

点赞数

文章标签： nginx xhtml 前端 ui javascript

本文链接：https://blog.csdn.net/OfficerGoodbody/article/details/126662608

版权

1 Location语法规则

1.1 Location规则

语法规则： location [=|~|~*|^~] /uri/ {… }

首先匹配 =，其次匹配^~,其次是按文件中顺序的正则匹配，最后是交给 /通用匹配。当有匹配成功时候，停止匹配，按当前匹配规则处理请求。

符号	含义
=	= 开头表示精确匹配
^~	^~开头表示uri以某个常规字符串开头，理解为匹配 url路径即可。nginx不对url做编码，因此请求为/static/20%/aa，可以被规则^~ /static/ /aa匹配到(注意是空格)
~	~ 开头表示区分大小写的正则匹配
~*	~* 开头表示不区分大小写的正则匹配
!~和!~*	!~和!~*分别为区分大小写不匹配及不区分大小写不匹配的正则
/	用户所使用的代理(一般为浏览器)
$http_x_forwarded_for	可以记录客户端IP，通过代理服务器来记录客户端的ip地址
$http_referer	可以记录用户是从哪个链接访问过来的

匹配规则示例：

location = / {
          #规则A
      }
      location = /login {
          #规则B
      }
      location ^~ /static/ {
          #规则C
      }
      location ~ \.(gif|jpg|png|js|css)$ {
          #规则D
      }
      location ~* \.png$ {
          #规则E
      }
      location !~ \.xhtml$ {
          #规则F
      }
      location !~* \.xhtml$ {
          #规则G
      }
      location / {
          #规则H
      }

那么产生的效果如下：

1. 访问根目录/，比如http://localhost/将匹配规则A

2. 访问 http://localhost/login 将匹配规则B，http://localhost/register则匹配规则H

3. 访问 http://localhost/static/a.html 将匹配规则C

4. 访问 http://localhost/a.gif,http://localhost/b.jpg 将匹配规则D和规则E，但是规则D顺序优先，规则E不起作用，而http://localhost/static/c.png则优先匹配到规则C

5. 访问 http://localhost/a.PNG 则匹配规则E，而不会匹配规则D，因为规则E不区分大小写。

6. 访问 http://localhost/a.xhtml 不会匹配规则F和规则G，http://localhost/a.XHTML不会匹配规则G，因为不区分大小写。规则F，规则G属于排除法，符合匹配规则但是不会匹配到，所以想想看实际应用中哪里会用到。

7. 访问 http://localhost/category/id/1111 则最终匹配到规则H，因为以上规则都不匹配，这个时候应该是nginx转发请求给后端应用服务器，比如FastCGI(PHP)，tomcat(jsp)，nginx作为方向代理服务器存在。

1.2 实际常用规则

#直接匹配网站根，通过域名访问网站首页比较频繁，使用这个会加速处理。

#这里是直接转发给后端应用服务器了，也可以是一个静态首页

# 第一个必选规则

location = / {
       proxy_passhttp://tomcat:8080/index
    }

# 第二个必选规则是处理静态文件请求，这是nginx作为http服务器的强项

# 有两种配置模式，目录匹配或后缀匹配,任选其一或搭配使用

location ^~ /static/ {
       # 请求/static/a.txt 将被映射到实际目录文件:/webroot/res/static/a.txt
       root /webroot/res/;
    }

    location ~* \.(gif|jpg|jpeg|png|css|js|ico)${
       root /webroot/res/;
    }

第三个规则就是通用规则，用来转发动态请求到后端应用服务器

#非静态文件请求就默认是动态请求，自己根据实际把握

#毕竟目前的一些框架的流行，带.php,.jsp后缀的情况很少了

location / {
       proxy_pass http://tomcat:8080/
    }

1.3 Location解析过程

总结：

1、先判断精准命中，如果命中，立即返回结果并结束解析过程。

2、判断普通命中，如果有多个命中，“记录”下来“最长”的命中结果(记录但不结束，最长的为准)。

3、继续判断正则表达式的解析结果，按配置里的正则表达式顺序为准，由上至下开始匹配，一旦匹配成功1个，立即返回结果，并结束解析过程。

4、普通命中顺序无所谓，是因为按命中的长短来确定。正则命中，顺序有所谓，因为是从前入往后命中的。

2 ReWrite语法

Nginx提供的全局变量或自己设置的变量，结合正则表达式和标志位实现url重写以及重定向。

rewrite只能放在server{},location{},if{}中，

并且只能对域名后边的除去传递的参数外的字符串起作用。

Rewrite主要的功能就是实现URL的重写，Nginx的Rewrite规则采用Pcre，perl兼容正则表达式的语法规则匹配，如果需要Nginx的Rewrite功能，在编译Nginx之前，需要编译安装PCRE库。

通过Rewrite规则，可以实现规范的URL、根据变量来做URL转向及选择配置。

下面是一个简单地URL rewrite跳转的例子：

rewrite ^/(.*) http://www.etiantian.org/$1 permanent;

在上述指令中，rewrite为固定关键字，表示开启一条rewrite匹配规则，regex部分是^/(.*)，这是一个正则表达式，表示匹配所有，匹配成功后跳转到http://www.etiantian.org/$1。这里的$1是取前面regex部分括号里的内容结尾的permanent；是永久301重定向标记，即跳转到后面的http://www.etiantian.org/$1地址上。

2.1 ReWrite相关指令

指令	默认值	使用范围	作用
break	none	if，server，location	完成当前的规则集，不再处理rewrite指令，需要和last加以区分
if ( condition ){ … }	none	server，location	用于检测一个条件是否符合，符合则执行大括号内的语句。不支持嵌套，不支持多个条件&&或\|\|处理
return	none	server，if，location	用于结束规则的执行和返回状态码给客户端。状态码的值可以是：204,400,402~406,408,410,411,413,416以及500~504，另外非标准状态码444，表示以不发送任何的Header头来结束连接。
rewrite regex replacement flag		server,location,if	该指令根据表达式来重定向URI，或者修改字符串。指令根据配置文件中的顺序来执行。注意重写表达式只对相对路径有效。
uninitialized_variable_warn on\|off	on	http,server,location,if	该指令用于开启和关闭未初始化变量的警告信息，默认值为开启。
set variable value	none		该指令用于定义一个变量，并且给变量进行赋值。变量的值可以是文本、一个变量或者变量和文本的联合，文本需要用引号引起来。

rewrite指令结尾的flag标记说明

flag标记符号	说明
last	本条规则匹配完成后，继续向下匹配新的location URI规则
break	本条规则匹配完成即终止，不再匹配后面的任何规则
redirect	返回302临时重定向，浏览器地址栏会显示跳转后的URL地址
permanent	返回301永久重定向，浏览器地址栏会显示跳转后的URL地址

在以上的flag标记中，last和break用来实现URL重写，浏览器地址栏的URL地址不变，但在服务器访问的程序及路径发生了变化。redirect和permanent用来实现URL跳转，浏览器地址会显示跳转后的URL地址。
last和break标记的实现功能类似，但二者之间有细微的差别，使用alias指令时必须用last标记，使用proxy_pass指令时要使用break标记。last标记在本条rewrite规则执行完毕后，会对其所在的server{…}标签重新发起请求，而break标记则会在本条规则匹配完成后，终止匹配，不再匹配后面的规则。

2.2 Rewrite全局变量

rewrite全局变量表

变量	含义
$args	这个变量等于请求行中的参数，同$query_string
$content length	请求头中的Content-length字段。
$content_type	请求头中的Content-Type字段。
$document_root	当前请求在root指令中指定的值。
$host	请求主机头字段，否则为服务器名称。
$http_user_agent	客户端agent信息
$http_cookie	客户端cookie信息
$limit_rate	这个变量可以限制连接速率。
$request_method	客户端请求的动作，通常为GET或POST。
$remote_addr	客户端的IP地址。
$remote_port	客户端的端口。
$remote_user	已经经过Auth Basic Module验证的用户名。
$request_filename	当前请求的文件路径，由root或alias指令与URI请求生成。
$scheme	HTTP方法(如http，https)。
$server_protocol	请求使用的协议，通常是HTTP/1.0或HTTP/1.1。
$server_addr	服务器地址，在完成一次系统调用后可以确定这个值。
$server_name	服务器名称。
$server_port	请求到达服务器的端口号。
$request_uri	包含请求参数的原始URI，不包含主机名，如”/foo/bar.php?arg=baz”。
$uri	不带请求参数的当前URI，$uri不包含主机名，如”/foo/bar.html”。
$document_uri	与$uri相同。

2.3 Rewrite语法规则

操作符	含义
= ,!=	比较的一个变量和字符串。
~， ~*	与正则表达式匹配的变量，如果这个正则表达式中包含}，;则整个表达式需要用”或’包围。
-f，!-f	检查一个文件是否存在。
-d, !-d	检查一个目录是否存在。
-e，!-e	检查一个文件、目录、符号链接是否存在。
-x， !-x	检查一个文件是否可执行。

2.4 if指令

配置位置：server，location，用于依据指定的条件，决定是否执行if块中的语句

判断条件：

变量值为空或为0，都为false；

set $if_value_test “0”;
      #注意这里if、()和{}要空格，否则会报错..略坑，不过这也是代码规范了
      if ($if_value_test) {
         #不会执行，因为$if_value_test值为0，false
         return 200;
}

变量与字符串比较，=为等于，!=为不等

变量与正则表达式匹配，~ 为区分大小写匹配，~* 为不区分大小写匹配，!~ , !~*前面两者的非操作

if ($request_uri ~ “^/breaktest$”) {
      #测试链接http://192.168.88.38/breaktest，最终返回http200
      return 200;
}

检查文件是否存在，-f存在即为true，!-f不存在即为true

检查目录是否存在，-d存在即为true，!-d不存在即为true

检查文件或目录是否存在，-e存在即为true，!-e不存在即为true

检查文件是否可执行，-x可执行即为true，!-x不可执行即为true

if (-e /usr/local/nginx/conf) {
      return 200;
}

if ($http_user_agent ~ MSIE) {

    rewrite ^(.*)$ /msie/$1 break;

} //如果UA包含"MSIE"，rewrite请求到/msid/目录下


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

    set $id $1;

 } //如果cookie匹配正则，设置变量$id等于正则引用部分
  

if ($request_method = POST) {

    return 405;

} //如果提交方法为POST，则返回状态405(Method not allowed)。return不能返回301,302


if ($slow) {

    limit_rate 10k;

} //限速，$slow可以通过 set 指令设置


if (!-f $request_filename){

    break;

    proxy_pass  http://127.0.0.1; 

} //如果请求的文件名不存在，则反向代理到localhost 。这里的break也是停止rewrite检查

 
if ($args ~ post=140){

    rewrite ^ http://mysite.com/ permanent;

} //如果query string中包含"post=140"，永久重定向到mysite.com

if  语法格式
     if 空格 (条件) {
        重写模式
     }

        # 限制浏览器访问
    if ($http_user_agent ~ Firefox) { 
      rewrite ^(.*)$ /firefox/$1 break; 
    }      

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

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

2.5 return指令

配置位置：server，location，if

参数值：return code [text]返回状态码及文本、return url重定向、return code url重定向

# 限制IP访问
    if  ($remote_addr = 192.168.197.142) {
       return 403;
    }

1.首先从日志查出ip

修改conf配置文件

重启配置文件访问发现

2.6 rewrite指令

配置位置：server，location，if

参数值：rewrite regex replacement [flag]，用于以正则表达式匹配特定格式的url并重写url.

regex为正则表达式，replacement为重写的内容，flag为rewrite的标识位

replacement：重写的url带http，表示重定向

location / {
    #测试链接http://192.168.88.38/test/，被重定向到百度首页，后面的语句不会再执行
    rewrite /test/(.*) http://www.baidu.com;
    set $set_value_test "112233 $request_uri";
    return 200 $set_value_test;
}

replacement：重写的url不带http，单纯的重写url

location / {
           #测试链接http://192.168.88.38/test/，匹配到location /{}后url被重写为http://192.168.88.38/breaktest，继续搜索匹配
           #匹配到location = /breaktest{}，最终返回http200及this is breaktest
           rewrite /test/(.*) /breaktest;
        }
        location = /breaktest {
           return 200 "this is breaktest";
        }

判断目录是否存在

服务器内部的rewrite和302跳转不一样.跳转的话URL都变了,变成重新http请求index.html,而内部rewrite,上下文没变。

if (!-e $document_root$fastcgi_script_name) {
        rewrite ^.*$ /index.html break;
    }

2.7 set指令

set指令是设置变量用的,可以用来达到多条件判断时作标志用

判断IE并重写,且不用break;我们用set变量来达到目的

配置位置：server，location，if，用于为变量赋值

if ($http_user_agent ~* msie) {
        set $isie 1;
    }

    if ($fastcgi_script_name = ie.html) {
        set $isie 0;
    }

    if ($isie 1) {
        rewrite ^.*$ ie.html;
    }

常用例子

(1)表示访问路径有a,b,c,d都跳转到//127.0.0.1:8080$Request_uri

location ~^/(a|b|c|d){
            proxy_pass http://127.0.0.1:8080$Request_uri;
            client_max_body_size   10240k;
            client_body_buffer_size   128k;
        }

server {
        listen       80;
        server_name  localhost;
        #===== break && rewrite test =====
        #这里如果注释掉break，所有请求进来都是返回http200，this is breaktest...
        break;
        return 200 "this is breaktest...";
        location = /breaktest {
            break;
            return 200 $request_uri;
            proxy_pass http://192.168.88.38/other;
        }
        location / {
            #set赋值，可以直接赋字符串，或是变量，如下是变量和字符串的组合
            set $set_value_test “112233 $request_uri”;
            return 200 $set_value_test;
        }

测试链接http://192.168.88.38/breaktest，使用效果如下图：

2.8 break

参数项：break，用于停止执行rewrite模块的指令，但是其他模块不受影响。

配置位置：server，location，if

server {
        listen       80;
        server_name  localhost;
        #===== break && rewrite test =====
        #这里如果注释掉break，所有请求进来都是返回http200，this is breaktest...
        break;
        return 200 "this is breaktest...";
        location = /breaktest {
            break;
            return 200 $request_uri;
            proxy_pass http://192.168.88.38/other;
        }
        location / {
            return 200 $request_uri;
        }

测试链接：http://192.168.88.38/breaktest ，请求到达server块后，被break终止执行rewrite指令集，return属于rewrite模块指令集，所以return 200 “this is breaktest…”不会执行；因为没有返回结果，所以继续执行location匹配，请求匹配到location = /breaktest{}之后，break终止return 200 $request_uri，而proxy_pass属于ngx_http_proxy_module，仍会继续执行，反向代理后的新url匹配到location /{}，因此最终返回结果为 http200，/other，如下图：

2.9 flag

用于设置重写url后的进一步操作，有break，last，redirect，permanent，rewrite不带flag时，多个rewrite指令顺序执行，当location中没有可执行的rewrite模块指令时，重新发起一次location匹配，下面说明各个flag的用途：

break：和上面讲的break用途及用法一样，终止执行rewrite模块指令集；
last：终止执行rewrite模块指令集，并开始搜寻重写url后匹配的location；
redirect：临时重定向
permanent：永久重定向

location / {
           #测试链接http://192.168.88.38/test1，匹配到location / {}
           rewrite ^/test1 /test2;#被重写为/test2，继续往下执行rewrite
           rewrite ^/test2 /test3;#被重写为/test3，往下没有可执行的rewrite模块指令，发起一次location匹配，匹配到location /test3 {}，最终返回http200及/test3
        }
        location /test2 {
            return 200 "/test2";
        }
        location /test3 {
            return 200 "/test3";
        }

last和break的区别在于，last会发起新的location匹配，而break不会。

location / {
           rewrite ^/test1 /test2;
           rewrite ^/test2 /test3 last;
           rewrite ^/test3 /test4;
        }
        location /test2 {
            return 200 "/test2";
        }
        location /test3 {
            return 200 "/test3";
        }
        location /test4 {
            return 200 "/test4";
        }

测试链接：http://192.168.88.38/test1 匹配到 location / {}后，被重写为/test2，顺序执行再次被重写为/test3，因为flag为last，所以不会继续重写为/test4，而是发起一次location匹配，匹配到location /test3{}，所以最终返回结果为http200及/test3;

如果把location /{}中的last改为break，被重写为/test3后，不再重写为/test4，也不会发起location，最终没有可匹配的资源，返回http404。

2.10 正则匹配URL的参数传递

小括号()之间匹配的内容，可以在后面通过 $下标来引用，如1 表示引用第一个小括号匹配的内容， 1表示引用第一个小括号匹配的内容，1表示引用第一个小括号匹配的内容，表示引用第二个小括号匹配的内容。

location / {
           rewrite ^/(test1)/(test2)/(test3) /$2/$3;
           return 200 $2-$3;
        }

最终返回结果：

参考文献:

https://www.cnblogs.com/crazylqy/p/6892010.html

https://blog.csdn.net/qq_41475058/article/details/89516051

OfficerGoodbody

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
nginx参数location和rewrite

1 Location语法规则1.1 Location规则语法规则： location [=|~|~*|^~] /uri/ {… }首先匹配 =，其次匹配^~,其次是按文件中顺序的正则匹配，最后是交给 /通用匹配。当有匹配成功时候，停止匹配，按当前匹配规则处理请求。符号含义== 开头表示精确匹配^~^~开头表示uri以某个常规字符串开头，理解为匹...
复制链接

扫一扫