浅谈一种Laravel路由文件划分方式

吾爱主题阅读：183 2021-11-17 16:06:00 评论：0

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 <?php namespace App\Providers; use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider; use Illuminate\Support\Facades\Route; class RouteServiceProvider extends ServiceProvider{ protected $namespace = 'App\Http\Controllers' ; public function boot(){ parent::boot(); } public function map(){ $this ->mapApiRoutes(); $this ->mapWebRoutes(); } protected function mapWebRoutes(){ Route::middleware( 'web' ) -> namespace ( $this -> namespace ) ->group(base_path( 'routes/web.php' )); } protected function mapApiRoutes(){ Route::prefix( 'api' ) ->middleware( 'api' ) -> namespace ( $this -> namespace ) ->group(base_path( 'routes/api.php' )); } }

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

1 2 3 4 5 6 7 8 9 10 11 public function map(){ $this ->mapApiRoutes(); $this ->mapWebRoutes(); $this ->mapUsersRoutes(); } 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 接收一个正则，并且可以在与我们的正则匹配的路径下找到文件名。因此，我们的路由是在特定文件夹下组织的，我们现在可以在这些文件夹下找到所有文件，并将它们注册到其中间件。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 <?php namespace App\Providers; use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider; use Illuminate\Support\Facades\Route; class RouteServiceProvider extends ServiceProvider{ protected $namespace = 'App\Http\Controllers' ; public function map(){ $this ->mapAuthRoutes(); $this ->mapGuestRoutes(); $this ->mapPublicRoutes(); } protected function mapWebRoutes(){ Route::middleware( 'web' ) -> namespace ( $this -> namespace ) ->group(base_path( 'routes/web.php' )); } 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 ); } } }