原文:http://code.tutsplus.com/tutorials/a-deeper-look-at-mod_rewrite-for-apache--net-6708
译文:http://article.yeeyan.org/view/jcky/59298
在本文中。我真的试图使mod_rewrite的难度降低一个档次。我不仅要去尝试解决mod_rewrite的的语法,还要设法提供一个工作流程,使你可以通过它调试和解决你的mod_rewrite问题。我也会给你一些有用的现实世界中的例子。
然而,在开始之前,我还要做一个警告。许多学科,尤其是这个,除非你自己动手尝试,否则你是不会学会的!这就是为何我会更专注于教授一个调试工作流程。像往常一样,如果你还没有加载模块,我会告诉你如何安装好你的系统。我敦促你们在你们自己服务器上做这些例子,如果是测试环境,则更好。你的经验和成功次数越多,你就会越容易将这种知识扩展到更高级的例子和应用。享受吧。
mod_rewrite的是什么?
mod_rewrite的是一个Apache模块,可使服务器操纵请求的网址。根据一系列规则对传入的网址进行检查,规则中包含一个 正则表达式 来检测特定的格式。 如果在地址中发现了一个格式,并且满足适当的条件,该格式就会被一个替代的字符串或者是动作取代。 这一过程一直在进行着,直到没有更多的规则或是程序被明确告诉停止。上面的内容可以总结为以下3点:
*有一个按顺序排列的处理规则列表。
*如果有一个规则相匹配,它会检查那条规则满足的条件。
*如果一切都匹配,它会替代或这是做出一个动作。
mod_rewrite的优点
用这样的一个地址重定向工具有很明显的优点,但是有一些东西也不是很明显。
人们用mod_rewrite的主要原因是为了将丑陋的、神秘的网址转化为所谓的“友好的地址”或者是“干净的地址”。新网址通过多种方式变的友好,而不是仅仅一种。 它们是用户友好的,表现在可更容易为人类所理解,瞥一眼就可以,并且用户可能自己来操纵网址。作为额外的奖励,这些网址对搜索引擎来说也是友好的。创建友好的网址是一个搜索引擎优化技术,网址是一种有效描述他链接的内容的方式。看看下面的例子:
- 不是很友好: http()//example.com/user.php?id=4512
- 比较友好: http://example.com/user/4512/
- 甚至更好: http://example.com/user/Joe/
将同一个例子扩展一下,一些人声称通过用mod_rewrite改变你的网址可以获得安全效益。给出同一个例子,想像,考虑一下下面这个对用户id的攻击:
- http://example.com/user.php?id=AHHHHHH
- http://example.com/user/AHHHHHH/
从安全的角度讲,这种额外的抽象功能是不错的。如果你愿意,你甚至可以防止直接访问原始PHP脚。不过,我们决不能使用mod_rewrite来替换一般的安全措施,你的脚本应当在服务器端进行验证。
在服务器上启用mod_rewrite模块
如果你是你们网络的网络管理员,并且你想确认一下你已经加载了这个模块,你应当检查一下httpd.conf文件。在配置文件有很大一部分用于加载那一大堆模块。下面的行可能会出现在文件中,如果是,好极了!如果它被注释掉了,或者说是在它前面有一个#号,哪么你只需将#号删除掉,留下下面的这一部分:
1、LoadModule rewrite_module modules/mod_rewrite.so
- # Only in Apache 1.3
- AddModule mod_rewrite.c
测试mod_rewrite模块
在我的基本身份验证的第一个教程中,我提到了在htpasswd的工具。你可以使用诸如apachectl或者httpd的其他工具直接对模块进行测试。有命令行开关可以使你检查现有的已经安装加载的模块。您可以执行下面的命令来得到一个所有已加载的模块的列表。
shell
> apachectl -t -D DUMP_MODULES
这里我展示的是这个命令的帮组页面。然后,我运行了这个命令,并在结果中查找了“rewrite”,有一行输出与之相匹配。
最后,如果你还是不能确定它是否启用了,像以前一样将它注释掉,看看会发生什么!之后,我会介绍语法,但这里仅仅是一个测试,看看他是否工作了。下面的.htaccess文件将重定向任何给定的文件夹请求到good.html文件,这意味着如果你的mod_rewrite工作了,你应该看到good.html。如果mod_rewrite不工作,那么你会看到一个带警告的index.html。
下面是正确的和错误的页面:
|
.htaccess的内容
- Popular Added Bytes Cheatsheet For Regular Expressions
- Added Bytes Cheatsheet for mod_rewrite
- Explain Regular Expressions
- # Enable Rewriting
- RewriteEngine on
- # Rewrite user URLs
- # Input: user/NAME/
- # Output: user.php?id=NAME
- RewriteRule ^user/(w+)/?$ user.php?id=$1
<?php
// Get the username from the url
$id = $_GET['id'];
?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Simple mod_rewrite example</title>
<style type="text/css"> .green { color: green; } </style>
</head>
<body>
<h1>You Are on user.php!</h1>
<p>Welcome: <span class="green"><?php echo $id; ?></span></p>
</body>
</html>
- T规则:
- RewriteRule ^user/(w+)/?$ user.php?id=$1
- 匹配模式:
- ^ 输入的开头
- user/ 以“user/“开始的请求地址
- (w+) 提取所有的字母,并将提取的结果传给$1
- /? 可选的斜线 "/"
- $ 输入结束
- 替换为:
- user.php?id= 要用到的字符串.
- $1 上面第一个提取到的字符串。
输入 | 匹配 | 提取 | 输出 | 结果 |
---|---|---|---|---|
user.php?id=joe | No | user.php?id=joe | Normal | |
user/joe | Yes | joe | user.php?id=joe | Good |
user/joe/ | Yes | joe | user.php?id=joe | Good |
user/joe/x | No | user/joe/x | Fail |
这个例子比较容易理解。然而,为了澄清任何更复杂的事情,就像我现在做的一样,我必须要花好几分钟去注意细节。在下一节中,我们将举一个更复杂的例子,这个例子涉及所有重写的核心内容。
^user/([a-z]+)/?$。 请注意,我没有使用w的缩写。如果此版本可以在你的机器上正确运行,那么你不要使用正则表达式的缩写,要使用较长的当量(见上面的正则表达式节)。
那么,mod_rewrites是如何工作的?如果你用的是.htaccess文件,那么你只需输入REMOTE_URI部分,但没有开始的斜线!我之前提到过这个,对大多数刚刚开始用它的人来说,这显得很混乱。如果你是将它添加到了全局配置文件里,那么你应当加上斜线。
为了说的更具体一点儿,下面是Apache的文档中对mod_rewrite中“URL部分”的描述:
该模式始终是对请求的URL路径进行正则表达式匹配(主机名后面的那部分,但在任何以问号为标志的显示查询字符串的前面)。 Apache文档
对于那些想要100%的区分开这两中教法的人,我这里说的URL其实是URI。一个统一资源标识符(URI)的定义有别于统一资源定位符(URL)。一个URI只是标识资源在哪里,这意味着存在多个URl可以指向相同的资源,但是他们是不同的地址。一个URI可能在找到资源之前经过了数次跳动和重定向。然而,URL却是标识资源的确切位置。这种细微的差别随着时间的推移,变得越来月模糊,以至于没有人关心它们的差异。我将继续使用术语URL,因为人们用它更舒服一些。
所以,现在我们知道重写规则将要采取行动了。一旦Apache已解析出请求,它就会将它翻译成它认为的文件,并去读取该文件。在这个过程中,他会搜索.htaccess文件。假设,.htaccess文件起用了RewriteEngine,那么任何重写规则都可以更改网址。地址的急剧变化(如Apache将某个网址原来指向的目录替换为另外一个目录)将促发Apache发出子请求,进而获取新的文件。
在大多数情况下,你是可以看到子请求的。这些实现细节对于了解你写的或使用的大多数简单的重写规则来说并不重要。更重要的是知道Apache如何处理.htaccess文件中的重写规则。
.htaccess文件中的规则会以它们出现的顺序被处理。请注意,每个重写规则都是“部分网址”,也就是说类似于REMOTE_URI。当一个规则促发替换的时候,修改后的“部分网址”将被移交给下一个规则。这意味着,正在处理的网址可能已经被前面的规则修改过了,网址会被每个相匹配的规则更新。这一点很重要!
前面,我介绍了重写条件,但是没有详谈。每个重写过程都与一条 重写规则(RewriteRule) 相关联。 条件(conds,conditions的缩写) 出现在与它们有联系的规则之前,但是只有与规则相匹配了,网址才会得到评估。正如流程图所示,如果与一个重写规则相匹配了,Apache会检查这条规则有什么条件(即做出替换是否需要其他条件)。如果没有条件,那么将进行替代并进入下一步。如果需要条件,那么只有所有的条件都成立的时候,才会进行替换。举一个具体的例子。
我用的网址实际上是我放在"profile_example"目录中的源代码的一部分。这和前面的例子user.php一样,但现在有一个profile.php页面,一个附加的重写规则,和一个条件!让我们看一下这段代码和它在Apache中的执行过程:
理解这个例子的关键是首先要了解目标。在这个例子中,我允许友好网址,但实际上,我要明确地禁止直接访问PHP页面。请注意,有些人可能会说这是一个坏主意。他们可能会说,作为开发者,这个调试起来会更难。是这样的,事实上我不推荐做这样的小把戏,但是作为一个例子,这很好。更实际的使用mod_rewrite的例子会在本教程后面的部分看到。
因此,在这一点的基础上,让我们看看我绿色网址发生了什么。这次,我们希望取得成功。
- URL匹配成功。
- 没有任何条件,因此继续。
- 进行替换。
- 没有任何标志,因而继续。
- URL匹配成功。
- 还有条件,我们将检查条件。
- THE_REQUEST不包含profile.php,因此条件检查失败。
- 因为不满足条件,所以我们忽略替换和标志。
- 这条规则没有改变URL。
profile.php?id=joe
页会被正确的提取。
下面介绍关于如何执行蓝色的URL,这一次,我们要失败:
- URL匹配失败。
- 其他的一切都被忽略,网址没有改变,进入下一步。
- URL匹配成功。
- 有条件需要比较,因此会先测试条件。
- 请求包含
profile.php,因此条件测试通过。
- 通过所有的条件,我们可以替换网址了。
- ”-”是一个特殊的替换,这一为着任何东西都不会改变了。
- 规则中有标志,因此我们处理标志。
- 有一个F标志,意思是返回一个禁止访问响应。
一个
403 Forbidden响应发送到了客户端。
下面是一个URL例子的分解和它们的返回值表:
输入 | 匹配 | 获取 | 输出 | 结果 |
---|---|---|---|---|
profile.php?id=joe | Yes (#2) | profile.php?id=joe | Forbidden | |
profile/joe | Yes (#1) | joe | profile.php?id=joe | Good |
profile/joe/ | Yes (#1) | joe | profile.php?id=joe | Good |
profile/joe/x | No | profile/joe/x | Fail |
让我们从重写规则开始。如果你想做一些特殊的事,你可以随时查看Apache的关于重写规则的文档。下面是我的概述:
下面是Apache的RewriteCond文档和我的概述:
我正在介绍的这种方法的关键之处是它可以让你知道是否你的一个改变不能正常工作或者是使某个地方运行不正常。当一次做得太多的时候,你会不可避免的遇到错误,并且你将不得不恢复你所做的一切更改来找出问题到底是出在那儿了。这是一项非常艰难的 工作,可能会导致你的失望。不过,如果你总是稳步推进,并且在每一步都可以到达一个可以正常运行的点,你的处境就会稍好一点儿。
人们往往忽略这条建议,创建了一个复杂的规则,最终却不能工作。几个小时后,他们发现问题没有出现在复杂的部分,反而只是简单的正则表达式错误,如果他们按我上面解释的构造规则的换,问题可能早已经被发现了。在反向工程拆解规则上,这种方法也适用。这种做法将极大降低人们的失望!
在下面的例子中,我总是会假设网站的域名是example.com。此域名很重要,因为它会影响HTTP_HOST变量以及在你的网站上将指定的URL重定向到另一个文件。如果你打算修改你的任何一个例子,以便它可以在你的网站上工作,请记住这一点。如果是这样,只需用你的域名替换“example.com”。例如,Nettuts会将“example.com”改为“nettuts.com”。
删除www
这是最经典的重写规则。这将使得每个通过http://www.example.com访问你网站的人会得到一个硬性的重定向,从而其浏览器的地址栏中也将进行相应更新。
- RewriteEngine on
- RewriteCond %{HTTP_HOST} ^www.example.com$ [NC]
- RewriteRule ^(.*)$ http://example.com/$1 [R=301,L]
- 替代的是一个完整的URL (它以http://开始)
- 替代中包含早期抓取的 $1。
- [R=301]标志将浏览器重定向到重写过的网址,在某种意义上说,这是硬性重定向,它是浏览器加载新的页面,并用新的URL地址更新地址栏。
- [L]标志的意思是这是最后需要分析的一条规则,重写引擎应该停止了。
如果传入的URL是“http://example.com/user/index.html”,那么HTTP_HOST是beenexample.com,不满足条件,重写引擎将会保持网址不变。
禁止盗链
对许多人来说,如果其他网站链接他们的内容,这很好。然而,许多人宁愿防止盗链,为了不支付将本网站内容发送到其他网站产生的额为的带宽。
最常见的、基本的防止盗链是的方法将一些网站加进空白页列表,并阻止其他的一切访问。你可以通过检查引用的内容来找出谁正在从你的网站访问那些内容。HTTP_REFERER头(是的它是这样拼写的)是由正在访问资源的浏览器或客户端设置的。最后,这是不是100%可靠的,但它是禁止大多数盗链的最有效的方法。因此,你只需验证引用是否在空白页列表中。如果引用是不能接受的(空白或其他人的网站),那么你可以给他们发送禁止警告:
- # 给盗链着发送403禁止访问警告。
- RewriteEngine on
- RewriteCond %{HTTP_REFERER} !^http://example.net/?.*$ [NC]
- RewriteCond %{HTTP_REFERER} !^http://example.com/?.*$ [NC]
- RewriteRule .(gif|jpe?g|png|bmp)$ - [F,NC]
被允许访问的域名是“example.net”和“example.com”,在这两种情况下,重写条件验证将失败,替代也不会发生。如果有任何其他域名尝试访问,比如说说“sample.com”企图访问,那么所有的重写条件会验证通过,替代会发生,比且[F]禁止动作将被触发。
给盗链者发送一张警告图片
- # 重定向盗链者请求为 "warning.png"
- RewriteEngine on
- RewriteCond %{HTTP_REFERER} !^http://example.net/?.*$
- RewriteCond %{HTTP_REFERER} !^http://example.com/?.*$ [NC]
- RewriteRule .(gif|jpe?g|png|bmp)$ http://example.com/warning.png [R,NC]
一个窍门:你可以用htaccess检查目前的“URL部分”是不是链接到服务器上的实际文件或Web目录,这是一个创建自定义404“文件未找到”页面的好方法。例如,如果用户试图读取特定目录中不存在的页面时,你可以重定向它们到任何网页,如Index页面或自定义404页。
- # 显示“custom_404.html”页的通用404页
- # 如果请求的页面不是一个文件或目录
- #静态重定向:用户的地址栏的内容不变。
- RewriteEngine on
- RewriteCond %{REQUEST_FILENAME} !-f
- RewriteCond %{REQUEST_FILENAME} !-d
- RewriteRule .* custom_404.html [L]
这是mod_rewrite文件测试的很好的例子。它同bash shell脚本、甚至是Perl脚本文件测试相似。这里的条件检查REQUEST_FILENAME是不是一个文件或目录。在都不是的情况下,则没有这样的文件反馈给这个请求。
如果传入的请求文件无法找到,那么返回一个“custom404.html”页面。注意有没有[R]标志,所以这是一个静态重定向,而不是硬重定向。用户的地址栏将不会改变,但网页的内容是“custom404.html”,简短而简单。
安全第一
如果你有经常使用的mod_rewrite代码片段,并想轻松地分发到其他的服务器或环境中,你可能得要小心。如前所述,任何一个.htaccess文件的无效指令都可能会引起内部服务错误。因此,如果你的代码片段要移动到的环境没有mod_rewrite,你可以先暂停一下。
一个解决这个问题是mod_rewrite模块的“检查“指令”,任何一个模块都有这个指令。只要将你的mod_rewrite代码放到<IfModule>块中,你可以这样设置:
- <IfModule mod_rewrite.c>
- # Turn on
- RewriteEngine on
- # Always remove www (with a hard redirect)
- RewriteCond %{HTTP_HOST} ^www.example.com$ [NC]
- RewriteRule ^(.*)$ http://example.com/$1 [R=301,L]
- # Generic 404 for anyplace on the site
- # ...
- </IfModule>
结论
我希望本教程能够证明mod_rewrite没有想象的那么恐怖,并且事实上通过精心设计,它的复杂性和访问速度问题都可以避免。