首页 Nginx 从入门到放弃 正文

Nginx 的 rewrite 配置

lance 2020-04-08 PM 1436℃ 0条

简介

  • 域名跳转(重定向)，URL 重写(伪静态)，动静分离(跳转域名，并接入 CDN 实现加速)

  • 依赖 PCRE 库

  • 模块：ngx_http_rewrite_module

if 指令

顾名思义，条件判断相关

格式

格式：if (条件判断) { 具体的rewrite规则 }

介绍

条件判断语句由 Nginx 内置变量、逻辑判断符号和目标字符串三部分组成。
其中，内置变量是 Nginx 固定的非自定义的变量，如，$request_method, $request_uri 等。
逻辑判断符号，有 =, !=, ~, ~*, !~, !~*
! 表示相反的意思，~ 为匹配符号，它右侧为正则表达式，区分大小写，而 ~* 为不区分大小写匹配。
目标字符串可以是正则表达式，通常不用加引号，但表达式中有特殊符号时，比如空格、花括号、分号等，需要用单引号引起来。

示例

01

if ($request_method = POST)  # 当请求的方法为 POST 时，直接返回 405 状态码
{
    return 405; # 在该示例中并未用到 rewrite 规则，if 中支持用 return 指令。
}

02

if ($http_user_agent ~ MSIE) # user_agent 带有 MSIE 字符的请求，直接返回 403 状态码
{
    return 403;
}

如果想同时限制多个 user_agent，还可以写成这样

if ($http_user_agent ~ "MSIE|firefox|spider")
{
    return 403;
}

03

if(!-f $request_filename)  # 当请求的文件不存在，将会执行下面的 rewrite 规则
{
    rewrite 语句;
}

04

if($request_uri ~* 'gid=\d{9,12}/')  # \d 表示数字，{9,12} 表示数字出现的次数是 9 到 12 次，如 gid=123456789/ 就是符合条件的。
{
    rewrite 语句;
}

break 和 last

两个指令用法相同，但含义不同，需要放到 rewrite 规则的末尾，用来控制重写后的链接是否继续被 nginx 配置执行(主要是 rewrite、return 指令)。

当连续两条 rewrite 规则

示例1（连续两条 rewrite 规则）：
server {
    listen 80; 
    server_name test.com;
    root /tmp/123.com;

    rewrite /1.html /2.html ;
    rewrite /2.html /3.html ;

}
当我们请求 1.html 时，最终访问到的是 3.html，两条 rewrite 规则先后执行。

当 break 和 last 在 location{} 外部

格式：rewrite xxxxx break;

示例2（增加 break）：
server {
    listen 80; 
    server_name test.com;
    root /tmp/123.com;

    rewrite /1.html /2.html break;
    rewrite /2.html /3.html;
}
当我们请求 1.html 时，最终访问到的是 2.html
说明 break 在此示例中，作用是不再执行 break 以下的 rewrite 规则。
但，当配置文件中有 location 时，它还会去执行 location{} 段的配置（请求要匹配该 location）。

示例3（break 后面还有 location 段）：
server {
    listen 80; 
    server_name test.com;
    root /tmp/123.com;

    rewrite /1.html /2.html break;
    rewrite /2.html /3.html;
    location /2.html {
        return 403;
    }
}
当请求 1.html 时，最终会返回 403 状态码，说明它去匹配了 break 后面的 location{} 配置。

以上 2 个示例中，可以把 break 替换为 last，它们两者起到的效果一模一样。

当 break 和 last 在 location{} 里面

