欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-03-10 12:39:37
我估计我们所有人都遇到过这样的情况,即我们有一个写满路由的超大文件。不骗你,这让我很长一段时间几近抓狂,我不得不想个办法解决这个问题。 因此,这就是我最终用来构造路由文件的方法。 最初,我想到了利用路由组方法可以接收文件,这就是 laravel 在 RouteServiceProvider 处拆分路 ......

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

最初,我想到了利用路由组方法可以接收文件,这就是 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 请求的生命周期的一部分,我们可以利用此功能动态注册我们的路线。

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

译文地址:

以上就是一种颗粒度很小的 laravel 路由文件划分方式

更多学习内容请访问:

腾讯t3-t4标准精品php架构师教程目录大全,只要你看完保证薪资上升一个台阶(持续更新)