nginx rewrite模块以及指令的说明

分类: 服务器  • 发布时间: 2015-09-05 22:35:24  • 浏览量:6742

nginx通过ngx_http_rewrite_module模块支持url重写、支持if条件判断,但不支持else。该模块需要PCRE支持。

nginx rewrite指令执行顺序:

1.执行sever块的rewrite指令(这里的块指的是sever关键字后{}包围的区域,其它xx块类似)

2.执行location匹配

3.执行选定的location中的rewrite指令

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



break 指令

语法:break;

默认值:无

作用域:server,location,if

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

例:

if ($slow) {
     limit_rate 10k;
     break;
 }



if 指令

语法:if(condition){...}

默认值:无

作用域:server,location

功能:对给定的条件condition进行判断。如果为真,大括号内的rewrite指令将被执行。

if条件(conditon)可以是如下任何内容:

一个变量名;false如果这个变量是空字符串或者以0开始的字符串;

使用= ,!= 比较的一个变量和字符串

是用~, ~*与正则表达式匹配的变量,如果这个正则表达式中包含},;则整个表达式需要用" 或' 包围

使用-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;
 }



return 指令

语法1:return code;

语法2:return code URL;

语法3:return URL;

默认值:无

作用域:server,location,if

功能:停止处理规则并返回指定状态码(code)给客户端;非标准状态码444表示关闭连接且不给客户端发响应头;从0.8.42版本起,return支持响应URL重定向(对于301,302,303,307),或者文本响应(对于其他状态码);对于文本或者URL重定向可以包含变量。

例:

server {
        listen          80;
        server_name     192.168.21.69;
        return          301 https://$server_name$request_uri;
    }
if (!-e $request_filename) {
    return 404;
}



rewrite指令

语法:rewrite regex replacement [flag];

默认值:无

作用域:server,location,if

功能:如果一个URI匹配指定的正则表达式regex,URI就按照replacement重写。

说明:rewrite按配置文件中出现的顺序执行。flags标志可以停止继续处理。

如果replacement以"http://"或"https://"开始,将不再继续处理,这个重定向将返回给客户端。

flag可以是如下参数:

last 停止处理后续rewrite指令集,然后对当前重写的新URI在rewrite指令集上重新查找。

break 停止处理后续rewrite指令集,并不在重新查找,但是当前location内剩余非rewrite语句和location外的的非rewrite语句可以执行。

redirect 如果replacement不是以http:// 或https://开始,返回302临时重定向,地址栏显示重定向后的url

permanent 返回301永久重定向,地址栏显示重定向后的url

最终完整的重定向URL包括请求scheme(http://,https://等),请求的server_name_in_redirect和 port_in_redirec三部分,说白了也就是http协议、域名、端口三部分组成。

例:

server {
     ...
     rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 last;
     rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra last;
     return 403;
     ...
 }

如果这些rewrite放到 “/download/” location如下所示, 那么应使用break而不是last , 使用last将循环10次匹配,然后返回 500错误:

location /download/ {
     rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 break;
     rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra break;
     return 403;
 }

对于重写后的URL(replacement)包含原请求的请求参数,原URL的?后的内容。如果不想带原请求的参数 ,可以在replacement后加一个问号。如下,我们加了一个自定义的参数user=$1,然后在结尾处放了一个问号?,把原请的参数去掉。

rewrite ^/users/(.*)$ /show?user=$1? last;

如果正则表达regex式中包含 “}” 或 “;”, 那么整个表达式需要用双引号或单引号包围。



rewrite_log 指令

语法:rewrite_log on|off;

默认值:rewrite_log off;

作用域:http,server,location,if

功能:开启或关闭以notice级别打印rewrite处理日志到error log文件。


nginx打开rewrite log例子

rewrite_log on;
error_log logs/xxx.error.log notice;

1.打开rewrite on

2.把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

功能:控制是否输出为初始化的变量到日志



一些可用的全局变量有,可以用做条件判断(不完整收集):

变量说明
$args此变量与请求行中的参数相等,与$query_string等价。如:foo=123&bar=blahblah;
$content_length等于请求行的“Content_Length”的值
$content_type等同与请求头部的”Content_Type”的值
$document_root等同于当前请求的root指令指定的值
$document_uri等同于当前request中的URI,可不同于初始值,与$uri同。例如内部重定向时或使用index
$host与请求头部中“Host”行指定的值或是request到达的server的名字(没有Host行)一样
$http_user_agent客户端代理信息
$http_cookiecookie 信息
$limit_rate对连接速率的限制;
$request_body_file发往后端的本地文件名称
$request_method请求的方法,比如"GET"、"POST"等;
$remote_addr客户端地址;
$remote_port客户端端口号;
$remote_user客户端用户名,认证用;
$request_filename当前请求的文件路径名
$request_uri请求的URI,带参数;
$query_string此变量与请求行中的参数相等,,与$args等价。
$scheme所用的协议,比如http或者是https,比如rewrite^(.+)$$scheme://example.com$1redirect;
$server_protocol请求的协议版本,"HTTP/1.0"或"HTTP/1.1";
$server_addr服务器地址,如果没有用listen指明服务器地址,使用这个变量将发起一次系统调用以取得地址(造成资源浪费);
$server_name请求到达的服务器名;
$server_port请求到达的服务器端口号;
$uri请求的URI,可能和最初的值有不同,比如经过重定向之类的。


官方文档:http://nginx.org/en/docs/http/ngx_http_rewrite_module.html

参考文章:

http://www.nginx.cn/216.html

http://blog.csdn.net/andy_yf/article/details/7487751



文章标签: nginx, rewrite, 指令