当前位置:首页 > CMS教程 > 其它CMS > 列表

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

发布:smiling 来源: PHP粉丝网  添加日期:2022-05-02 11:08:16 浏览: 评论:0 

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

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

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

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

  1. public function map(){ 
  2.     $this->mapApiRoutes(); 
  3.     $this->mapWebRoutes(); 
  4.     $this->mapUsersRoutes(); 
  5. protected function mapUsersRoutes(){ 
  6.     Route::prefix('api'
  7.     ->middleware('api'
  8.     ->namespace($this->namespace) 
  9.     ->group(base_path('routes/users.php')); 

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

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

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

  1. ├── routes   
  2.  
  3. │   ├── api    
  4.  
  5. │   │   ├── public 
  6.  
  7. │   |   │   ├── users.php 
  8.  
  9. │   │   ├── auth 
  10.  
  11. │   |   │   ├── users.php 
  12.  
  13. │   │   ├── guest 
  14.  
  15. │   |   │   ├── users.php 

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

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

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

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

这些文件将如何注册?

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

Tags: Laravel路由文件

分享到: