控制器

引言

您可能希望使用“控制器”类来组织请求处理行为，而不是将所有请求处理逻辑都定义为路由文件中的闭包。控制器可以将相关的请求处理逻辑分组到一个单独的类中。例如，一个 UserController 类可以处理所有与用户相关的传入请求，包括显示、创建、更新和删除用户。默认情况下，控制器存储在 app/Http/Controllers 目录中。

编写控制器

基本控制器

要快速生成一个新的控制器，您可以运行 make:controller Artisan 命令。默认情况下，您的应用程序的所有控制器都存储在 app/Http/Controllers 目录中：

php artisan make:controller UserController

让我们看一个基本控制器的示例。一个控制器可以有任意数量的公共方法来响应传入的 HTTP 请求：

<?php

namespace App\Http\Controllers;

use App\Models\User;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * Show the profile for a given user.
     */
    public function show(string $id): View
    {
        return view('user.profile', [
            'user' => User::findOrFail($id)
        ]);
    }
}

一旦您编写了控制器类和方法，就可以像这样定义一个指向该控制器方法的路由：

use App\Http\Controllers\UserController;

Route::get('/user/{id}', [UserController::class, 'show']);

当传入请求与指定的路由 URI 匹配时，App\Http\Controllers\UserController 类上的 show 方法将被调用，并且路由参数将传递给该方法。

控制器不需要扩展基类。但是，有时扩展一个包含应在所有控制器之间共享的方法的基控制器类会很方便。

单动作控制器

如果一个控制器动作特别复杂，您可能会觉得将整个控制器类专用于该单个动作很方便。为了实现这一点，您可以在控制器中定义一个单独的 __invoke 方法：

<?php

namespace App\Http\Controllers;

class ProvisionServer extends Controller
{
    /**
     * Provision a new web server.
     */
    public function __invoke()
    {
        // ...
    }
}

在为单动作控制器注册路由时，您无需指定控制器方法。相反，您只需将控制器的名称传递给路由器：

use App\Http\Controllers\ProvisionServer;

Route::post('/server', ProvisionServer::class);

您可以使用 make:controller Artisan 命令的 --invokable 选项来生成一个可调用的控制器：

php artisan make:controller ProvisionServer --invokable

控制器存根可以使用存根发布进行自定义。

控制器中间件

中间件可以在您的路由文件中分配给控制器的路由：

Route::get('/profile', [UserController::class, 'show'])->middleware('auth');

或者，您可能会发现在控制器类中指定中间件很方便。为此，您的控制器应该实现 HasMiddleware 接口，该接口规定控制器应该有一个静态 middleware 方法。在此方法中，您可以返回一个应应用于控制器动作的中间件数组：

<?php

namespace App\Http\Controllers;

use Illuminate\Routing\Controllers\HasMiddleware;
use Illuminate\Routing\Controllers\Middleware;

class UserController extends Controller implements HasMiddleware
{
    /**
     * Get the middleware that should be assigned to the controller.
     */
    public static function middleware(): array
    {
        return [
            'auth',
            new Middleware('log', only: ['index']),
            new Middleware('subscribed', except: ['store']),
        ];
    }

    // ...
}

您还可以将控制器中间件定义为闭包，这提供了一种方便的方式来定义内联中间件，而无需编写整个中间件类：

use Closure;
use Illuminate\Http\Request;

/**
 * Get the middleware that should be assigned to the controller.
 */
public static function middleware(): array
{
    return [
        function (Request $request, Closure $next) {
            return $next($request);
        },
    ];
}

资源控制器

如果您将应用程序中的每个 Eloquent 模型都视为一个“资源”，那么通常会对应用程序中的每个资源执行相同的动作集。例如，假设您的应用程序包含一个 Photo 模型和一个 Movie 模型。用户很可能可以创建、读取、更新或删除这些资源。

由于这种常见用例，Laravel 资源路由使用一行代码将典型的创建、读取、更新和删除（“CRUD”）路由分配给控制器。要开始，我们可以使用 make:controller Artisan 命令的 --resource 选项来快速创建一个处理这些操作的控制器：

php artisan make:controller PhotoController --resource

此命令将在 app/Http/Controllers/PhotoController.php 中生成一个控制器。该控制器将为每个可用的资源操作包含一个方法。接下来，您可以注册一个指向该控制器的资源路由：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class);

此单个路由声明创建了多个路由来处理资源上的各种操作。生成的控制器将已经为每个操作提供了方法存根。请记住，您始终可以通过运行 route:list Artisan 命令来快速概览应用程序的路由。

您甚至可以通过将数组传递给 resources 方法一次注册多个资源控制器：

Route::resources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

