如何在Laravel中获取已注册的路由路径列表？

Question

我希望找到一种在 Laravel 4 中创建包含已注册路由路径的数组的方法。

基本上，我想要返回类似于以下列表的内容：

/
/login
/join
/password

我确实找到了一个方法Route::getRoutes()，它返回一个包含路径信息以及资源的对象，但是路径信息是受保护的，我无法直接访问这些信息。

有没有其他方法可以实现这个功能？也许有不同的方法可以使用？

- Kevin Jung

---

可能是重复的问题：在Laravel 4中显示已注册的路由 - mniess

Answer 1

Route::getRoutes() 返回一个RouteCollection。 在每个元素上，您可以使用简单的$route->getPath() 来获取当前路由的路径。

每个受保护的参数都可以使用标准getter方法进行获取。

循环操作的工作方式如下：

$routeCollection = Illuminate\Support\Facades\Route::getRoutes();

foreach ($routeCollection as $value) {
    echo $value->getPath();
}

- netvision73

---

你是如何遍历集合的？ - Rajan Rawal

我可以在自定义帮助器中使用这个吗？ - poashoas

@RajanRawal Collection 实现了 ArrayAccess 接口，使它们可以像数组一样运行，并且可以在 foreach 中使用。 - Andrew Brown

如果您想避免使用Facade，可以注入 Illuminate\Routing\Router。 - Andrew Brown

如果有人需要的话，使用 Laravel >=5.5 版本，你可以这样做：`$routes = array_map(function (\Illuminate\Routing\Route $route) { return $route->uri; }, (array) Route::getRoutes()->getIterator());`该代码可以获取 Laravel 应用程序中所有路由的 URI。 - siannone

Answer 2

你可以使用控制台命令：

Laravel 4 如问题中所询问的那样

php artisan routes

Laravel 5 更加实际

php artisan route:list

帮助器 (Laravel 4)：

Usage:
 routes [--name[="..."]] [--path[="..."]]

Options:
 --name                Filter the routes by name.
 --path                Filter the routes by path.
 --help (-h)           Display this help message.
 --quiet (-q)          Do not output any message.
 --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for     more verbose output and 3 for debug
 --version (-V)        Display this application version.
 --ansi                Force ANSI output.
 --no-ansi             Disable ANSI output.
 --no-interaction (-n) Do not ask any interactive question.
 --env                 The environment the command should run under.

- rinomau

---

现在这是 php artisan route:list 命令。 - Marklar

这对于Laravel 5是正确的，但问题是针对Laravel 4的。 - Zachary Weixelbaum

在 Laravel 8 中，php artisan route:list 命令返回“在 'route' 命名空间中没有定义命令。”的错误信息。有什么建议吗？ - feeela

Answer 3

对于Laravel 5，你可以使用Artisan命令

php artisan route:list代替php artisan routes。

- berkayk

---

这并不适用于5.4版本。 - Robert Johnstone

Answer 4

改进 @jeanfrg 的答案

它使用了一些已经被弃用的函数。在编辑答案时会显示错误，因此在这里发布。

Laravel 6、7和8

将其放在routes/web.php中。

Route::get('routes', function () {
    $routeCollection = Route::getRoutes();

    echo "<table style='width:100%'>";
    echo "<tr>";
    echo "<td width='10%'><h4>HTTP Method</h4></td>";
    echo "<td width='10%'><h4>Route</h4></td>";
    echo "<td width='10%'><h4>Name</h4></td>";
    echo "<td width='70%'><h4>Corresponding Action</h4></td>";
    echo "</tr>";
    foreach ($routeCollection as $value) {
        echo "<tr>";
        echo "<td>" . $value->methods()[0] . "</td>";
        echo "<td>" . $value->uri() . "</td>";
        echo "<td>" . $value->getName() . "</td>";
        echo "<td>" . $value->getActionName() . "</td>";
        echo "</tr>";
    }
    echo "</table>";
});

演示: 通过<url>/routes进行访问

- Darshan Gada

Answer 5

