网址重写(URL Rewriting)

Apache 和 mod_rewrite (以及 .htaccess)

虽然 CakePHP 编写的就是要自动和 mod_rewrite 一起使用——而且通常可以——但是我们的确注意到一些用户在他们的系统中很难使所有东西在一起顺利地运行。

这里有一些办法你可以尝试，来让它正确地运行。首先，查看 httpd.conf。(确保你是在修改系统级的 httpd.conf，而不是用户级或者站点级的 httpd.conf。)

这些文件随(Linux)发行版本的不同和 Apache 版本的不同而有所变化。你也可以查看http://wiki.apache.org/httpd/DistrosDefaultLayout 以获取更多的信息。

  • 确保允许 .htaccess 优先(override)，并且正确的 DocumentRoot 的 AllowOverride设置为 All。你应当看到类似于:
  1. # Apache 可以访问的每个目录可以设置该目录(及其子目录)允许及/或不允许何种服
  2. # 务和特性。
  3. #
  4. # 首先，我们配置 "default" 为很有限的一组特性。
  5. #
  6. <Directory />
  7.     Options FollowSymLinks
  8.     AllowOverride All
  9. #    Order deny,allow
  10. #    Deny from all
  11. </Directory>

对于 apache 2.4 及更高版本的用户，你需要象下面这样修改 httpd.conf 的配置文件或者 虚拟主机（Virtual Host）的配置:

  1. <Directory /var/www/>
  2.      Options FollowSymLinks
  3.      AllowOverride All
  4.      Require all granted
  5. </Directory>
  • 确保正确加载了 mod_rewrite。你应当看到类似于:
  1. LoadModule rewrite_module libexec/apache2/mod_rewrite.so

在很多系统中缺省情况下这是被注释掉的，这样你就只需去掉开头的#符号。

做完修改后，重启 Apache，确保设置起作用。

核实你的 .htaccess 文件的确在正确的目录中。某些操作系统认为以'.'开头的文件是隐藏的，因此不会拷贝这些文件。

  • 确保你的 CakePHP 拷贝来自官网的下载部分或者我们的 Git 库，并且查看各个.htaccess 文件以确保解压正确。

CakePHP 根目录(需要拷贝到你的文档目录; 会把所有的输入转向到你的 CakePHP 应用程序):

  1. <IfModule mod_rewrite.c>
  2.    RewriteEngine on
  3.    RewriteRule    ^$ app/webroot/    [L]
  4.    RewriteRule    (.*) app/webroot/$1 [L]
  5. </IfModule>

CakePHP app 目录(bake 会把它拷贝到你的应用程序的最高一级目录):

  1. <IfModule mod_rewrite.c>
  2.    RewriteEngine on
  3.    RewriteRule    ^$    webroot/    [L]
  4.    RewriteRule    (.*) webroot/$1    [L]
  5. </IfModule>

CakePHP 的 webroot 目录(bake 会把它拷贝到你的应用程序的 webroot 目录):

  1. <IfModule mod_rewrite.c>
  2.     RewriteEngine On
  3.     RewriteCond %{REQUEST_FILENAME} !-d
  4.     RewriteCond %{REQUEST_FILENAME} !-f
  5.     RewriteRule ^(.*)$ index.php [QSA,L]
  6. </IfModule>

如果你的 CakePHP 网站仍然有 mod_rewrite 的问题，你也许可以尝试修改虚拟主机的设置。在 Ubuntu 系统中，编辑文件 /etc/apache2/sites-available/default (其位置取决于发行版本)。在该文件中，确保 AllowOverride None 改为AllowOverride All ，所以就是:

  1. <Directory />
  2.     Options FollowSymLinks
  3.     AllowOverride All
  4. </Directory>
  5. <Directory /var/www>
  6.     Options Indexes FollowSymLinks MultiViews
  7.     AllowOverride All
  8.     Order Allow,Deny
  9.     Allow from all
  10. </Directory>

在 Mac OSX 中，另一个方法是使用virtualhostx 工具来创建一个虚拟主机，指向你的目录。

