Laravel 分割 routes.php 路由文件的最佳方式

原文网址:http://blog.tanteng.me/2016/08/laravel-rou...

Laravel 的路由功能很强大,路由规则默认都定义在 routes.php 文件中,但是随着项目越来越大,我们需要的定义的规则越来越多,如果几百上千个路由都定义在一个文件中,如何去维护?如果不同的人都在同一个文件定义路由,这就造成了冲突,因此我们有必要将 routes.php 文件分割成多个文件,可以按照功能模块来划分,下面介绍一种很优雅的方式。

在 app/Providers/RouteServiceProvider.php 的 map 方法中可以如下定义:

public function map(Router $router)
{
    $router->group(['namespace' => $this->namespace], function ($router) {
        //require app_path('Http/routes.php');
        foreach (glob(app_path('Http//Routes') . '/*.php') as $file) {
            $this->app->make('App\\Http\\Routes\\' . basename($file, '.php'))->map($router);
        }
    });
}

文件夹组织结构如图:

分割routes.php文件

这样它就会遍历 app/Http/Routes/ 文件夹下的文件,遍历每个文件的 map 方法,其中每个文件的结构都类似,举个例子:

<?php
namespace App\Http\Routes;

use Illuminate\Contracts\Routing\Registrar;

class HomeRoutes
{
    public function map(Registrar $router)
    {
        $router->group(['domain' => 'www.tanteng.me', 'middleware' => 'web'], function ($router) {
            $router->auth();
            $router->get('/', ['as' => 'home', 'uses' => 'IndexController@index']);
            $router->get('/blog', ['as' => 'index.blog', 'uses' => 'BlogController@index']);
            $router->get('/resume', ['as' => 'index.resume', 'uses' => 'IndexController@resume']);
            $router->get('/post', ['name' => 'post.show', 'uses' => 'ArticleController@show']);
            $router->get('/contact', ['as' => 'index.contact', 'uses' => 'IndexController@contact']);
            $router->post('/contact/comment', ['uses' => 'IndexController@postComment']);
            $router->get('/travel', ['as' => 'index.travel', 'uses' => 'TravelController@index']);
            $router->get('/travel/latest', ['as' => 'travel.latest', 'uses' => 'TravelController@latest']);
            $router->get('/travel/{destination}/list', ['as' => 'travel.destination', 'uses' => 'TravelController@travelList']);
            $router->get('/travel/{slug}', ['uses' => 'TravelController@travelDetail']);
            $router->get('/sitemap.xml', ['as' => 'index.sitemap', 'uses' => 'IndexController@sitemap']);
        });
    }
}

通过把路由规则分割写到不同的文件中,这样一来,就可以根据功能模块分开管理路由文件了。此外,你也可以简单的分割,直接把 routes.php 中的定义拆散成多个文件,通过 require 的方式引入,但是哪个更好,一目了然。

那么这样路由分开多个文件后岂不是增加调用次数,会不会影响性能?答案是不必担心。通过 Laravel 的命令:

php artisan route:cache

生成路由缓存文件后,路由只会读取缓存文件的路由规则,因此不会影响性能,这样做让开发更高效和规范。

本帖已被设为精华帖!
本帖由 Summer 于 3年前 加精
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 19

思路很巧妙。:+1:

5.3 已经提供了官方的路由方式 https://github.com/laravel/laravel/blob/de...

    public function map()
    {
        $this->mapWebRoutes();
        $this->mapApiRoutes();
        //
    }

    protected function mapWebRoutes()
    {
        Route::group([
            'middleware' => 'web',
            'namespace' => $this->namespace,
        ], function ($router) {
            require base_path('routes/web.php');
        });
    }

    protected function mapApiRoutes()
    {
        Route::group([
            'middleware' => ['api', 'auth:api'],
            'namespace' => $this->namespace,
            'prefix' => 'api',
        ], function ($router) {
            require base_path('routes/api.php');
        });
    }

你这个方案需要去 new 这些路由对象,然后方法调用。require 和你的这个方法同样都是对文件读一遍,但是不需要 new 对象。

3年前 评论
萧晔离

不错,我是直接require了

3年前 评论

思路很巧妙。:+1:

5.3 已经提供了官方的路由方式 https://github.com/laravel/laravel/blob/de...

    public function map()
    {
        $this->mapWebRoutes();
        $this->mapApiRoutes();
        //
    }

    protected function mapWebRoutes()
    {
        Route::group([
            'middleware' => 'web',
            'namespace' => $this->namespace,
        ], function ($router) {
            require base_path('routes/web.php');
        });
    }

    protected function mapApiRoutes()
    {
        Route::group([
            'middleware' => ['api', 'auth:api'],
            'namespace' => $this->namespace,
            'prefix' => 'api',
        ], function ($router) {
            require base_path('routes/api.php');
        });
    }

你这个方案需要去 new 这些路由对象,然后方法调用。require 和你的这个方法同样都是对文件读一遍,但是不需要 new 对象。

3年前 评论

思路确实很巧妙 :+1:

3年前 评论

@zhuzhichao 这样还是在一个文件啊,不利于同时多人修改,如果是大项目按模块分开的,最好是改各自的路由文件比较好。

3年前 评论

@纸牌屋弗兰克 多写几个 map 方法, route 目录下面不是只有这两个文件的,可以根据模块来添加。

3年前 评论

@zhuzhichao 看到了,刚没注意,这也是require引入路由文件,这个方法也不错,不过如果需要新加一个“分类”,需要改这个文件,如果是本文的方式,直接在目录下新建路由文件就可以了。

你提供的这个方法既然是官方的,可能以后都按照这样来吧,统一一点比较好。

3年前 评论

@纸牌屋弗兰克 其实你这种方式还是不错的。而官方这样做我猜测是因为 routes.php 文件的内容即不在命名空间内,又是配置类的东西,逻辑相对独立,拆出去放根目录和 config app database 文件夹同级是十分清晰的选择。

3年前 评论

参考这篇文章的代码,我把这部分分割路由的添加到一个包里面了。可以通过composer安装

https://github.com/bluegeek/route-for-laravel

我加入了

php artisan make:route HomeRoutes

命令。

谢谢

3年前 评论
chongyi

我拆的更细,因为我们现在开发的 ERP 项目层级太多,不仅仅只是路由做了拆分,大概是这样的:

file

其实 Laravel 框架最大的好处就是结构松散(不是设计思想的松散)易于调整,确实适合大项目开发。

3年前 评论
Summer

友链已加上,记得回链 :stuck_out_tongue_winking_eye:

file

3年前 评论

@Summer hello,麻烦换一下我博客的logo,最新ico如图:ico

3年前 评论

:+1: 我是直接 require 了

    public function map(Router $router)
    {
        $router->group(['namespace' => $this->namespace], function ($router) {
            //require app_path('Http/routes.php');

            foreach (glob(app_path('Http/Routes') . '/*.php') as $file) {
                require $file;
            }
        });
    }
3年前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!