我创建了一个路由，它可以在HTML表格中列出每个路由及其相应的详细信息。

Route::get('routes', function() {
    $routeCollection = Route::getRoutes();

    echo "<table style='width:100%'>";
        echo "<tr>";
            echo "<td width='10%'><h4>HTTP Method</h4></td>";
            echo "<td width='10%'><h4>Route</h4></td>";
            echo "<td width='10%'><h4>Name</h4></td>";
            echo "<td width='70%'><h4>Corresponding Action</h4></td>";
        echo "</tr>";
        foreach ($routeCollection as $value) {
            echo "<tr>";
                echo "<td>" . $value->getMethods()[0] . "</td>";
                echo "<td>" . $value->getPath() . "</td>";
                echo "<td>" . $value->getName() . "</td>";
                echo "<td>" . $value->getActionName() . "</td>";
            echo "</tr>";
        }
    echo "</table>";
});

- jeanfrg

Answer 6

//Laravel >= 5.4

//Controller index()
$app = app();
$routes = $app->routes->getRoutes();
return view ('Admin::routes.index',compact('routes'));

//view
<table id="routes-table" class="table table-bordered table-responsive">
       <thead>
                <tr>
                    <th>uri</th>
                    <th>Name</th>
                    <th>Type</th>
                    <th>Method</th>
                </tr>
       </thead>
       <tbody>
                @foreach ($routes as $route )
                    <tr>
                        <td>{{$route->uri}}</td>
                        <td>{{$route->getName()}}</td>
                        <td>{{$route->getPrefix()}}</td>
                        <td>{{$route->getActionMethod()}}</td>
                    </tr>
                @endforeach
        </tbody>
</table>

- Carlos Andrade

---

请问你能否编辑一下你的回答，并简要解释一下它的作用和工作原理？谢谢！ - Fabio says Reinstate Monica

@FabioTurati 我们只是从 Laravel 的 getRoutes() 方法中获取所有路由，然后将它们发送到 template，最后在循环遍历所有路由时使用数据创建一个普通的 html table。例如，我们显示你分配的 uri（例如 /home）、name（例如 home_route）和其他信息。 - Gideon Maina

适用于Laravel 5.6.x的工作 - Vicky Gill

Answer 7

更好的方法是注册路由并直接使用Artisan输出在Web浏览器中进行阅读。

Route::get('routes', function() {
     \Artisan::call('route:list');
     return \Artisan::output();
});

- Jose Palazuelos

---

为了更好的格式，请将闭包的最后一行改为 return '<pre>' . \Artisan::output() . '</pre>';。 - parrker9

有什么想法如何过滤这个？例如，对于以 api/ 开头的路由。 - utdev

@utdev 我知道这是旧评论，你可以像这样传递参数来过滤 \Artisan::call('route:list', ['--path' => 'api']);。 - Meow Kim

Answer 8

如果您已经编译了形如/login/{id}的路由，并且您只想要前缀：

foreach (Route::getRoutes() as $route) {
    $compiled = $route->getCompiled();
    if(!is_null($compiled))
    {
        var_dump($compiled->getStaticPrefix());
    }
}

- Luis Pozenato

Answer 9

Code

Laravel <= 5.3

/** @var \Illuminate\Support\Facades\Route $routes  */
$routes = Route::getRoutes();
foreach ($routes as $route) {
    /** @var \Illuminate\Routing\Route $route  */
    echo $route->getPath() .  PHP_EOL;
}

Laravel >= 5.4

/** @var \Illuminate\Support\Facades\Route $routes  */
$routes = Route::getRoutes();
foreach ($routes as $route) {
    /** @var \Illuminate\Routing\Route $route  */
    echo $route->uri. PHP_EOL;
}

Artisan

Laravel 4

php artisan routes

Laravel 5

php artisan route:list

- pablorsk

Answer 10

$routeList = Route::getRoutes();

foreach ($routeList as $value)
{
    echo $value->uri().'<br>';
}

use Illuminate\Support\Facades\Route;

Laravel 5.4上，它能够正常工作，100%。

- Turan Zamanlı