Группировка маршрутов Laravel: 6 методов организации маршрутов

protected $middlewareGroups = [
    // This group comes from default Laravel
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],
 
    // This group comes from default Laravel
    'api' => [
        // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
        'throttle:api',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],
 
    // THIS IS OUR NEW MIDDLEWARE GROUP
    'check_user' => [
        'auth',
        'check.role',
        'check.user.status',
        'locale'
    ],
];

Итак, мы назвали нашу группу check_user, и теперь мы можем сократить маршруты:

Route::prefix('students')->middleware(['check_user', 'check.invoice.status'])->group(function () {
    // ... student routes
});
 
Route::prefix('managers')->middleware(['check_user'])->group(function () {
    // ... manager routes
});

Группировка 4. Контроллеры с одинаковыми именами, разные пространства имен

Довольно распространена ситуация, когда, например, HomeController используется для разных ролей пользователей, таких как Admin/HomeController и User/HomeController.И если вы используете полный путь в своих маршрутах, это выглядит примерно так:

Route::prefix('admin')->middleware('is_admin')->group(function () {
    Route::get('home', [\App\Http\Controllers\Admin\HomeController::class, 'index']);
});
 
Route::prefix('user')->middleware('is_user')->group(function () {
    Route::get('home', [\App\Http\Controllers\User\HomeController::class, 'index']);
});

Достаточно много кода для ввода этих полных путей, верно? Вот почему многие разработчики предпочитают иметь в списке маршрутов только HomeController::class и добавлять сверху что-то вроде этого:

use App\Http\Controllers\Admin\HomeController;

Но проблема в том, что у нас одинаковое имя класса контроллера!Итак, это не сработает:

use App\Http\Controllers\Admin\HomeController;
use App\Http\Controllers\User\HomeController;

Какой из них будет "официальным"? Что ж, один из способов — изменить имя и назначить псевдоним для одного из них:

use App\Http\Controllers\Admin\HomeController as AdminHomeController;
use App\Http\Controllers\User\HomeController;
 
Route::prefix('admin')->middleware('is_admin')->group(function () {
    Route::get('home', [AdminHomeController::class, 'index']);
});
 
Route::prefix('user')->middleware('is_user')->group(function () {
    Route::get('home', [HomeController::class, 'index']);
});

Но лично меня смущает изменение имени класса сверху, мне нравится другой подход: добавить namespace() для подпапок контроллеров:

Route::prefix('admin')->namespace('App\Http\Controllers\Admin')->middleware('is_admin')->group(function () {
    Route::get('home', [HomeController::class, 'index']);
    // ... other controllers from Admin namespace
});
 
Route::prefix('user')->namespace('App\Http\Controllers\User')->middleware('is_user')->group(function () {
    Route::get('home', [HomeController::class, 'index']);
    // ... other controllers from User namespace
});

Группировка 5.Отдельные файлы маршрутов

Если вы чувствуете, что ваш основной routes/web.php или routes/api.php становится слишком большим, вы можете взять некоторые маршруты и поместить их в отдельный файл, назовите их как хотите, например routes/admin.php.

Затем, чтобы включить этот файл, у вас есть два способа: я называю "способ Laravel" и "способ PHP".

Если вы хотите проследить структуру того, как Laravel структурирует свои файлы маршрутов по умолчанию, это происходит в файле app/Providers/RouteServiceProvider.php:

public function boot()
{
    $this->configureRateLimiting();
 
    $this->routes(function () {
        Route::middleware('api')
            ->prefix('api')
            ->group(base_path('routes/api.php'));
 
        Route::middleware('web')
            ->group(base_path('routes/web.php'));
    });
}

Как видите, здесь присутствуют и routes/api.php, и routes/web.php с немного разными настройками.Итак, все, что вам нужно сделать, это добавить свой файл администратора сюда:

$this->routes(function () {
    Route::middleware('api')
        ->prefix('api')
        ->group(base_path('routes/api.php'));
 
    Route::middleware('web')
        ->group(base_path('routes/web.php'));
 
    Route::middleware('is_admin')
        ->group(base_path('routes/admin.php'));
});

Но если вы не хотите углубляться в поставщиков услуг, есть более короткий путь — просто включите/требуйте маршрутизирует файл в другой файл, как и в любом файле PHP, за пределами фреймворка Laravel.

Route::get('/', function () {
    return view('welcome');
});
 
Route::get('/dashboard', function () {
    return view('dashboard');
})->middleware(['auth'])->name('dashboard');
 
require __DIR__.'/auth.php';

Route::get('profile', [ProfileController::class, 'getProfile']);
Route::put('profile', [ProfileController::class, 'updateProfile']);
Route::delete('profile', [ProfileController::class, 'deleteProfile']);

Route::controller(ProfileController::class)->group(function() {
    Route::get('profile', 'getProfile');
    Route::put('profile', 'updateProfile');
    Route::delete('profile', 'deleteProfile');
});