示例4（什么都不加）：
server {
    listen 80; 
    server_name test.com;
    root /tmp/123.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，最终将会访问 /b.html，连续执行 location / 下的两次 rewrite，跳转到了 /3.html，然后又匹配 location /3.html

示例5（增加 break）：
server {
    listen 80; 
    server_name test.com;
    root /tmp/123.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
在 location{} 内部，遇到 break，本 location{} 内以及后面的所有 location{} 内的所有指令都不再执行。

示例6（增加 last）：
server {
    listen 80; 
    server_name test.com;
    root /tmp/123.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 再次从头开始，从头到尾匹配一遍规则。

结论

  • 当 rewrite 规则在 location{} 外，break 和 last 作用一样，遇到 break 或 last 后，其后续的 rewrite/return 语句不再执行。但后续有 location{} 的话，还会近一步执行 location{} 里面的语句,当然前提是请求必须要匹配该 location。

  • 当 rewrite 规则在 location{} 里，遇到 break 后，本 location{} 与其他 location{} 的所有 rewrite/return 规则都不再执行。

  • 当 rewrite 规则在 location{} 里，遇到 last 后，本 location{} 里后续 rewrite/return 规则不执行，但重写后的 url 再次从头开始执行所有规则，哪个匹配执行哪个。

return 指令

该指令一般用于对请求的客户端直接返回响应状态码。在该作用域内 return 后面的所有 nginx 配置都是无效的。
可以使用在 server、location 以及 if 配置中。
除了支持跟状态码，还可以跟字符串或者 url 链接。

直接返回状态码

示例1：
server {
    listen 80;
    server_name www.a.com;
    return 403;
    rewrite /(.*) /abc/$1;  # 该行配置不会被执行。
}

示例2：
server {
    if ($request_uri ~ "\.htpasswd|\.bak")
    {
        return 404;
        rewrite /(.*) /aaa.txt;  # 该行配置不会被执行。
    }
    # 如果下面还有其他配置，会被执行。
}

返回字符串

示例3：
server {
    listen 80;
    server_name www.a.com;
    return 200 "hello";
}
说明：如果要想返回字符串，必须要加上状态码，否则会报错。
还可以支持 json 数据

示例4：
location ^~ /a {
    default_type application/json ;
    return 200  '{"name":"a","id":"100"}';
}

也支持写一个变量

示例5：
location /test {
    return 200 "$host $request_uri";
}

返回 url

示例6：
server {
    listen 80;
    server_name www.a.com;
    return http://www.ab.com/123.html;
    rewrite /(.*) /abc/$1;  # 该行配置不会被执行。
}
注意：return 后面的 url 必须是以 http:// 或者 https:// 开头的。

生产场景实战

背景：网站被黑了，凡是在百度点击到本网站的请求，全部都跳转到了一个赌博网站。
通过 nginx 解决：
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。

例子

01

location / {
    rewrite /(.*) http://www.a.com/$1 permanent;
}
说明：.* 为正则表达式，用 () 括起来，在后面的 URI 中可以调用它，第一次出现的 () 用 $1 调用，第二次出现的 () 用 $2 调用，以此类推。

02

location / {
    rewrite /.* http://www.a.com$request_uri permanent;
}
说明：在 replacement 中，支持变量，这里的 $request_uri 就是客户端请求的链接

03

server {
    listen 80;
    server_name www.123.com;
    root /tmp/123.com;
    index index.html;
    rewrite /(.*) /abc/$1 redirect;
}
说明：本例中的 rewrite 规则有问题，会造连续循环，最终会失败，解决该问题有两个方案。
关于循环次数，经测试发现，curl  会循环 50 次，chrome 会循环 80 次，IE 会循环 120 次，firefox 会循环 20 次。

04

server {
    listen 80;
    server_name www.123.com;
    root /tmp/123.com;
    index index.html;
    rewrite /(.*) /abc/$1 break;
}
说明：在 rewrite 中使用 break，会避免循环。

05

server {
    listen 80;
    server_name www.123.com;
    root /tmp/123.com;
    index index.html;
    if ($request_uri !~ '^/abc/')
    {
        rewrite /(.*) /abc/$1 redirect;
    }
}
说明：加一个条件限制，也可以避免产生循环

Nginx 常用全局变量

变量 说明
$args 请求中的参数，如 www.123.com/1.php?a=1&b=2 的 $args 就是 a=1&b=2
$content_length HTTP 请求信息里的 "Content-Length"
$conten_type HTTP 请求信息里的 "Content-Type"
$document_root nginx 虚拟主机配置文件中的 root 参数对应的值
$document_uri 当前请求中不包含指令的 URI，如 www.123.com/1.php?a=1&b=2 的 $document_uri 就是 1.php，不包含后面的参数
$host 主机头，也就是域名
$http_user_agent 客户端的详细信息，也就是浏览器的标识，用 curl -A 可以指定
$http_cookie 客户端的 cookie 信息
$limit_rate 如果 nginx 服务器使用 limit_rate 配置了显示网络速率，则会显示，如果没有设置， 则显示 0
$remote_addr 客户端的公网 ip
$remote_port 客户端的 port
$remote_user 如果 nginx 有配置认证，该变量代表客户端认证的用户名
$request_body_file 做反向代理时发给后端服务器的本地资源的名称
$request_method 请求资源的方式，GET/PUT/DELETE 等
$request_filename 当前请求的资源文件的路径名称，相当于是 $document_root/$document_uri 的组合
$request_uri 请求的链接，包括 $document_uri 和 $args
$scheme 请求的协议，如 ftp,http,https
$server_protocol 客户端请求资源使用的协议的版本，如 HTTP/1.0，HTTP/1.1，HTTP/2.0 等
$server_addr 服务器 IP 地址
$server_name 服务器的主机名
$server_port 服务器的端口号
$uri 和 $document_uri 相同
$http_referer 客户端请求时的 referer，通俗讲就是该请求是通过哪个链接跳过来的，用 curl -e 可以指定

Rewrite 实战

域名跳转（域名重定向）

示例1（不带条件的）：
server {
    listen 80;
    server_name www.ab.com;
    rewrite /(.*) http://www.a.com/$1 permanent;
    .......

}

示例2（带条件的）：
server {
    listen 80;
    server_name www.ab.com ab.com;
    if ($host != 'www.ab.com')
    {
        rewrite /(.*) http://www.ab.com/$1 permanent;
    }
    .......
}

示例3（http 跳转到 https）：
server {
    listen 80;
    server_name www.ab.com;
    rewrite /(.*) https://www.ab.com/$1 permanent;
    .......
}

示例4（域名访问二级目录）
server {
    listen 80;
    server_name bbs.ab.com;
    rewrite /(.*) http://www.ab.com/bbs/$1 last;
    .......
}

示例5（静态请求分离）
server {
    listen 80;
    server_name www.ab.com;
    location ~* ^.+.(jpg|jpeg|gif|css|png|js)$
    {
        rewrite /(.*) http://img.ab.com/$1 permanent;
    }
    .......
}

或者：
server {
    listen 80;
    server_name www.ab.com;
    if ( $uri ~* 'jpg|jpeg|gif|css|png|js$')
    {
        rewrite /(.*) http://img.ab.com/$1 permanent;
    }
    .......
}

防盗链

示例6
server {
    listen 80;
    server_name www.ab.com;
    location ~* ^.+.(jpg|jpeg|gif|css|png|js|rar|zip|flv)$
    {
        valid_referers none blocked server_names *.ab.com ab.com *.a.com a.com;
        if ($invalid_referer)
        {
            rewrite /(.*) http://img.ab.com/images/forbidden.png;
        }
    }

    .......

}
说明：* 这里是通配，跟正则里面的 * 不是一个意思，none 指的是 referer 不存在的情况（curl -e 测试），
      blocked 指的是 referer 头部的值被防火墙或者代理服务器删除或者伪装的情况，
      该情况下，referer 头部的值不以 http:// 或者 https:// 开头（curl -e 后面跟的 referer 不以 http:// 或者 https:// 开头）。
或者：
    location ~* ^.+.(jpg|jpeg|gif|css|png|js|rar|zip|flv)$
    {
        valid_referers none blocked server_names *.ab.com *.a.com ab.com a.com;
        if ($invalid_referer)
        {
            return 403;
        }
    }

伪静态

示例7(discuz 伪静态)：
location /  {
    rewrite ^([^\.]*)/topic-(.+)\.html$ $1/portal.php?mod=topic&topic=$2 last;
    rewrite ^([^\.]*)/forum-(\w+)-([0-9]+)\.html$ $1/forum.php?mod=forumdisplay&fid=$2&page=$3 last;
    rewrite ^([^\.]*)/thread-([0-9]+)-([0-9]+)-([0-9]+)\.html$ $1/forum.php?mod=viewthread&tid=$2&extra=page%3D$4&page=$3 last;
    rewrite ^([^\.]*)/group-([0-9]+)-([0-9]+)\.html$ $1/forum.php?mod=group&fid=$2&page=$3 last;
    rewrite ^([^\.]*)/space-(username|uid)-(.+)\.html$ $1/home.php?mod=space&$2=$3 last;
    rewrite ^([^\.]*)/(fid|tid)-([0-9]+)\.html$ $1/index.php?action=$2&value=$3 last;
}

rewrite 多个条件的并且

示例8：
location /{
    set $rule 0;
    if ($document_uri !~ '^/abc')
    {
        set $rule "${rule}1";
    }
    if ($http_user_agent ~* 'ie6|firefox')
    {
       set $rule "${rule}2";
    }
    if ($rule = "012")
    {
        rewrite /(.*) /abc/$1 redirect;
    }
}
标签: linux, nginx, rewrite

非特殊说明，本博所有文章均为博主原创。

觉得文章不错，打赏一点吧，1分也是爱😀

WeChat Pay

微信打赏

Alipay

支付宝打赏

上一篇 Nginx 虚拟主机配置
下一篇 Nginx 的 location 配置

评论啦~


栏目分类

博主动态 ~

  • 哈喽~应妻子要求，在这里推广下她开的首饰店，大家多来逛逛，有看中的要购买哟~最近还搞活动哟~淘宝店铺短链接：https://c.tb.cn/c.0o94GK 和 7月活动短链接：https://c.tb.cn/c.0o9xiv2020年07月11日 15:44:47

  • 大家能看到，我的博客更换主题啦~ 这个主题更简洁，打开更快~ 欢迎大家继续支持！2020年03月27日 09:38:22

标签云

linux nginx docker 运维宝典 k8s kubernetes jenkins Centos7 shell ansible gitlab 自动化发布 prometheus vultr ss mysql zabbix java v2ray grafana 梯子 手动回滚 php lnmp php7 ac ap 网络 jdk8 lvm

友情链接申请

krankheit blog Home Life Mall | Daily necessities 婧昕服饰
© 2022 Linux小白鼠.个人博客淘宝店铺 Poweed by Typecho Theme by Echo / 本站已存活了4年241天9小时33分