控制器

• 介绍
• 基本控制器
  • 定义控制器
  • 控制器与命名空间
  • 单动作控制器
• 控制器中间件
• 资源控制器
  • 部分资源路由
  • 命名资源路由
  • 命名资源路由参数
  • 本地化资源 URI
  • 补充资源控制器
• 依赖注入与控制器
• 路由缓存

介绍

与其在路由文件中将所有请求处理逻辑定义为闭包，您可能希望使用控制器类来组织这些行为。控制器可以将相关的请求处理逻辑分组到一个类中。控制器存储在 app/Http/Controllers 目录中。

基本控制器

定义控制器

下面是一个基本控制器类的示例。请注意，控制器扩展了 Laravel 附带的基控制器类。基类提供了一些便捷方法，例如 middleware 方法，可用于将中间件附加到控制器动作：

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * 显示给定用户的个人资料。
     *
     * @param  int  $id
     * @return View
     */
    public function show($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

您可以像这样为此控制器动作定义路由：

Route::get('user/{id}', 'UserController@show');

现在，当请求匹配指定的路由 URI 时，将执行 UserController 类上的 show 方法。路由参数也将传递给该方法。

控制器不是必须扩展基类。然而，您将无法访问便捷功能，例如 middleware、validate 和 dispatch 方法。

控制器与命名空间

需要特别注意的是，在定义控制器路由时，我们不需要指定完整的控制器命名空间。由于 RouteServiceProvider 在包含命名空间的路由组中加载您的路由文件，我们只需指定类名中 App\Http\Controllers 部分之后的部分。

如果您选择将控制器更深地嵌套到 App\Http\Controllers 目录中，请使用相对于 App\Http\Controllers 根命名空间的特定类名。因此，如果您的完整控制器类是 App\Http\Controllers\Photos\AdminController，您应该像这样注册控制器的路由：

Route::get('foo', 'Photos\AdminController@method');

单动作控制器

如果您希望定义一个仅处理单个动作的控制器，可以在控制器上放置一个 __invoke 方法：

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class ShowProfile extends Controller
{
    /**
     * 显示给定用户的个人资料。
     *
     * @param  int  $id
     * @return View
     */
    public function __invoke($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

为单动作控制器注册路由时，您不需要指定方法：

Route::get('user/{id}', 'ShowProfile');

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

php artisan make:controller ShowProfile --invokable

控制器中间件

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

Route::get('profile', 'UserController@show')->middleware('auth');

然而，在控制器的构造函数中指定中间件更为方便。使用控制器构造函数中的 middleware 方法，您可以轻松地将中间件分配给控制器的动作。您甚至可以将中间件限制为仅适用于控制器类上的某些方法：

class UserController extends Controller
{
    /**
     * 实例化一个新的控制器实例。
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');

        $this->middleware('log')->only('index');

        $this->middleware('subscribed')->except('store');
    }
}

控制器还允许您使用闭包注册中间件。这为单个控制器定义中间件提供了一种便捷的方法，而无需定义整个中间件类：

$this->middleware(function ($request, $next) {
    // ...

    return $next($request);
});

您可以将中间件分配给控制器动作的子集；然而，这可能表明您的控制器过于庞大。相反，考虑将您的控制器拆分为多个较小的控制器。

资源控制器

Laravel 资源路由使用一行代码为控制器分配典型的“CRUD”路由。例如，您可能希望创建一个控制器来处理应用程序存储的“照片”的所有 HTTP 请求。使用 make:controller Artisan 命令，我们可以快速创建这样的控制器：

php artisan make:controller PhotoController --resource

此命令将在 app/Http/Controllers/PhotoController.php 生成一个控制器。该控制器将包含每个可用资源操作的方法。

接下来，您可以为控制器注册一个资源路由：

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

此单个路由声明创建多个路由以处理资源上的各种操作。生成的控制器将已经为每个这些动作预留了方法，包括通知您它们处理的 HTTP 动词和 URI 的注释。

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

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

资源控制器处理的动作

动词	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

指定资源模型

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

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

模拟表单方法

由于 HTML 表单无法发出 PUT、PATCH 或 DELETE 请求，您需要添加一个隐藏的 _method 字段来模拟这些 HTTP 动词。@method Blade 指令可以为您创建此字段：

<form action="/foo/bar" method="POST">
    @method('PUT')
</form>

部分资源路由

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

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

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

API 资源路由

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

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

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

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

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

php artisan make:controller API/PhotoController --api

命名资源路由

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

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

命名资源路由参数

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

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

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

/users/{admin_user}

本地化资源 URI

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

use Illuminate\Support\Facades\Route;

/**
 * 启动任何应用程序服务。
 *
 * @return void
 */
public function boot()
{
    Route::resourceVerbs([
        'create' => 'crear',
        'edit' => 'editar',
    ]);
}

一旦动词被自定义，像 Route::resource('fotos', 'PhotoController') 这样的资源路由注册将生成以下 URI：

/fotos/crear

/fotos/{foto}/editar

补充资源控制器

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

Route::get('photos/popular', 'PhotoController@method');

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

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

依赖注入与控制器

构造函数注入

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

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * 用户存储库实例。
     */
    protected $users;

    /**
     * 创建一个新的控制器实例。
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }
}

您还可以类型提示任何 Laravel 合约。如果容器可以解析它，您就可以类型提示它。根据您的应用程序，将依赖项注入到控制器中可能会提供更好的可测试性。

方法注入

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

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

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

        //
    }
}

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

Route::put('user/{id}', 'UserController@update');

您仍然可以类型提示 Illuminate\Http\Request 并通过以下方式访问您的 id 参数：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

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

路由缓存

基于闭包的路由无法缓存。要使用路由缓存，您必须将任何闭包路由转换为控制器类。

如果您的应用程序完全使用基于控制器的路由，您应该利用 Laravel 的路由缓存。使用路由缓存将大大减少注册应用程序所有路由所需的时间。在某些情况下，您的路由注册甚至可能快达 100 倍。要生成路由缓存，只需执行 route:cache Artisan 命令：

php artisan route:cache

运行此命令后，您的缓存路由文件将在每个请求时加载。请记住，如果您添加任何新路由，您将需要生成一个新的路由缓存。因此，您应该仅在项目部署期间运行 route:cache 命令。

您可以使用 route:clear 命令清除路由缓存：

php artisan route:clear