对于很多托管服务(GoDaddy, 1and1)，你的 web 服务器实际上是从一个已经使用mod_rewrite 的用户目录提供的。如果你把 CakePHP 安装到一个用户目录(http://example.com/~username/cakephp/)，或者任何已经使用 mod_rewrite 的网址结构，你需要在 CakePHP 使用的 .htaccess 文件(/.htaccess、/app/.htaccess、/app/webroot/.htaccess)中添加 RewriteBase 语句。

这可以加在 RewriteEngine 指令所在的同一个小节中，例如，你的 webroot 的.htaccess 文件可以象这样:

  1. <IfModule mod_rewrite.c>
  2.     RewriteEngine On
  3.     RewriteBase /path/to/cake/app
  4.     RewriteCond %{REQUEST_FILENAME} !-d
  5.     RewriteCond %{REQUEST_FILENAME} !-f
  6.     RewriteRule ^(.*)$ index.php [QSA,L]
  7. </IfModule>

这些改动的细节取决于你的设置，而且可能包含与 CakePHP 无关的其它东西。更多信息请参考 Apache 的在线文档。

  • (可选) 要改善生产环境的设置，你应当让 CakePHP 避免解析非法的资源。可以把webroot 的 .htaccess 文件修改成象下面这样:
  1. <IfModule mod_rewrite.c>
  2.     RewriteEngine On
  3.     RewriteBase /path/to/cake/app
  4.     RewriteCond %{REQUEST_FILENAME} !-d
  5.     RewriteCond %{REQUEST_FILENAME} !-f
  6.     RewriteCond %{REQUEST_URI} !^/(app/webroot/)?(img|css|js)/(.*)$
  7.     RewriteRule ^(.*)$ index.php [QSA,L]
  8. </IfModule>

上面的设置就会简单地避免错误的资源被送往 index.php，而显示你的 web 服务器的404页面。

另外，你可以创建一个匹配的 HTML 404 页面，或者添加 ErrorDocument 指令来使用 CakePHP 内置的 404 页面:

  1. ErrorDocument 404 /404-not-found

nginx 的友好网址

nginx 不像 Apache 那样使用 .htaccess 文件，所以必须在站点的配置中创建这些重写网址。根据你的设置，你要修改这个(配置)，不过至少你要让 PHP 作为 FastCGI 实例来运行。

  1. server {
  2.     listen   80;
  3.     server_name www.example.com;
  4.     rewrite ^(.*) http://example.com$1 permanent;
  5. }
  6.  
  7. server {
  8.     listen   80;
  9.     server_name example.com;
  10.  
  11.     # root directive should be global
  12.     root   /var/www/example.com/public/app/webroot/;
  13.     index  index.php;
  14.  
  15.     access_log /var/www/example.com/log/access.log;
  16.     error_log /var/www/example.com/log/error.log;
  17.  
  18.     location / {
  19.         try_files $uri $uri/ /index.php?$args;
  20.     }
  21.  
  22.     location ~ \.php$ {
  23.         try_files $uri =404;
  24.         include /etc/nginx/fastcgi_params;
  25.         fastcgi_pass    127.0.0.1:9000;
  26.         fastcgi_index   index.php;
  27.         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
  28.     }
  29. }

如果因为某种奇怪的原因，你不能改变你的根目录，而需要从一个象example.com/subfolder/这样的子目录来运行你的项目，你就不得不在每个请求中加入"/webroot"。

  1. location ~ ^/(subfolder)/(.*)? {
  2.    index  index.php;
  3.  
  4.    set $new_uri /$1/webroot/$2;
  5.    try_files $new_uri $new_uri/ /$1/index.php?$args;
  6.  
  7.    ... php handling ...
  8. }

注解

较新的 PHP-FPM 配置设置为监听 php-fpm 套接字（socket），而不是 127.0.0.1地址的 9000 TCP 端口。如果你使用上面的配置，遇到 502 bad gateway 的错误，尝试把 fastcgi_pass 从 TCP 端口改为套接字路径（例如：fastcgi_pass unix:/var/run/php5-fpm.sock;）。

IIS7 的网址重写 (Windows 主机)

IIS7 本身不支持 .htaccess 文件。虽然有插件(add-on)可增加这种支持，但是也可以把htaccess 规则导入 IIS，来使用 CakePHP 的原生重写。为此，按照如下步骤进行:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  3.     <system.webServer>
  4.         <rewrite>
  5.             <rules>
  6.                 <rule name="Rewrite requests to test.php"
  7.                   stopProcessing="true">
  8.                     <match url="^test.php(.*)$" ignoreCase="false" />
  9.                     <action type="Rewrite" url="app/webroot/test.php{R:1}" />
  10.                 </rule>
  11.                 <rule name="Exclude direct access to app/webroot/*"
  12.                   stopProcessing="true">
  13.                     <match url="^app/webroot/(.*)$" ignoreCase="false" />
  14.                     <action type="None" />
  15.                 </rule>
  16.                 <rule name="Rewrite routed access to assets(img, css, files, js, favicon)"
  17.                   stopProcessing="true">
  18.                     <match url="^(img|css|files|js|favicon.ico)(.*)$" />
  19.                     <action type="Rewrite" url="app/webroot/{R:1}{R:2}"
  20.                       appendQueryString="false" />
  21.                 </rule>
  22.                 <rule name="Rewrite requested file/folder to index.php"
  23.                   stopProcessing="true">
  24.                     <match url="^(.*)$" ignoreCase="false" />
  25.                     <action type="Rewrite" url="index.php"
  26.                       appendQueryString="true" />
  27.                 </rule>
  28.             </rules>
  29.         </rewrite>
  30.     </system.webServer>
  31. </configuration>

一旦创建了含有正确的 IIS 方式的重写规则的 web.config 文件，CakePHP 的链接、CSS、JavaScript和路由就应该可以正常工作了。

lighttpd 的网址重写

Lighttpd 不支持 .htaccess 功能，故而可以删除所有 .htaccess 文件。在 lighttpd 的配置中，确保启用了 "mod_rewrite"。增加一行:

  1. url.rewrite-if-not-file =(
  2.     "^([^\?]*)(\?(.+))?$" => "/index.php?url=$1&$3"
  3. )

Hiawatha 的网址重写

在 Hiawatha 中使用 CakePHP 所要求的 UrlToolkit 规则是:

  1. UrlToolkit {
  2.    ToolkitID = cakephp
  3.    RequestURI exists Return
  4.    Match .* Rewrite /index.php
  5. }

我不/无法使用网址重写

如果在你的 web 服务器上不想或者不能使用网址重写，请参考核心配置。