nginx_rewrite规则介绍

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

全局变量

下面是可以用作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相同。

常用正则

  • . : 匹配除换行符以外的任意字符
  • ? : 重复0次或1次
  • + : 重复1次或更多次
  • * : 重复0次或更多次
  • \d :匹配数字
  • ^ : 匹配字符串的开始
  • $ : 匹配字符串的介绍
  • {n} : 重复n次
  • {n,} : 重复n次或更多次
  • [c] : 匹配单个字符c
  • [a-z] : 匹配a-z小写字母的任意一个

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


rewrite实例

 1 http {
 2     # 定义image日志格式
 3     log_format imagelog '[$time_local] ' $image_file ' ' $image_type ' ' $body_bytes_sent ' ' $status;
 4     # 开启重写日志
 5     rewrite_log on;
 6 
 7     server {
 8         root /home/www;
 9 
10         location / {
11                 # 重写规则信息
12                 error_log logs/rewrite.log notice;
13                 # 注意这里要用‘’单引号引起来,避免{}
14                 rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' /data?file=$3.$4;
15                 # 注意不能在上面这条规则后面加上“last”参数,否则下面的set指令不会执行
16                 set $image_file $3;
17                 set $image_type $4;
18         }
19 
20         location /data {
21                 # 指定针对图片的日志格式,来分析图片类型和大小
22                 access_log logs/images.log mian;
23                 root /data/images;
24                 # 应用前面定义的变量。判断首先文件在不在,不在再判断目录在不在,如果还不在就跳转到最后一个url里
25                 try_files /$arg_file /image404.html;
26         }
27         location = /image404.html {
28                 # 图片不存在返回特定的信息
29                 return 404 "image not found\n";
30         }
31 }

对形如/images/ef/uh7b3/test.png的请求,重写到/data?file=test.png,于是匹配到location /data,先看/data/images/test.png文件存不存在,如果存在则正常响应,如果不存在则重写tryfiles到新的image404 location,直接返回404状态码。

rewrite ^/images/(.*)_(\d+)x(\d+)\.(png|jpg|gif)$ /resizer/$1.$4?width=$2&height=$3? last;

对形如/images/bla_500x400.jpg的文件请求,重写到/resizer/bla.jpg?width=500&height=400地址,并会继续尝试匹配location。