控制器

• 简介
• 编写控制器
  • 基本控制器
  • 单一动作控制器
• 控制器中间件
• 资源控制器
  • 部分资源路由
  • 嵌套资源
  • 命名资源路由
  • 命名资源路由参数
  • 作用域资源路由
  • 本地化资源 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
{
    /**
     * 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 App\Http\Controllers\Controller;
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,
]);

资源控制器处理的操作

自定义缺失模型行为

通常，如果找不到隐式绑定的资源模型，则会生成 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();

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

命名资源路由

默认情况下，所有资源控制器操作都有一个路由名称；但是，您可以通过传递一个包含所需路由名称的 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 方法的开头完成。

/**
 * 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);

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

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

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

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

可创建的单例资源

有时，您可能需要为单例资源定义创建和存储路由。要实现此目的，您可以在注册单例资源路由时调用 creatable 方法。

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

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

如果您希望 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 服务容器用于解析所有 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');
    }
}