[翻译] 这个包可以让你在浏览器上查看路由
路由是 Laravel 非常的功能,通过路由文件,你可以获得应用的俯瞰视角,以及一份显示 URL 和代码文件对应关系的地图。
默认情况下,Laravel 提供了一个方便的命令 php artisan route:list ,用于在终端中以表格方式列出你的路由。这里再向您推荐一个第三方包 Pretty routes ,提供通过浏览器查看路由的方式。
Pretty Routes 安装
首先,通过 Composer 安装 Pretty routes:
composer require garygreen/pretty-routes
然后在 config/app.php 添加它的 Service provider :
'providers' => [
...
PrettyRoutes\ServiceProvider::class,
最后一步,生成它的配置文件,以方便你自己按需要调整配置:
php artisan vendor:publish --provider="PrettyRoutes\ServiceProvider"
就这些,Laravel 安装第三方包步骤的老三样。
Pretty routes 综述
打开 Pretty routes 的配置文件 config/pretty-routes.php,你会看到以下内容:
return [
/**
* The endpoint to access the routes.
*/
'url' => 'routes',
/**
* The methods to hide.
*/
'hide_methods' => [
'HEAD',
],
];
首先,'url' 用于指定你访问 Pretty routes GUI 的路径。然后,你想在显示的路由中隐藏特定的 HTTP 方法,你可以将方法添加在 'hide_methods' 数组中。
现在你可以在浏览器中访问 Pretty routes URL,来查看应用的路由啦。你可以看到一个更好看的路由列表,并且显示出每一条路由的 HTTP 方法、路径、名称、动作,和生效的中间件。
该包会查看 app.debug 设置的值,仅在你的应用处于 debug 模式时才显示路由。
核心
如果你想知道 Pretty routes 如何工作的,可以查看 pretty-routes/src/MainMiddleware.php 代码文件:
在第18行有一个条件判断,它检查请求的 URL 是否等于你为访问 Pretty routes 所指定的路由。如果是,则使用 getRoutes 方法读取所有路由并且填充路由变量,然后将变量传入 Pretty routes 视图文件。最后,视图会通过一些列的 foreach 语句和格式化操作,构造出你在浏览器中看到的那个好看的路由列表。
本作品采用《CC 协议》,转载必须注明作者和本文链接
推荐文章: