Nginx Rewrite 规则

Nginx Rewrite 是利用 nginx 提供的全局变量或自己设置的变量,结合正则表达式和标志位实现 url 重写以及重定向。rewrite 只能放在 server{}, location{}, if{} 中,并且只能对域名后边的除去传递的参数外的字符串起作用,例如 http://seanlook.com/a/we/index.php?id=1&u=str 只对 /a/we/index.php 重写。语法 rewrite regex replacement [flag];

如果相对域名或参数字符串起作用,可以使用全局变量匹配,也可以使用 proxy_pass 反向代理。

表面看 rewrite 和 location 功能有点像,都能实现跳转,主要区别在于 rewrite 是在同一域名内更改获取资源的路径,而 location 是对一类路径做控制访问或反向代理,可以 proxy_pass 到其他机器。很多情况下 rewrite 也会写在 location 里,它们的执行顺序是:

  1. 执行 server 块的 rewrite 指令
  2. 执行 location 匹配
  3. 执行选定的 location 中的 rewrite 指令

如果其中某步 URI 被重写,则重新循环执行 1-3,直到找到真实存在的文件;循环超过 10 次,则返回 500 Internal Server Error 错误。

flag 标志位

  • last: 相当于 Apache的[L] 标记,表示完成 rewrite

  • break: 停止执行当前虚拟主机的后续 rewrite 指令集

  • redirect: 返回 302 临时重定向,地址栏会显示跳转后的地址

  • permanent: 返回 301 永久重定向,地址栏会显示跳转后的地址

因为 301 和 302 不能简单的只返回状态码,还必须有重定向的 URL,这就是 return 指令无法返回 301, 302 的原因了。这里 last 和 break 区别有点难以理解:

  1. last 一般写在 server 和 if 中,而 break 一般使用在 location 中
  2. last 不终止重写后的 url 匹配,即新的 url 会再从 server 走一遍匹配流程,而 break 终止重写后的匹配
  3. break 和 last 都能组织继续执行后面的 rewrite 指令

if 指令与全局变量

if判断指令

语法为 if(condition) {...},对给定的条件 condition 进行判断。如果为真,大括号内的 rewrite 指令将被执行,if 条件(conditon)可以是如下任何内容:

  • 当表达式只是一个变量时,如果值为空或任何以 0 开头的字符串都会当做 false

  • 直接比较变量和内容时,使用 =!=

  • ~ 正则表达式匹配,~* 不区分大小写的匹配,!~ 区分大小写的不匹配

  • -f!-f 用来判断是否存在文件

  • -d!-d 用来判断是否存在目录

  • -e!-e 用来判断是否存在文件或目录

  • -x!-x 用来判断文件是否可执行

栗子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# 如果UA包含"MSIE",rewrite 请求到 /msid/ 目录下
if ($http_user_agent ~ MSIE) {
rewrite ^(.*)$ /msie/$1 break;
}
# 如果 cookie 匹配正则,设置变量 $id 等于正则引用部分
if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
set $id $1;
}
# 如果提交方法为 POST,则返回状态 405(Method not allowed)。return 不能返回 301, 302
if ($request_method = POST) {
return 405;
}
# 限速,$slow 可以通过 set 指令设置
if ($slow) {
limit_rate 10k;
}
# 如果请求的文件名不存在,则反向代理到 localhost。这里的 break 也是停止 rewrite 检查
if (!-f $request_filename){
break;
proxy_pass http://127.0.0.1;
}
# 如果 query string 中包含"post=140",永久重定向到 example.com
if ($args ~ post=140){
rewrite ^ http://example.com/ permanent;
}
# 防盗链
location ~* \.(gif|jpg|png|swf|flv)$ {
valid_referers none blocked www.jefflei.com www.leizhenfang.com;
if ($invalid_referer) {
return 404;
}
}

全局变量

下面是可以用作if判断的全局变量:

  • $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相同。

栗子:

1
2
3
4
5
6
7
8
# http://localhost:88/test1/test2/test.php
$host = localhost
$server_port = 88
$request_uri = http://localhost:88/test1/test2/test.php
$document_uri = /test1/test2/test.php
$document_root = /var/www/html
$request_filename = /var/www/html/test1/test2/test.php

常用正则

  • .: 匹配除换行符以外的任意字符

  • ?: 重复0次或1次

  • +: 重复1次或更多次

  • *: 重复0次或更多次

  • \d: 匹配数字

  • ^: 匹配字符串的开始

  • $: 匹配字符串的介绍

  • {n}: 重复n次

  • {n,}: 重复n次或更多次

  • [c]: 匹配单个字符c

  • [a-z]: 匹配a-z小写字母的任意一个

小括号 () 之间匹配的内容,可以在后面通过 $1 来引用,$2 表示的是前面第二个 () 里的内容。正则里面容易让人困惑的是 \ 转义特殊字符。

