rewrite重写介绍
rewrite重写模块是一个简单的正则表达式匹配与一个虚拟堆叠机结合.依赖于PCRE库,因此需要安装pcre.
根据变量重定向和选择不同的配置,从一个location跳转到另一个location,这样的循环可以持续10次,超过后返回500错误.
同时重写模块包含set命令,来创建新的变量并设置值,这在有些状况下非常有用,如记录条件标识,传递参数到其他location,记录执行动作等等.
rewrite模块指令
break:
语法：break
默认值：none
使用字段：server, location, if
功能: 完成当前设置的重写规则，停止执行其他的重写规则。
if:
语法：if (condition) { … }
默认值：none
使用字段：server, location
注意：尽量考虑使用trp_files代替。
判断的条件可以有以下值：
- 一个变量的名称：空字符传”“或者一些“0”开始的字符串为false。
- 字符串比较：使用=或!=运算符
- 正则表达式匹配：使用~(区分大小写)和~(不区分大小写)，取反运算!~和!~。
- 文件是否存在：使用-f和!-f操作符
- 目录是否存在：使用-d和!-d操作符
- 文件、目录、符号链接是否存在：使用-e和!-e操作符
- 文件是否可执行：使用-x和!-x操作符
return:
语法：return code
默认值：none
使用字段：server, location, if
功能: 停止处理并为客户端返回状态码。
非标准的444状态码将关闭连接，不发送任何响应头。可以使用的状态码有：204，400，402-406，408，410, 411, 413, 416与500-504。如果状态码附带文字段落，该文本将被放置在响应主体。相反，如果状态码后面是一个URL，该URL将成为location头补值。没有状态码的URL将被视为一个302状态码。
rewrite:
语法：rewrite regex replacement flag
默认值：none
使用字段：server, location, if
功能: 按照相关的正则表达式与字符串修改URI，指令按照在配置文件中出现的顺序执行。可以在重写指令后面添加标记。
注意：如果替换的字符串以http://开头，请求将被重定向，并且不再执行多余的rewrite指令。
尾部的标记(flag)可以是以下的值：
last - 停止处理重写模块指令，之后搜索location与更改后的URI匹配。
break - 完成重写指令。
redirect - 返回302临时重定向，如果替换字段用http://开头则被使用。
permanent - 返回301永久重定向。
rewrite_log:
语法：rewrite_log on | off
默认值：rewrite_log off
使用字段：server, location, if
变量：无
功能: 启用时将在error log中记录notice级别的重写日志。
set:
语法：set variable value
默认值：none
使用字段：server, location, if
功能: 为给定的变量设置一个特定值。
uninitialized_variable_warn:
语法：uninitialized_variable_warn on|off
默认值：uninitialized_variable_warn on
使用字段：http, server, location, if
功能: 控制是否记录未初始化变量的警告信息。
重写规则组成部分
重写规则的第一部分都是一个正则表达式
可以使用括号来捕获,后续可以根据位置将其引用,位置变量值取决于捕获正则表达式中的顺序.$1引用第一个括号中的值,$2为第二个,以此类推.
^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$
$1 $2 $3 $4
$1是两个小写字母组成的字符串,$2是一个由小写字母与数字组成的5个字符的字符串,$3是文件名,$4是png,jpg,gif其中的一个.
重写规则的第二部分是URI
请求被改写,该URI可能包含正则表达式中捕获的位置参数或这个级别下的nginx任何配置变量,如:
/data?file=$3.$4
如果这个URI不匹配任何nginx配置中的location,那么将给客户端返回301或302的状态码来表示重定向类型,该状态吗可以通过通过第三个参数来明确指定.
重写规则的第三部分
第三部分也就是尾部标记(flag),last标记将导致重写后的URI搜索匹配nginx的其他location,最多可循环10次.
rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' /data?file=$3.$4 last;
break命令可以当做自身命令:
if ($bwhog) {
limit_rate 300k;
break;
}
另一个停止重写模块的停止指令是return,来控制主HTTP模块处理请求.这意味着nginx将直接返回信息给客户端,与error_page结合为客户端呈现格式化的HTML页面或激活不同的模块来完成请求.如果状态吗附带文字段落,该文本将被放置在响应主体.相反,如果状态码后面是一个URL,该URL将成为location头补值.没有状态码的URL将被视为一个302状态码:
location = /image404.html {
return 404 "image not found\n";
}
实例
http {
# 定义image日志格式
log_format imagelog '[$time_local] ' $image_file ' ' $image_type ' ' $body_bytes_sent ' ' $status;
# 开启重写日志
rewrite_log on;
server {
root /home/www;
location / {
# 重写规则信息
error_log logs/rewrite.log notice;
# 注意这里要用‘’单引号引起来，避免{}
rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' /data?file=$3.$4;
# 注意不能在上面这条规则后面加上“last”参数，否则下面的set指令不会执行
set $image_file $3;
set $image_type $4;
}
location /data {
# 指定针对图片的日志格式，来分析图片类型和大小
access_log logs/images.log mian;
root /data/images;
# 应用前面定义的变量。判断首先文件在不在，不在再判断目录在不在，如果还不在就跳转到最后一个url里
try_files /$arg_file /image404.html;
}
location = /image404.html {
# 图片不存在返回特定的信息
return 404 "image not found\n";
}
}
}
创建新的重写规则
在需要创建新的重写规则时,要弄清楚需求是什么样的,再决定怎么做.
- 你的URL的模式是什么样的?
- 是否有一个以上的方法来实现？
- 是否需要捕获URL部分作为变量？
- 重定向到另一个web上可以看到我的规则？
- 是否要替换查询的字符串参数？
检查网站或应用程序布局,清楚URL模式.
比如将home目录重定向到主页上:
/
/home
/home/
/home/index
/home/index/
/index
/index.php
/index.php/
重写规则如下:
rewrite ^/(home(/index)?|index(\.php)?)/?$ $scheme://$host/ permanent;
指定了$scheme和$host变量,因为要做一个永久重定向,并希望nginx使用相同的参数构造URL.
如果想要分别记录各个部分的URL,可以使用正则表达式来捕获URI,然后给变量分配指定的位置变量.
当重写规则导致内部重定向或指示客户端调用该规则本身被定义的location时,必须采用特殊的动作来避免重写循环.如:在server配置段定义了一条规则带上last标志,在引用location时,必须带上break标志.
server {
rewrite ^(/images)/(.*)\.(png|jpg|gif)$ $1/$3/$2.$3 last;
location /images/ {
rewrite ^(/images)/(.*)\.(png|jpg|gif)$ $1/$3/$2.$3 break;
}
}
作为重写规则的一部分,传递新的查询字符串参数是使用重写规则的目标之一,如:
rewrite ^/images/(.*)_(\d+)x(\d+)\.(png|jpg|gif)$ /resizer/$1.$4?width=$2&height=$3? last;