通过Rewrite规则可以实现规范的URL、根据变量来做URL转向及选择配置,用好Rewrite有时起到事半功倍的效果。
语法
Nginx的Rewrite相比Apache的要好理解很多,主要使用指令有if、rewrite、set、return、break等,其中rewrite是最关键的指令。
- rewrite
语法: rewrite regex replacement [flag];
默认值: —
上下文: server, location, if
- 如果指定的正则表达式能匹配URI,此URI将被replacement参数定义的字符串改写。rewrite指令按其在配置文件中出现的顺序执行。flag可以终止后续指令的执行。如果replacement的字符串以“http://”或“https://”开头,nginx将结束执行过程,并返回给客户端一个重定向。
可选的flag参数可以是其中之一:
- last
停止执行当前这一轮的ngx_http_rewrite_module指令集,然后查找匹配改变后URI的新location; - break
停止执行当前这一轮的ngx_http_rewrite_module指令集; - redirect
在replacement字符串未以“http://”或“https://”开头时,使用返回状态码为302的临时重定向; - permanent
返回状态码为301的永久重定向。 - 举例
server {
...
rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 last;
rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra last;
return 403;
...
}
- 但是当上述指令写在“/download/”的location中时,应使用标志break代替last,否则nginx会重复10轮循环,然后返回错误500(break和last的区别请参考break):
location /download/ {
rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 break;
rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra break;
return 403;
}
- 如果replacement字符串包括新的请求参数,以往的请求参数会添加到新参数后面。如果不希望这样,在replacement字符串末尾加一个问号“?”,就可以避免,比如:
rewrite ^/users/(.*)$ /show?user=$1? last;
- break
语法: break;
默认值: —
上下文: server, location, if
- 停止处理当前这一轮的ngx_http_rewrite_module指令集。如:
if ($slow) {
limit_rate 10k;
break;
}
- last和break标记的实现功能类似,但二者之间细微的差别,使用alias指令时必须用last标记,使用proxy_pass指令时要使用break标记。last标记在本条rewrite规则执行完毕后,会对其所在的server{...}标签重新发起请求,而break标记则在本条规则匹配完成后终止匹配,不在匹配后边的规则。因此,一般在根location中(即location / {...})或直接在server标签中编写rewrite规则,推荐使用last标记,在非location中(如location /cms/ {...}),则使用break标记。
对花括号({和})来说,他们既能用在重定向的正则表达式里,也能用在配置文件里分割代码块,为了避免冲突,正则表达式里如果带花括号,应该使用双引号(或单引号)包围,如:把/photos/123456重定向到:/path/to/photos/12/1234/123456.png
rewrite "/photos/([0-9]{2})([0-9]{2})([0-9]{2})" /path/to/photos/$1$2/$1$2$3.png>
- if
语法: if (condition) { ... }
默认值: —
上下文: server, location
- 用于检查condition,如果为真,执行定义在大括号中的rewrite模块指令。if指令不支持嵌套,不支持多个条件&&和||处理。
条件可以是下列任意一种:
- 变量名;如果变量值为空或者是以“0”开始的字符串,则条件为假;
- 使用“=”和“!=”运算符比较变量和字符串;
- 使用“~”(大小写敏感)和“~*”(大小写不敏感)运算符匹配变量和正则表达式。正则表达式可以包含匹配组,匹配结果后续可以使用变量$1..$9引用。如果正则表达式中包含字符“}”或者“;”,整个表达式应该被包含在单引号或双引号的引用中。
- 使用“-f”和“!-f”运算符检查文件是否存在;
- 使用“-d”和“!-d”运算符检查目录是否存在;
- 使用“-e”和“!-e”运算符检查文件、目录或符号链接是否存在;
- 使用“-x”和“!-x”运算符检查可执行文件;
- 如:
if ($http_user_agent ~ MSIE) {
rewrite ^(.*)$ /msie/$1 break;
}
if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
set $id $1;
}
if ($request_method = POST) {
return 405;
}
if ($slow) {
limit_rate 10k;
}
if ($invalid_referer) {
return 403;
}
语法: set variable value;
默认值: —
上下文: server, location, if语法: rewrite_log on | off;
默认值:
rewrite_log off;
上下文: http, server, location, if语法: uninitialized_variable_warn on | off;
默认值:
uninitialized_variable_warn on;
上下文: http, server, location, if语法: return code [text];
return code URL;
return URL;
默认值: —
上下文: server, location, if
nginx用到的全局变量
$arg_PARAMETER #这个变量包含GET请求中,如果有变量PARAMETER时的值。 $args #这个变量等于请求行中(GET请求)的参数,例如foo=123&bar=blahblah; $binary_remote_addr #二进制的客户地址。 $body_bytes_sent #响应时送出的body字节数数量。即使连接中断,这个数据也是精确的。 $content_length #请求头中的Content-length字段。 $content_type #请求头中的Content-Type字段。 $cookie_COOKIE #cookie COOKIE变量的值 $document_root #当前请求在root指令中指定的值。 $document_uri #与$uri相同。 $host #请求主机头字段,否则为服务器名称。 $hostname #Set to the machine’s hostname as returned by gethostname $http_HEADER $is_args #如果有$args参数,这个变量等于”?”,否则等于”",空值。 $http_user_agent #客户端agent信息 $http_cookie #客户端cookie信息 $limit_rate #这个变量可以限制连接速率。 $query_string #与$args相同。 $request_body_file #客户端请求主体信息的临时文件名。 $request_method #客户端请求的动作,通常为GET或POST。 $remote_addr #客户端的IP地址。 $remote_port #客户端的端口。 $remote_user #已经经过Auth Basic Module验证的用户名。 $request_completion #如果请求结束,设置为OK. 当请求未结束或如果该请求不是请求链串的最后一个时,为空(Empty)。 $request_method #GET或POST $request_filename #当前请求的文件路径,由root或alias指令与URI请求生成。 $request_uri #包含请求参数的原始URI,不包含主机名,如:”/foo/bar.php?arg=baz”。不能修改。 $scheme #HTTP方法(如http,https)。 $server_protocol #请求使用的协议,通常是HTTP/1.0或HTTP/1.1。 $server_addr #服务器地址,在完成一次系统调用后可以确定这个值。 $server_name #服务器名称。 $server_port #请求到达服务器的端口号。 $uri #不带请求参数的当前URI,$uri不包含主机名,如”/foo/bar.html”。该值有可能和$request_uri 不一致。$request_uri是浏览器发过来的值。该值是rewrite后的值。例如做了internal redirects后。
Rewrite规则实例
- 当访问的文件和目录不存在时,重定向到某个php文件
if( !-e $request_filename ) {
rewrite ^/(.*)$ index.php last;
}
- 目录对换 /123456/xxxx ====> /xxxx?id=123456
rewrite ^/(\d+)/(.+)/ /$2?id=$1 last;
- 如果客户端使用的是IE浏览器,则重定向到/ie目录下
if( $http_user_agent ~ MSIE) {
rewrite ^(.*)$ /ie/$1 break;
}
- 禁止访问多个目录
location ~ ^/(cron|templates)/ {
deny all;
break;
}
- 禁止访问以/data开头的文件
location ~ ^/data {
deny all;
}
- 禁止访问以.sh,.flv,.mp3为文件后缀名的文件
location ~ .*\.(sh|flv|mp3)$ {
return 403;
}
- 设置某些类型文件的浏览器缓存时间
location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$ {
expires 30d;
}
location ~ .*\.(js|css)$ {
expires 1h;
}
Nginx和Apache的Rewrite规则实例对比
- 一般简单的Nginx和Apache规则的区别不大,基本能够完全兼容,例如:
#Apache
RewriteRule ^/abc/$ /web/abc.php [L]
#Nginx
rewrite ^/abc/$ /web/abc.php last ;
- 我们可以看出来只要把Apache的RewriteRule改为Nginx的rewrite,Apache的[L]改为last 即可。
如果将Apache的规则改为Nginx规则后,用命令Nginx -t 检查发现错误,则我们可以尝试给条件加上引号,例如:
rewrite "^/([0-9]{5}).html$" /x.php?id=$1 last;
- Apache和Nginx的Rewrite规则在URL跳转时有细微区别:
#Apache
RewriteRule ^/html/([a-zA-Z]+)/.*$ /$1/ [R=301,L]
#Nginx
rewrite ^/html/([a-zA-Z]+)/.*$ http://$host/$1/ premanent;
- 下面是一些Apache和Nginx规则的对应关系
Apache的RewriteCond对应Nginx的if
Apache的RewriteRule对应Nginx的rewrite
Apache的[R]对应Nginx的redirect
Apache的[P]对应Nginx的last
Apache的[R,L]对应Nginx的redirect
Apache的[P,L]对应Nginx的last
Apache的[PT,L]对应Nginx的last
例如:允许指定的域名访问本站,其他的域名一律转向www.xiaozhe.com Apache:
RewriteCond %{HTTP_HOST} !^(.*?)\.aaa\.com$ [NC]
RewriteCond %{HTTP_HOST} !^localhost$
RewriteCond %{HTTP_HOST} !^192\.168\.0\.(.*?)$
RewriteRule ^/(.*)$ http://www.xiaozhe.com [R,L]
- Nginx:
if( $host ~* ^(.*)\.aaa\.com$ )
{
set $allowHost ‘1’;
}
if( $host ~* ^localhost )
{
set $allowHost ‘1’;
}
if( $host ~* ^192\.168\.1\.(.*?)$ )
{
set $allowHost ‘1’;
}
if( $allowHost !~ ‘1’ )
{
rewrite ^/(.*)$ http://www.xiaozhe.com redirect ;
}