softDeletableResources 方法注册了许多都使用 withTrashed 方法的资源控制器：

Route::softDeletableResources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

资源控制器处理的动作

动词	URI	动作	路由名称
GET	`/photos`	`index`	`photos.index`
GET	`/photos/create`	`create`	`photos.create`
POST	`/photos`	`store`	`photos.store`
GET	`/photos/{photo}`	`show`	`photos.show`
GET	`/photos/{photo}/edit`	`edit`	`photos.edit`
PUT/PATCH	`/photos/{photo}`	`update`	`photos.update`
DELETE	`/photos/{photo}`	`destroy`	`photos.destroy`

自定义缺失模型行为

通常，如果未找到隐式绑定的资源模型，将生成 404 HTTP 响应。但是，您可以在定义资源路由时通过调用 missing 方法来自定义此行为。missing 方法接受一个闭包，如果无法为资源的任何路由找到隐式绑定的模型，则将调用该闭包：

use App\Http\Controllers\PhotoController;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;

Route::resource('photos', PhotoController::class)
    ->missing(function (Request $request) {
        return Redirect::route('photos.index');
    });

软删除模型

通常，隐式模型绑定不会检索已软删除的模型，而是返回 404 HTTP 响应。但是，您可以通过在定义资源路由时调用 withTrashed 方法来指示框架允许软删除模型：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class)->withTrashed();

不带参数调用 withTrashed 将允许在 show、edit 和 update 资源路由上使用软删除模型。您可以通过将数组传递给 withTrashed 方法来指定这些路由的子集：

Route::resource('photos', PhotoController::class)->withTrashed(['show']);

指定资源模型

如果您正在使用路由模型绑定并希望资源控制器的方法类型提示模型实例，您可以在生成控制器时使用 --model 选项：

php artisan make:controller PhotoController --model=Photo --resource

生成表单请求

您可以在生成资源控制器时提供 --requests 选项，以指示 Artisan 为控制器的存储和更新方法生成表单请求类：

php artisan make:controller PhotoController --model=Photo --resource --requests

部分资源路由

在声明资源路由时，您可以指定控制器应处理的动作子集，而不是完整的默认动作集：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class)->only([
    'index', 'show'
]);

Route::resource('photos', PhotoController::class)->except([
    'create', 'store', 'update', 'destroy'
]);

API 资源路由

在声明将被 API 消费的资源路由时，您通常会希望排除呈现 HTML 模板的路由，例如 create 和 edit。为了方便起见，您可以使用 apiResource 方法自动排除这两个路由：

use App\Http\Controllers\PhotoController;

Route::apiResource('photos', PhotoController::class);

您可以通过将数组传递给 apiResources 方法一次注册多个 API 资源控制器：

use App\Http\Controllers\PhotoController;
use App\Http\Controllers\PostController;

Route::apiResources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
]);

要快速生成一个不包含 create 或 edit 方法的 API 资源控制器，请在执行 make:controller 命令时使用 --api 开关：

php artisan make:controller PhotoController --api

嵌套资源

有时您可能需要定义指向嵌套资源的路由。例如，一个照片资源可能有多条评论附加到该照片。要嵌套资源控制器，您可以在路由声明中使用“点”表示法：

use App\Http\Controllers\PhotoCommentController;

Route::resource('photos.comments', PhotoCommentController::class);

此路由将注册一个可以使用类似 /photos/{photo}/comments/{comment} 的 URI 访问的嵌套资源。

作用域嵌套资源

Laravel 的隐式模型绑定功能可以自动为嵌套绑定设置作用域，从而确认解析的子模型属于父模型。通过在定义嵌套资源时使用 scoped 方法，您可以启用自动作用域，并指示 Laravel 应该通过哪个字段检索子资源。有关如何实现此目的的更多信息，请参阅有关作用域资源路由的文档。

浅层嵌套

通常，URI 中同时包含父 ID 和子 ID 并不完全必要，因为子 ID 已经是唯一的标识符。当使用唯一的标识符（例如自动递增的主键）来标识 URI 段中的模型时，您可以选择使用“浅层嵌套”：

use App\Http\Controllers\CommentController;

Route::resource('photos.comments', CommentController::class)->shallow();

此路由定义将定义以下路由：

动词	URI	动作	路由名称
GET	`/photos/{photo}/comments`	`index`	`photos.comments.index`
GET	`/photos/{photo}/comments/create`	`create`	`photos.comments.create`
POST	`/photos/{photo}/comments`	`store`	`photos.comments.store`
GET	`/comments/{comment}`	`show`	`comments.show`
GET	`/comments/{comment}/edit`	`edit`	`comments.edit`
PUT/PATCH	`/comments/{comment}`	`update`	`comments.update`
DELETE	`/comments/{comment}`	`destroy`	`comments.destroy`

