控制器

• 简介
• 编写控制器
  • 基础控制器
  • 单动作控制器
• 控制器中间件
  • 中间件属性
  • 授权属性
• 资源控制器
  • 部分资源路由
  • 嵌套资源
  • 命名资源路由
  • 命名资源路由参数
  • 作用域资源路由
  • 本地化资源 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

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

单例资源控制器

有时，你的应用程序会有可能只有一个实例的资源。例如，用户的“个人资料”可以被编辑或更新，但用户可能不会拥有多个“个人资料”。同样，一张图片可能只有一个“缩略图”。这些资源被称为“单例资源”，意味着资源只能存在一个实例。在这些情况下，你可以注册一个“单例”资源控制器：

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 单例资源也可以是 creatable，这将为资源注册 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
{
    /**
     * 创建一个新的控制器实例。
     */
    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
{
    /**
     * 存储一个新用户。
     */
    public function store(Request $request): RedirectResponse
    {
        $name = $request->name;

        // 存储用户...

        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
{
    /**
     * 更新给定的用户。
     */
    public function update(Request $request, string $id): RedirectResponse
    {
        // 更新用户...

        return redirect('/users');
    }
}