rewrite 实例

  • WordPress 伪静态

    1
    2
    3
    4
    5
    6
    7
    8
    9
    if (-f $request_filename/index.html) {
    rewrite (.*) $1/index.html break;
    }
    if (-f $request_filename/index.php) {
    rewrite (.*) $1/index.php;
    }
    if (!-f $request_filename) {
    rewrite (.*) /index.php;
    }
  • PHPCMS 伪静态

    1
    2
    3
    4
    5
    6
    rewrite ^/caipu-([0-9]+)-([0-9]+)-([0-9]+).html /index.php?m=content&c=index&a=show&catid=$1&id=$2&page=$3 last;
    rewrite ^/content-([0-9]+)-([0-9]+)-([0-9]+).html /index.php?m=content&c=index&a=show&catid=$1&id=$2&page=$3 last;
    rewrite ^/list-([0-9]+)-([0-9]+).html /index.php?m=content&c=index&a=lists&catid=$1&page=$2 last;
    rewrite ^/tag-([^\.]*)-([0-9]+)-([0-9]+).html /index.php?m=content&c=tag&catid=$2&tag=$1&page=$3 last;
    rewrite ^/comment-([0-9]+)-([0-9]+)-([0-9]+).html /index.php?m=comment&c=index&a=init&commentid=content_$1-$2-$3 last;
    rewrite ^/([^\.]*).html /index.php?m=member&c=index&a=$1 last;
  • DEDECMS 伪静态

    1
    2
    3
    4
    5
    6
    7
    rewrite "^/index.html$" /index.php last;
    rewrite "^/list-([0-9]+)\.html$" /plus/list.php?tid=$1 last;
    rewrite "^/list-([0-9]+)-([0-9]+)-([0-9]+)\.html$" /plus/list.php?tid=$1&totalresult=$2&PageNo=$3 last;
    rewrite "^/view-([0-9]+)-1\.html$" /plus/view.php?arcID=$1 last;
    rewrite "^/view-([0-9]+)-([0-9]+)\.html$" /plus/view.php?aid=$1&pageno=$2 last;
    rewrite "^/tags.html$" /tags.php last;
    rewrite "^/tag-([0-9]+)-([0-9]+)\.html$" /tags.php?/$1/$2/ last;
  • Discuz7 伪静态

    1
    2
    3
    4
    5
    rewrite ^/archiver/((fid|tid)-[\w\-]+\.html)$ /archiver/index.php?$1 last;
    rewrite ^/forum-([0-9]+)-([0-9]+)\.html$ /forumdisplay.php?fid=$1&page=$2 last;
    rewrite ^/thread-([0-9]+)-([0-9]+)-([0-9]+)\.html$ /viewthread.php?tid=$1&extra=page\%3D$3&page=$2 last;
    rewrite ^/space-(username|uid)-(.+)\.html$ /space.php?$1=$2 last;
    rewrite ^/tag-(.+)\.html$ /tag.php?name=$1 last;
  • DiscuzX 伪静态

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    rewrite ^([^\.]*)/topic-(.+)\.html$ $1/portal.php?mod=topic&topic=$2 last;
    rewrite ^([^\.]*)/article-([0-9]+)-([0-9]+)\.html$ $1/portal.php?mod=view&aid=$2&page=$3 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 ^([^\.]*)/([a-z]+)-(.+)\.html$ $1/$2.php?rewrite=$3 last;
    if (!-e $request_filename) {
    return 404;
    }
  • PHPWind 伪静态

    1
    2
    rewrite ^(.*)-htm-(.*)$ $1.php?$2 last;
    rewrite ^(.*)/simple/([a-z0-9\_]+\.html)$ $1/simple/index.php?$2 last;
  • SHOPEX 伪静态

    1
    2
    3
    if (!-e $request_filename) {
    rewrite ^/(.+\.(html|xml|json|htm|php|jsp|asp|shtml))$ /index.php?$1 last;
    }
  • Typecho 伪静态

    1
    2
    3
    4
    5
    6
    7
    8
    9
    if (-f $request_filename/index.html) {
    rewrite (.*) $1/index.html break;
    }
    if (-f $request_filename/index.php) {
    rewrite (.*) $1/index.php;
    }
    if (!-f $request_filename) {
    rewrite (.*) /index.php;
    }
  • Emlog 伪静态

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    if (!-f $request_filename) {
    set $rule_0 1$rule_0;
    }
    if (!-d $request_filename) {
    set $rule_0 2$rule_0;
    }
    if ($rule_0 = "21") {
    rewrite ^/(post|record|sort|author|page)-([0-9]+)\.html(.*)$ /index.php?$1=$2$3;
    rewrite ^/(post|record|sort|author|page)/([0-9]+)(.*)$ /index.php?$1=$2$3;
    rewrite ^/tag-(.+)\.html$ /index.php?tag=$1;
    rewrite ^/tag/(.+)$ /index.php?tag=$1;
    rewrite ^/t/page/([0-9]+)$ /t/index.php?page=$1;
    }