命名资源路由

默认情况下，所有资源控制器动作都有一个路由名称；但是，您可以通过传递一个包含您想要的路由名称的 names 数组来覆盖这些名称：

use App\Http\Controllers\PhotoController;

Route::resource('photos', PhotoController::class)->names([
    'create' => 'photos.build'
]);

命名资源路由参数

默认情况下，Route::resource 将根据资源名称的“单数化”版本为您的资源路由创建路由参数。您可以使用 parameters 方法轻松地在每个资源的基础上覆盖它。传递给 parameters 方法的数组应该是一个资源名称和参数名称的关联数组：

use App\Http\Controllers\AdminUserController;

Route::resource('users', AdminUserController::class)->parameters([
    'users' => 'admin_user'
]);

上面的示例为资源的 show 路由生成了以下 URI：

/users/{admin_user}

作用域资源路由

Laravel 的作用域隐式模型绑定功能可以自动为嵌套绑定设置作用域，从而确认解析的子模型属于父模型。通过在定义嵌套资源时使用 scoped 方法，您可以启用自动作用域，并指示 Laravel 应该通过哪个字段检索子资源：

use App\Http\Controllers\PhotoCommentController;

Route::resource('photos.comments', PhotoCommentController::class)->scoped([
    'comment' => 'slug',
]);

此路由将注册一个带有作用域的嵌套资源，可以使用类似 /photos/{photo}/comments/{comment:slug} 的 URI 访问。

当使用自定义键的隐式绑定作为嵌套路由参数时，Laravel 将自动为查询设置作用域，以通过其父级检索嵌套模型，使用约定来猜测父级上的关系名称。在这种情况下，将假定 Photo 模型有一个名为 comments 的关系（路由参数名称的复数形式），可用于检索 Comment 模型。

本地化资源 URI

默认情况下，Route::resource 将使用英语动词和复数规则创建资源 URI。如果您需要本地化 create 和 edit 动作动词，您可以使用 Route::resourceVerbs 方法。这可以在您的应用程序的 App\Providers\AppServiceProvider 中的 boot 方法的开头完成：

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Route::resourceVerbs([
        'create' => 'crear',
        'edit' => 'editar',
    ]);
}

Laravel 的复数器支持多种不同的语言，您可以根据需要进行配置。一旦动词和复数化语言被自定义，像 Route::resource('publicacion', PublicacionController::class) 这样的资源路由注册将生成以下 URI：

/publicacion/crear

/publicacion/{publicaciones}/editar

补充资源控制器

如果您需要在默认资源路由集之外为资源控制器添加额外的路由，您应该在调用 Route::resource 方法之前定义这些路由；否则，由 resource 方法定义的路由可能会无意中优先于您的补充路由：

use App\Http\Controller\PhotoController;

Route::get('/photos/popular', [PhotoController::class, 'popular']);
Route::resource('photos', PhotoController::class);

请记住让您的控制器保持专注。如果您发现自己经常需要典型资源动作集之外的方法，请考虑将控制器拆分为两个更小的控制器。

单例资源控制器

有时，您的应用程序将拥有只能有一个实例的资源。例如，用户的“配置文件”可以被编辑或更新，但一个用户不能拥有多个 “配置文件”。同样，一张图像可能有一个“缩略图”。这些资源被称为“单例资源”，意味着该资源只能有一个实例存在。在这些场景中，您可以注册一个“单例”资源控制器：

use App\Http\Controllers\ProfileController;
use Illuminate\Support\Facades\Route;

Route::singleton('profile', ProfileController::class);

上面的单例资源定义将注册以下路由。正如您所看到的，单例资源不会注册“创建”路由，并且注册的路由不接受标识符，因为该资源只能存在一个实例：

动词	URI	动作	路由名称
GET	`/profile`	`show`	`profile.show`
GET	`/profile/edit`	`edit`	`profile.edit`
PUT/PATCH	`/profile`	`update`	`profile.update`

单例资源也可以嵌套在标准资源中：

Route::singleton('photos.thumbnail', ThumbnailController::class);

在此示例中，photos 资源将接收所有标准资源路由；然而，thumbnail 资源将是一个单例资源，具有以下路由：

动词	URI	动作	路由名称
GET	`/photos/{photo}/thumbnail`	`show`	`photos.thumbnail.show`
GET	`/photos/{photo}/thumbnail/edit`	`edit`	`photos.thumbnail.edit`
PUT/PATCH	`/photos/{photo}/thumbnail`	`update`	`photos.thumbnail.update`

