控制器

• 简介
• 编写控制器
  • 基本控制器
  • 单动作控制器
• 控制器中间件
  • 中间件属性
  • 授权属性
• 资源控制器
  • 部分资源路由
  • 嵌套资源
  • 命名资源路由
  • 命名资源路由参数
  • 限定资源路由范围
  • 本地化资源 URI
  • 补充资源控制器
  • 单例资源控制器
  • 中间件与资源控制器
• 依赖注入与控制器

简介

与其将所有请求处理逻辑定义为路由文件中的闭包，您可能希望使用"控制器"类来组织此行为。控制器可以将相关的请求处理逻辑分组到单个类中。例如，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
{
    /**
     * 显示给定用户的个人资料。
     */
    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 方法，并将路由参数传递给该方法。

NOTE

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

单动作控制器

如果控制器动作特别复杂，您可能会发现将整个控制器类专用于该单个动作很方便。为此，您可以在控制器中定义单个 __invoke 方法：

<?php

namespace App\Http\Controllers;

class ProvisionServer extends Controller
{
    /**
     * 配置新的 Web 服务器。
     */
    public function __invoke()
    {
        // ...
    }
}

为单动作控制器注册路由时，不需要指定控制器方法。相反，您可以简单地将控制器名称传递给路由器：

use App\Http\Controllers\ProvisionServer;

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

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

php artisan make:controller ProvisionServer --invokable

NOTE

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

控制器中间件

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

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 implements HasMiddleware
{
    /**
     * 获取应该分配给控制器的中间件。
     */
    public static function middleware(): array
    {
        return [
            'auth',
            new Middleware('log', only: ['index']),
            new Middleware('subscribed', except: ['store']),
        ];
    }

    // ...
}

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

use Closure;
use Illuminate\Http\Request;

/**
 * 获取应该分配给控制器的中间件。
 */
public static function middleware(): array
{
    return [
        function (Request $request, Closure $next) {
            return $next($request);
        },
    ];
}

中间件属性

您还可以使用 PHP 属性将中间件分配给控制器：

<?php

namespace App\Http\Controllers;

use Illuminate\Routing\Attributes\Controllers\Middleware;

#[Middleware('auth')]
#[Middleware('log', only: ['index'])]
#[Middleware('subscribed', except: ['store'])]
class UserController
{
    // ...
}

您也可以将中间件属性放在单个控制器方法上。分配给方法的中间件将与在类级别分配的中间件合并：

<?php

namespace App\Http\Controllers;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Routing\Attributes\Controllers\Middleware;

#[Middleware('auth')]
class UserController
{
    #[Middleware('log')]
    #[Middleware('subscribed')]
    public function index()
    {
        // ...
    }

    #[Middleware(static function (Request $request, Closure $next) {
        // ...

        return $next($request);
    })]
    public function store()
    {
        // ...
    }
}

授权属性

如果您通过策略授权控制器动作，可以使用 Authorize 属性作为 can 中间件的便捷快捷方式：

<?php

namespace App\Http\Controllers;

use App\Models\Comment;
use App\Models\Post;
use Illuminate\Routing\Attributes\Controllers\Authorize;

class CommentController
{
    #[Authorize('create', [Comment::class, 'post'])]
    public function store(Post $post)
    {
        // ...
    }

    #[Authorize('delete', 'comment')]
    public function destroy(Comment $comment)
    {
        // ...
    }
}

第一个参数是您希望授权的能力。第二个参数是应该传递给策略的模型类、路由参数或参数。

资源控制器

如果您将应用程序中的每个 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);

此路由将注册一个嵌套资源，可以使用如下 URI 访问：

/photos/{photo}/comments/{comment}

限定嵌套资源范围

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',
]);

此路由将注册一个限定范围的嵌套资源，可以使用如下 URI 访问：

/photos/{photo}/comments/{comment:slug}

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

本地化资源 URI

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

/**
 * 引导任何应用程序服务。
 */
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);

NOTE

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

单例资源控制器

有时，您的应用程序可能只有一个资源实例。例如，用户的"个人资料"可以被编辑或更新，但用户不会有多个"个人资料"。同样，应用程序可能有一个"设置"资源，该资源是单例的。这些资源被称为"单例资源"。

您可以使用 singleton 方法注册单例资源：

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

可创建的单例资源

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

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

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

动词	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 为单例资源注册 destroy 路由但不注册 create 或 store 路由，可以使用 destroyable 方法：

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

如果您希望注册所有单例资源路由，可以使用 all 方法：

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

API 单例资源

apiSingleton 方法可用于注册将通过 API 访问的单例资源，从而排除 create 和 edit 路由：

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

当然，API 单例资源也可以是 creatable：

Route::apiSingleton('profile', ProfileController::class)->creatable();

中间件与资源控制器

资源路由还允许您为资源注册的多个路由指定中间件：

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

您也可以在控制器的构造函数中定义中间件。

依赖注入与控制器

构造函数注入

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

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * 创建新的控制器实例。
     */
    public function __construct(
        protected UserRepository $users,
    ) {}
}

方法注入

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

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 存储新用户。
     */
    public function store(Request $request)
    {
        $name = $request->name;

        // ...
    }
}

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

use App\Http\Controllers\UserController;

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

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

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 更新给定用户。
     */
    public function update(Request $request, string $id)
    {
        // ...
    }
}