
部署在子目录的烦恼:路由为何“失灵”?
作为 PHP 开发者,我们经常需要将应用程序部署到服务器上。理想情况下,我们希望应用能直接运行在网站的根目录,比如 www.yourdomain.com/。然而,在实际项目中,出于各种原因(例如共享主机、多应用部署、测试环境等),我们可能需要将应用部署到子目录,例如 www.yourdomain.com/my-app/。
问题就出在这里!当你将应用部署到子目录时,请求的 URI 路径会带上这个子目录前缀。比如,用户访问 www.yourdomain.com/my-app/products/1,你的 PHP 应用接收到的 $_SERVER['REQUEST_URI'] 可能是 /my-app/products/1。但是,你的路由系统通常是按照根目录来设计的,它期望的是 /products/1 这样的路径。
这种路径不匹配导致的结果就是:
-
路由失效: 你的路由器找不到匹配的规则,因为
/my-app/products/1和/products/1是不同的。 - 404 错误: 最终用户看到的是“页面未找到”的错误。
-
手动修改的痛苦: 为了解决这个问题,你可能尝试过手动在代码中
str_replace或preg_replace来移除 URI 前缀。这种做法不仅增加了代码的复杂性,而且一旦部署路径发生变化,你又得重新修改,既不优雅也不健壮。
难道就没有一个通用、简洁的方法来处理这个问题吗?当然有!Composer 再次成为了我们的救星。
引入 middlewares/base-path:优雅的路径前缀移除器
正当我为这些部署路径的“小麻烦”而烦恼不已时,我通过 Composer 发现了一个强大而简洁的中间件——middlewares/base-path。这个库专门为解决上述问题而生,它遵循 PSR-7 和 PSR-15 标准,能够智能地从请求的 URI 路径中移除预设的基路径前缀。
简单来说,如果你的应用部署在 /my-app 子目录下,并且收到了 /my-app/products/1 的请求,middlewares/base-path 会自动将其转换为 /products/1,然后将这个“干净”的 URI 传递给你的路由系统。这样,你的路由就能像应用部署在根目录一样正常工作了,无需修改任何路由配置!
安装:Composer 一行命令搞定
middlewares/base-path 的安装过程非常简单,只需通过 Composer 引入即可:
composer require middlewares/base-path
这个包的依赖非常轻量,主要需要一个 PSR-7 HTTP 消息实现(如 Diactoros, Guzzle, Slim 等)和一个 PSR-15 中间件调度器。现代 PHP 框架和微服务应用基本都满足这些条件。
使用示例:让路由回归“纯粹”
让我们看看如何在实际项目中应用 middlewares/base-path。
1. 基本用法:移除路径前缀
假设你有一个中间件调度器(例如使用 middlewares/utils 提供的 Dispatcher),你可以这样设置基路径:
getUri()->getPath();
// 假设我们的路由期望的是 /post/123
if ($path === '/post/123') {
$response = new \GuzzleHttp\Psr7\Response();
$response->getBody()->write('Hello from /post/123!');
return $response;
}
// 如果没有匹配,继续处理或者返回404
return $handler->handle($request);
}
}
// 假设你的应用部署在 /my-app 目录下
// Dispatcher::run 模拟了请求处理流程
$response = Dispatcher::run([
new BasePath('/my-app'), // 设置要移除的基路径前缀
new MyRouter(), // 你的应用路由中间件
function (ServerRequestInterface $request) { // 默认处理,如果路由未匹配
$response = new \GuzzleHttp\Psr7\Response(404);
$response->getBody()->write('404 Not Found. Original Path: ' . $request->getUri()->getPath());
return $response;
}
], \GuzzleHttp\Psr7\ServerRequest::fromGlobals()->withUri(new \GuzzleHttp\Psr7\Uri('/my-app/post/123'))); // 模拟一个请求
echo $response->getBody(); // 输出:Hello from /post/123!在这个例子中,即使模拟的请求 URI 是 /my-app/post/123,经过 BasePath('/my-app') 处理后,MyRouter 接收到的路径就是 /post/123,从而成功匹配并返回正确的内容。
2. 处理重定向:fixLocation()
当你的应用需要发出重定向(例如,用户登录后跳转到仪表盘),并且你希望重定向的 Location 头也能自动带上子目录前缀时,fixLocation() 方法就派上用场了。
fixLocation(), // 启用修复Location头功能
function () {
// 你的应用返回一个重定向响应,Location头是相对路径
return (new Response(301))->withHeader('Location', '/dashboard');
}
], ServerRequest::fromGlobals()->withUri(new Uri('/my-app/any-path')));
// 检查响应头
echo $response->getHeaderLine('Location'); // 输出:/my-app/dashboard如果没有 fixLocation(),Location 头会是 /dashboard,这可能导致浏览器重定向到 www.yourdomain.com/dashboard 而非 www.yourdomain.com/my-app/dashboard,从而引发 404。fixLocation() 完美解决了这个问题。
3. 保留原始路径:attribute()
有时,你可能需要在应用内部访问原始的、未处理的 URI 路径(例如用于日志记录或调试)。attribute() 方法允许你将原始路径存储在请求的一个属性中:
attribute('original-uri-path'), // 将原始路径存入 'original-uri-path' 属性
function (ServerRequestInterface $request) {
$originalPath = $request->getAttribute('original-uri-path');
$processedPath = $request->getUri()->getPath();
$response = new \GuzzleHttp\Psr7\Response();
$response->getBody()->write("Original Path: {$originalPath}\n");
$response->getBody()->write("Processed Path: {$processedPath}\n");
return $response;
}
], \GuzzleHttp\Psr7\ServerRequest::fromGlobals()->withUri(new \GuzzleHttp\Psr7\Uri('/my-app/some/page')));
echo $response->getBody();
// 输出:
// Original Path: /my-app/some/page
// Processed Path: /some/page总结:middlewares/base-path 的优势与实践效果
middlewares/base-path 配合 Composer,为我们带来了以下显著优势:
- 部署灵活性: 无论应用部署在根目录还是任意子目录,核心代码和路由配置都无需改动,极大提升了部署的便利性。
- 代码整洁性: 告别手动解析和修改 URI 的脏活累活,代码变得更加清晰、专注于业务逻辑。
- PSR 标准兼容: 作为 PSR-7/15 中间件,它能无缝集成到任何支持这些标准的现代 PHP 框架或自定义应用中。
-
健壮性: 自动处理重定向的
Location头,避免了子目录部署下常见的重定向错误。 - 可维护性: 将路径前缀处理逻辑集中在一个地方,易于管理和更新。
在实际项目中,通过引入 middlewares/base-path,我彻底解决了因部署路径变化而导致的路由问题,让团队成员能够更专注于开发功能,而不是浪费时间在环境配置的调试上。它是一个小而精悍的工具,却能带来巨大的开发效率提升和部署上的便利。
如果你也正被子目录部署的路由问题所困扰,那么强烈建议你尝试一下 middlewares/base-path。它将是你的 PHP 应用部署工作流中不可或缺的利器!