可创建的单例资源

有时，您可能希望为单例资源定义创建和存储路由。为此，您可以在注册单例资源路由时调用 creatable 方法：

Route::singleton('photos.thumbnail', ThumbnailController::class)->creatable();

在此示例中，将注册以下路由。正如您所看到的，还将为可创建的单例资源注册一个 DELETE 路由：

动词	URI	动作	路由名称
GET	`/photos/{photo}/thumbnail/create`	`create`	`photos.thumbnail.create`
POST	`/photos/{photo}/thumbnail`	`store`	`photos.thumbnail.store`
GET	`/photos/{photo}/thumbnail`	`show`	`photos.thumbnail.show`
GET	`/photos/{photo}/thumbnail/edit`	`edit`	`photos.thumbnail.edit`
PUT/PATCH	`/photos/{photo}/thumbnail`	`update`	`photos.thumbnail.update`
DELETE	`/photos/{photo}/thumbnail`	`destroy`	`photos.thumbnail.destroy`

如果您希望 Laravel 为单例资源注册 DELETE 路由，但不注册创建或存储路由，您可以使用 destroyable 方法：

Route::singleton(...)->destroyable();

API 单例资源

apiSingleton 方法可用于注册一个将通过 API 操作的单例资源，因此 create 和 edit 路由变得不必要：

Route::apiSingleton('profile', ProfileController::class);

当然，API 单例资源也可以是可创建的，这将为该资源注册 store 和 destroy 路由：

Route::apiSingleton('photos.thumbnail', ProfileController::class)->creatable();

中间件和资源控制器

Laravel 允许您使用 middleware、middlewareFor 和 withoutMiddlewareFor 方法将中间件分配给资源路由的所有或特定方法。这些方法提供了对每个资源动作应用哪个中间件的精细控制。

将中间件应用于所有方法

您可以使用 middleware 方法将中间件分配给由资源或单例资源路由生成的所有路由：

Route::resource('users', UserController::class)
    ->middleware(['auth', 'verified']);

Route::singleton('profile', ProfileController::class)
    ->middleware('auth');

将中间件应用于特定方法

您可以使用 middlewareFor 方法将中间件分配给给定资源控制器的一个或多个特定方法：

Route::resource('users', UserController::class)
    ->middlewareFor('show', 'auth');

Route::apiResource('users', UserController::class)
    ->middlewareFor(['show', 'update'], 'auth');

Route::resource('users', UserController::class)
    ->middlewareFor('show', 'auth')
    ->middlewareFor('update', 'auth');

Route::apiResource('users', UserController::class)
    ->middlewareFor(['show', 'update'], ['auth', 'verified']);

middlewareFor 方法也可以与单例和 API 单例资源控制器结合使用：

Route::singleton('profile', ProfileController::class)
    ->middlewareFor('show', 'auth');

Route::apiSingleton('profile', ProfileController::class)
    ->middlewareFor(['show', 'update'], 'auth');

从特定方法中排除中间件

您可以使用 withoutMiddlewareFor 方法从资源控制器的特定方法中排除中间件：

Route::middleware(['auth', 'verified', 'subscribed'])->group(function () {
    Route::resource('users', UserController::class)
        ->withoutMiddlewareFor('index', ['auth', 'verified'])
        ->withoutMiddlewareFor(['create', 'store'], 'verified')
        ->withoutMiddlewareFor('destroy', 'subscribed');
});

依赖注入和控制器

构造函数注入

Laravel 服务容器用于解析所有 Laravel 控制器。因此，您可以在其构造函数中类型提示您的控制器可能需要的任何依赖项。声明的依赖项将自动被解析并注入到控制器实例中：

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * Create a new controller instance.
     */
    public function __construct(
        protected UserRepository $users,
    ) {}
}

方法注入

除了构造函数注入之外，您还可以在控制器的方法上类型提示依赖项。方法注入的一个常见用例是将 Illuminate\Http\Request 实例注入到您的控制器方法中：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Store a new user.
     */
    public function store(Request $request): RedirectResponse
    {
        $name = $request->name;

        // Store the user...

        return redirect('/users');
    }
}

如果您的控制器方法也期望来自路由参数的输入，请在其他依赖项之后列出您的路由参数。例如，如果您的路由定义如下：

use App\Http\Controllers\UserController;

Route::put('/user/{id}', [UserController::class, 'update']);

您仍然可以类型提示 Illuminate\Http\Request 并通过如下定义您的控制器方法来访问您的 id 参数：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Update the given user.
     */
    public function update(Request $request, string $id): RedirectResponse
    {
        // Update the user...

        return redirect('/users');
    }
}

CSRF 保护

Http请求