RewriteRule 指令
|
为重写引擎定义重写规则 |
|
|
RewriteRule Pattern Substitution [flags] |
|
|
server config, virtual host, directory, .htaccess |
|
|
FileInfo |
|
|
扩展(E) |
|
|
mod_rewrite |
|
|
cookie-flag在Apache 2.0.40及以后的版本中可用 |
RewriteRule指令是重写引擎的根本。此指令可以多次使用。每个指令定义一个简单的重写规则。这些规则的定义顺序尤为重要——在运行时，规则是按这个顺序逐一生效的。
Pattern是一个作用于当前URL的perl兼容的正则表达式。"当前URL"是指该规则生效时刻的URL的值。它可能与被请求的URL截然不同，因为其他规则可能在此之前已经发生匹配并对它做了改动。
正则表达式的一些用法示例：
文本
. 任意一个单字符
[chars] 字符类: "chars"中的任意一个字符
[^chars] 字符类: 不在"chars"中的字符
text1|text2 选择: text1 或 text2
量词
? 前面的字符出现 0 或 1 次
* 前面的字符出现 0 或 N 次(N > 0)
+ 前面的字符出现 1 或 N 次(N > 1)
分组
(text) text 组
(常用于设置一个选择的边界，或用于生成后引用：
在RewriteRule中可以用 $N 引用第N个分组)
锚
^ 锚定到行首
$ 锚定到行尾
转义
\c 对给定的字符c进行转义
(比如对".[]()"进行转义，等等)
更多有关正则表达式的资料请参见perl正则表达式手册页("perldoc perlre")。另外，在mod_rewrite中，还可以使用否字符('!')前缀实现反转。比如："如果当前URL不与模式相匹配"它用于使用否定式匹配模式较容易描述的某些情况，或者作为最后一条规则。
注意
使用否字符以反转匹配模式时，匹配模式中不能使用分组的通配成分。由于模式不匹配而使分组的内容是空的，所以它是不可能实现的。 因此，如果使用了否定式匹配模式，那么后继的字符串中就不能使用$N
重写规则中的Substitution是当原始URL与Pattern相匹配时，用来替代(或替换)的字符串。除了纯文本，还可以包含：
- 对Pattern的反向引用($N)
- 对最后匹配的RewriteCond的反向引用(%N)
- 规则条件测试字符串(%{VARNAME})中的服务器变量
- 映射函数调用(${mapname:key|default})
反向引用的$N(N=0..9)是指用Pattern匹配的第N组的内容去替换URL。服务器变量与RewriteCond指令的TestString相同。映射函数由RewriteMap指令决定，其说明也参见该指令。这三种类型变量按上面列表中的顺序被展开。
如上所述，所有的重写规则都是按配置文件中的定义顺序作用于Substitution的。URL被Substitution完全替换，并继续处理直到所有规则处理完毕，除非用L标记显式地终结(见下文)。
'-'是一个特殊的替换串，意思是不替换。它可以用于仅仅匹配某些URL而无须替换的情况，比如，在发生替换前，允许以C(chain)标记连接的多个匹配模式同时起作用。
此外，在Substitution之后还可以追加[flags]标记作为RewriteRule指令的第三个参数。Flags是一个包含以逗号分隔的下列标记的列表：
- 'chain|C'(链接下一规则)
此标记使当前规则与下一个规则相链接。它产生这样的效果：如果一个规则被匹配，则继续处理其后继规则，也就是这个标记不起作用；如果该规则不被匹配，则其后继规则将被跳过。比如，在一个目录级规则中执行一个外部重定向时，你可能需要删除".www"(此处不应该出现".www")。 - 'cookie|CO=NAME:VAL:domain[:lifetime[:path]]'(设置cookie)
在客户端设置一个cookie。cookie的名称是NAME，值是VAL。domain是该cookie的域，比如'.apache.org'，可选的lifetime是cookie的有效期(分钟)，可选的path是cookie的路径。 - 'env|E=VAR:VAL'(设置环境变量)
此标记将环境变量VAR的值为VAL，VAL可以包含可扩展的正则表达式反向引用($N和%N)。此标记可以多次使用以设置多个变量。这些变量可以在其后许多情况下被间接引用，通常是在XSSI(<!--#echo var="VAR"-->)或CGI($ENV{'VAR'})中，也可以在后继的RewriteCond指令的CondPattern参数中通过%{ENV:VAR}引用。使用它可以记住从URL中剥离的信息。 - 'forbidden|F'(强制禁止URL)
强制禁止当前URL，也就是立即反馈一个HTTP响应码403(被禁止的)。使用这个标记，可以链接若干个RewriteConds来有条件地阻塞某些URL。 - 'gone|G'(强制废弃URL)
强制当前URL为已废弃，也就是立即反馈一个HTTP响应码410(已废弃的)。使用这个标记，可以标明页面已经被废弃而不存在了。 - 'handler|H=Content-handler'(强制指定内容处理器)
强自制定目标文件的内容处理器为Content-handler。例如，用来模拟mod_alias模块的ScriptAlias指令，以强制映射文件夹内的所有文件都由"cgi-script"处理器处理。 - 'last|L'(结尾规则)
立即停止重写操作，并不再应用其他重写规则。它对应于Perl中的last命令或C语言中的break命令。这个标记用于阻止当前已被重写的URL被后继规则再次重写。例如，使用它可以重写根路径的URL('/')为实际存在的URL(比如：'/e/www/')。 - 'next|N'(从头再来)
重新执行重写操作(从第一个规则重新开始)。此时再次进行处理的URL已经不是原始的URL了，而是经最后一个重写规则处理过的URL。它对应于Perl中的next命令或C语言中的continue命令。此标记可以重新开始重写操作(立即回到循环的开头)。但是要小心，不要制造死循环！ - 'nocase|NC'(忽略大小写)
它使Pattern忽略大小写，也就是在Pattern与当前URL匹配时，'A-Z'和'a-z'没有区别。 - 'noescape|NE'(在输出中不对URI进行转义)
此标记阻止mod_rewrite对重写结果应用常规的URI转义规则。 一般情况下，特殊字符('%', '$', ';'等)会被转义为等值的十六进制编码('%25', '%24', '%3B'等)。此标记可以阻止这样的转义，以允许百分号等符号出现在输出中，比如：
RewriteRule /foo/(.*) /bar?arg=P1\%3d$1 [R,NE]
可以使'/foo/zed转向到一个安全的请求'/bar?arg=P1=zed'。
- 'nosubreq|NS'(不对内部子请求进行处理)
在当前请求是一个内部子请求时，此标记强制重写引擎跳过该重写规则。比如，在mod_include试图搜索目录默认文件(index.xxx)时，Apache会在内部产生子请求。对于子请求，重写规则不一定有用，而且如果整个规则集都起作用，它甚至可能会引发错误。所以，可以用这个标记来排除某些规则。
使用原则：如果你为URL添加了CGI脚本前缀，以强制它们由CGI脚本处理，但对子请求处理的出错率(或者资源开销)很高，在这种情况下，可以使用这个标记。 - 'proxy|P'(强制为代理)
此标记使替换成分被内部地强制作为代理请求发送，并立即中断重写处理，然后把处理移交给mod_proxy模块。你必须确保此替换串是一个能够被mod_proxy处理的有效URI(比如以http://hostname开头)，否则将得到一个代理模块返回的错误。使用这个标记，可以把某些远程成分映射到本地服务器域名空间，从而增强了ProxyPass指令的功能。
注意：要使用这个功能，必须已经启用了mod_proxy模块。
- 'passthrough|PT'(移交给下一个处理器)
此标记强制重写引擎将内部request_rec结构中的uri字段设置为filename字段的值，这个小小的修改使得RewriteRule指令的输出能够被(从URI转换到文件名的)Alias, ScriptAlias, Redirect等指令进行后续处理[原文：This flag is just a hack to enable post-processing of the output of RewriteRule directives, using Alias, ScriptAlias, Redirect, and other directives from various URI-to-filename translators.]。举一个能说明其含义的例子： 如果要将/abc重写为/def， 然后再使用mod_alias将/def转换为/ghi，可以这样：
RewriteRule ^/abc(.*) /def$1 [PT]
Alias /def /ghi
如果省略了PT标记，虽然将uri=/abc/...重写为filename=/def/...的部分运作正常，但是后续的mod_alias在试图将URI转换到文件名时会遭遇失效。
注意：如果需要混合使用多个将URI转换到文件名的模块时，就必须使用这个标记。。此处混合使用mod_alias和mod_rewrite就是个典型的例子。
- 'qsappend|QSA'(追加查询字符串)
此标记强制重写引擎在已有的替换字符串中追加一个查询字符串，而不是简单的替换。如果需要通过重写规则在请求串中增加信息，就可以使用这个标记。 - 'redirect|R [=code]'(强制重定向)
若Substitution以http://thishost[:thisport]/(使新的URL成为一个URI)开头，可以强制性执行一个外部重定向。如果没有指定code，则产生一个HTTP响应码302(临时性移动)。如果需要使用在300-400范围内的其他响应代码，只需在此指定即可(或使用下列符号名称之一：temp(默认), permanent, seeother)。使用它可以把规范化的URL反馈给客户端，如将"/~"重写为"/u/"，或始终对/u/user加上斜杠，等等。
注意：在使用这个标记时，必须确保该替换字段是一个有效的URL。否则，它会指向一个无效的位置！并且要记住，此标记本身只是对URL加上http://thishost[:thisport]/前缀，重写操作仍然会继续进行。通常，你还会希望停止重写操作而立即重定向，那么就还需要使用'L'标记。 - 'skip|S=num'(跳过后继规则)
此标记强制重写引擎跳过当前匹配规则之后的num个规则。它可以模拟if-then-else结构：最后一个规则是then从句，而被跳过的skip=N个规则是else从句。注意：它和'chain|C'标记是不同的！ - 'type|T=MIME-type'(强制MIME类型)
强制目标文件的MIME类型为MIME-type，可以用来基于某些特定条件强制设置内容类型。比如，下面的指令可以让.php文件在以.phps扩展名调用的情况下由mod_php按照PHP源代码的MIME类型(application/x-httpd-php-source)显示：
RewriteRule ^(.+\.php)s$ $1 [T=application/x-httpd-php-source]
目录级重写
为了在.htaccess文件中针对特定目录使用重写引擎，你必须同时设置"RewriteEngine On"和"Options FollowSymLinks"。如果管理员禁止了该目录的FollowSymLinks特性，重写引擎将不会工作，这样做的原因是处于安全方面的考虑。
在服务器级配置中，模式匹配是作用于整个URL的。但是在目录级配置文件.htaccess中使用重写引擎的时候，目录前缀(一般总是和特定的目录名称相同)将会在模式匹配前被自动移除并在替换完成后被自动添加回去。这个特性对于重写来说是非常重要的，否则你就被迫必须总是对父目录进行匹配，而这并不总是可行的。这里有一个例外：如果替换字符串以"http://"开头，则不会添加目录前缀，而是强制执行一个外部重定向或代理操作(如果使用了P标志的话)。参见RewriteBase指令以获得更多信息。
还可以在<Directory>配置段中使用重写引擎，前缀匹配规则与在.htaccess中使用重写引擎时完全相同，并且这种做法更加简单。然而，为了避免前缀替换复杂化，我们还是建议尽量将重写规则放置在主服务器或虚拟主机配置部分，而不是放置在<Directory>配置段中。
虽然重写规则在语法上允许放置在<Location>配置段中，但这不是必须的，并且我们也反对这样做。
注意：绝对URL的替换
当替换字段以"http://thishost[:thisport]"作为前缀时，mod_rewrite会将它自动剥离出去。在配合生成主机名部分的映射函数使用的时候，这个对隐含的外部重定向URL的简化操作是有用的而且是重要的。下面的第一个例子有助于理解这点。
谨记：由于此功能的存在，以"http://thishost"为前缀的无条件外部重定向到自身所在的服务器是无效的。要实现一个到自身的重定向，必须使用R标记。
注意：查询字符串
Pattern不会按照查询字符串进行匹配。为了达到这个目的，你必须使用一个带有%{QUERY_STRING}变量的RewriteCond指令。当然，你也可以在替换字符串中创建包含查询字符串的URL：在替换字符串串中使用问号，以标明其后的部分应该被重新注入到QUERY_STRING中。而要删除一个已有的请求串，则可以用问号来终结替换字符串。为了联合新旧查询字符串，请使用[QSA]标志。
以下是所有可能的替换组合及其含义：
在服务器级配置中(httpd.conf)
对给定的请求"GET
/somepath/pathinfo"：
给定的规则 得到的替换字符串
---------------------------------------------- ----------------------------------
^/somepath(.*) otherpath$1 非法,不被支持
^/somepath(.*) otherpath$1 [R] 非法,不被支持
^/somepath(.*) otherpath$1 [P] 非法,不被支持
---------------------------------------------- ----------------------------------
^/somepath(.*) /otherpath$1 /otherpath/pathinfo
^/somepath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo
通过外部重定向
^/somepath(.*) /otherpath$1 [P] 毫无意义,不被支持
---------------------------------------------- ----------------------------------
^/somepath(.*) http://thishost/otherpath$1 /otherpath/pathinfo
^/somepath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo
通过外部重定向
^/somepath(.*) http://thishost/otherpath$1 [P] 毫无意义,不被支持
---------------------------------------------- ----------------------------------
^/somepath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo
通过外部重定向
^/somepath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo
通过外部重定向
([R]标记是多余的)
^/somepath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
通过内部代理
在/somepath的目录级配置中
(也就是/physical/path/to/somepath/.htacccess文件中含有：RewriteBase /somepath)
对给定的请求"GET
/somepath/localpath/pathinfo"：
给定的规则 得到的替换字符串
---------------------------------------------- ----------------------------------
^localpath(.*) otherpath$1 /somepath/otherpath/pathinfo
^localpath(.*) otherpath$1 [R] http://thishost/somepath/otherpath/pathinfo
通过外部重定向
^localpath(.*) otherpath$1 [P] 毫无意义,不被支持
---------------------------------------------- ----------------------------------
^localpath(.*) /otherpath$1 /otherpath/pathinfo
^localpath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo
通过外部重定向
^localpath(.*) /otherpath$1 [P] 毫无意义,不被支持
---------------------------------------------- ----------------------------------
^localpath(.*) http://thishost/otherpath$1 /otherpath/pathinfo
^localpath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo
通过外部重定向
^localpath(.*) http://thishost/otherpath$1 [P] 毫无意义,不被支持
---------------------------------------------- ----------------------------------
^localpath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo
通过外部重定向
^localpath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo
通过外部重定向
([R]标记是多余的)
^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
通过内部代理
