一种颗粒度很小的 Laravel 路由文件划分方式

Laravel

我估计我们所有人都遇到过这样的情况，即我们有一个写满路由的超大文件。不骗你，这让我很长一段时间几近抓狂，我不得不想个办法解决这个问题。因此，这就是我最终用来构造路由文件的方法。

最初，我想到了利用路由组方法可以接收文件，这就是 laravel 在RouteServiceProvider 处拆分路由的方式。

 <?php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    /**
     * This namespace is applied to your controller routes.
     *
     * In addition, it is set as the URL generator's root namespace.
     *
     * @var string
     */
    protected $namespace = 'App\Http\Controllers';

    /**
     * Define your route model bindings, pattern filters, etc.
     *
     * @return void
     */
    public function boot()
    {
        //

        parent::boot();
    }

    /**
     * Define the routes for the application.
     *
     * @return void
     */
    public function map()
    {
        $this->mapApiRoutes();

        $this->mapWebRoutes();

        //
    }

    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @return void
     */
    protected function mapWebRoutes()
    {
        Route::middleware('web')
             ->namespace($this->namespace)
             ->group(base_path('routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapApiRoutes()
    {
        Route::prefix('api')
             ->middleware('api')
             ->namespace($this->namespace)
             ->group(base_path('routes/api.php'));
    }
}

我将与用户有关的路由抽象到了一个名为 users.php 的文件中，并将mapApiRoutes 复制为 mapUsersRoutes 并指向到我的 users.php 文件。

 /**
     * Define the routes for the application.
     *
     * @return void
     */
    public function map()
    {
        $this->mapApiRoutes();

        $this->mapWebRoutes();

        $this->mapUsersRoutes();

        //
    }
/**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapUsersRoutes()
    {
        Route::prefix('api')
             ->middleware('api')
             ->namespace($this->namespace)
             ->group(base_path('routes/users.php'));
    }

我知道您在想什么，显然，这并不是最好的解决方案，因为每当我们需要创建新文件时，都必须像之前一样注册它。因此，我不得不改进这个最初的想法。

我想到了将整个应用程序中的公共部分拆分成单独的路由文件，并且我想到我们的所有路由都不能超出已认证、访客和公共路由的范围。

我将路由文件夹的结构优化成下面这样：

├── routes   

│   ├── api    

│   │   ├── public

│   |   │   ├── users.php 

│   │   ├── auth

│   |   │   ├── users.php 

│   │   ├── guest

│   |   │   ├── users.php

乍一看，您可能会认为“嗯，它并没有太大变化，我们还是需要去映射这些文件”。但是，实际上我们可以利用 php 原生提供的名为 glob 的函数，这是一种开箱即用的解决方案，因为我们没有与 laravel 的解决方案耦合。

glob接收一个正则，并且可以在与我们的正则匹配的路径下找到文件名。因此，我们的路由是在特定文件夹下组织的，我们现在可以在这些文件夹下找到所有文件，并将它们注册到其中间件。

<?php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    /**
     * This namespace is applied to your controller routes.
     *
     * In addition, it is set as the URL generator's root namespace.
     *
     * @var string
     */
    protected $namespace = 'App\Http\Controllers';

    /**
     * Define the routes for the application.
     *
     * @return void
     */
    public function map()
    {
        $this->mapAuthRoutes();
        $this->mapGuestRoutes();
        $this->mapPublicRoutes();
//        $this->mapWebRoutes();

        //
    }

    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @return void
     */
    protected function mapWebRoutes()
    {
        Route::middleware('web')
            ->namespace($this->namespace)
            ->group(base_path('routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     *
     * @return void
     */
    protected function mapAuthRoutes()
    {
        foreach (glob(base_path('routes/api/auth/*.php')) as $file) {
            Route::prefix('api')
                ->middleware(['api', 'auth:api'])
                ->group($file);
        }
    }

    protected function mapGuestRoutes()
    {

        foreach (glob(base_path('routes/api/guest/*.php')) as $file) {
            Route::prefix('api')
                ->middleware(['api', 'guest:api'])
                ->group($file);
        }
    }
    protected function mapPublicRoutes()
    {
        foreach (glob(base_path('routes/api/public/*.php')) as $file) {
            Route::prefix('api')
                ->middleware('api')
                ->group($file);
        }
    }
}

现在，无论何时我们创建一个新文件，foreach 都将找到它，因为它是使用正则匹配（该文件位于对应的路径下，并且具有 PHP 扩展名，因此它与我们的正则匹配）。简直太骚了！但是请稍等片刻。

这些文件将如何注册？

如果您研究过 laravel 的生命周期，您就知道服务提供者是 laravel 请求的生命周期的一部分，我们可以利用此功能动态注册我们的路线。

就是这样！我希望您喜欢它。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://dev.to/secmohammed/how-to-separa...

译文地址：https://learnku.com/laravel/t/42989

本文为协同翻译文章，如您发现瑕疵请点击「改进」按钮提交优化建议改进本文

8 人点赞

我们将带你从零开发一个项目并部署到线上，本课程教授 Web 开发中专业、实用的技能，如 Git 工作流、Laravel Mix 前端工作流等。

从零开始带你一步步开发一个 Go 博客项目，让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。

讨论数量: 3

vinhson

931 声望

上面这种也是有弊端的，比如我新加一个文件夹为 mapApiRoutes ，是不是要相对应的添加

protected function mapApiRoutes()
{
    foreach (glob(base_path('routes/api/*.php')) as $file) {
        Route::prefix('api')
            ->middleware('api')
            ->group($file);
    }
}

我的做法：
直接在http 下面创建Routes文件夹，然后在RouteServiceProvider 中注册

Route::group(['namespace' => $this->namespace, 'middleware' => 'web'], function($router){
    foreach (glob(app_path("Http\\Routes"). '/*.php') as $route){
        $this->app->make("App\\Http\\Routes\\". basename($route, '.php'))->map($router);
    }
});

这样可以在Routes里面创建无数个路由。

4年前评论

vinhson

931 声望

上面这种也是有弊端的，比如我新加一个文件夹为 mapApiRoutes ，是不是要相对应的添加

protected function mapApiRoutes()
{
    foreach (glob(base_path('routes/api/*.php')) as $file) {
        Route::prefix('api')
            ->middleware('api')
            ->group($file);
    }
}

我的做法：
直接在http 下面创建Routes文件夹，然后在RouteServiceProvider 中注册

Route::group(['namespace' => $this->namespace, 'middleware' => 'web'], function($router){
    foreach (glob(app_path("Http\\Routes"). '/*.php') as $route){
        $this->app->make("App\\Http\\Routes\\". basename($route, '.php'))->map($router);
    }
});

这样可以在Routes里面创建无数个路由。

4年前评论

虢國技醬

2 声望

:+1:

4年前评论

ixianming

2 声望

不妨试试这个路由管理扩展：

https://github.com/ixianming/laravel-route...

支持 Laravel 5.3 及以上版本，支持 Laravel 6，Laravel 7。基于 Laravel 的路由服务提供者，提供更便捷、强大的路由管理服务。安装扩展包后，依旧可以在 App\Providers\RouteServiceProvider 中的 boot() 方法中定义的路由模型的显式绑定、过滤器、自定义解析逻辑等。

这个扩展包的功能：

可以设置允许匹配路由文件的中间件组。

扩展包会使用默认或自定义规则为这些中间件组分配对应的路由文件，并执行加载。
可以为同一中间件组创建多个路由文件，并且可以将这些路由文件放在 routes 目录下的任何一个地方。

路由文件的名称可以使用默认规则，也可以由开发者自定义路由文件与中间件组的匹配规则。
可以将异常信息的响应格式设置为全局默认 Json 输出，也可以为各个允许匹配路由文件的中间件组独立设置其异常信息的响应格式是否为 Json。（独立设置优先级高于全局默认设置）
在全部路由中检查是否存在重复的 URL（含域名限制的完整的 URL）。
可以设置是否允许注册闭包路由。
可以设置命名路由的名称是否允许重名。
可以设置是否允许重复使用控制器。
可以自定义各个允许匹配路由文件的中间件组所使用的根命名空间 namespace。
可以自定义各个允许匹配路由文件的中间件组所使用的子域名限制 domain。
可以自定义各个允许匹配路由文件的中间件组所使用的路由前缀 prefix。
可以自定义各个允许匹配路由文件的中间件组所使用的路由名称前缀 name。
可以自定义各个允许匹配路由文件的中间件组所使用的路由参数正则表达式约束 where。

4年前评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助

一种颗粒度很小的 Laravel 路由文件划分方式

高认可度评论：

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

一种颗粒度很小的 Laravel 路由文件划分方式

高认可度评论：

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

请登录