京都のシステム開発・ホームページ制作会社　株式会社Nextat（ネクスタット）

こんにちは、ナカエです。今日はLaravelのルーティングについての小ネタです。

増えるルート

ページ数やエンドポイント数が多いアプリケーションだと、Laravelのデフォルトのroutes.phpファイルが長くなり見づらくなってくることがあります。そんな時は、機能ごと/サブサイトごとにファイルを分けて管理するという手がオススメです。

例

例えば管理画面用のルートを別ファイルで管理するとします。

※下記コードの元はLaravel5.2です。

デフォルトのapp/Providers/RouteServiceProvider.phpのコードに少し追記します。

<?php
namespace App\Providers;
use Illuminate\Routing\Router;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
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.
     *
     * @param  \Illuminate\Routing\Router  $router
     * @return void
     */
    public function boot(Router $router)
    {
        //
        parent::boot($router);
    }
    /**
     * Define the routes for the application.
     *
     * @param  \Illuminate\Routing\Router  $router
     * @return void
     */
    public function map(Router $router)
    {
        $this->mapWebRoutes($router);
        
        // 管理画面用のルート追加
        $this->mapAdminRoutes($router);
    }
    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     *
     * @param  \Illuminate\Routing\Router  $router
     * @return void
     */
    protected function mapWebRoutes(Router $router)
    {
        $router->group([
            'namespace' => $this->namespace, 'middleware' => 'web',
        ], function ($router) {
            require app_path('Http/routes.php');
        });
    }
    
    /**
     * 管理画面用のルート
     *
     * @param  \Illuminate\Routing\Router  $router
     * @return void
     */
    protected function mapAdminRoutes(Router $router)
    {
        $router->group([
            'prefix' => 'admin',
            'namespace' => 'App\Http\Controllers\Admin',
            'middleware' => 'auth',
        ], function ($router) {
            require app_path('Http/admin_routes.php');
        });
    }
}

mapメソッドのコメントが追加のルートが欲しけりゃここに書けと無言で主張していらっしゃるので、 そこにルート登録用のメソッドmapAdminRoutes()の呼び出しを追加します。

あとはmapWebRoutes()メソッドを真似てmapAdminRoutes()を作成し、追加のルートに共通の設定をしつつ、 読み込みたいファイル（app/Http/admin_routes.php）を指定するのみです。

5.1ではmapメソッドに直書きだったのですが、 5.2 で拡張を見越した書き方に変わったようです。親切設計ですね