控制器

• 简介
• 基础控制器
  • 定义控制器
  • 控制器 & 命名空间
  • 单个行为控制器
• 控制器中间件
• 资源控制器
  • 部分资源路由
  • 命名资源路由
  • 命名资源路由参数
  • 本地资源化 URIs
  • 补充资源控制器
• 依赖注入 & 控制器
• 路由缓存

简介

为了替代在路由文件中以闭包形式定义的所有的请求处理逻辑， 你也许想使用控制类来组织这些行为。控制器能将相关的请求处理逻辑组成一个单独的类。 控制器被存放在 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 方法就会被执行。路由参数也将会被传递给该方法。

Tip：控制器并 不是强制要求继承基础类 。 但是， 如果控制器没有继承基础类，你将无法使用一些便捷的功能，比如 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');

你可以通过 Artisan 命令工具里的 make:controller 命令中的 —invokable 选项来生成一个可调用的控制器：

    php artisan make:controller ShowProfile --invokable

控制器中间件

Middleware 可以在路由文件中分配给控制器的路由。

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

但是，在控制器的构造函数中指定中间件更为方便。使用控制器构造函数中的 middleware 方法，可以轻松地将中间件分配给控制器的操作。你甚至可以将中间件限制为控制器类上的某些方法。

class UserController extends Controller
{
    /**
     * Instantiate a new controller instance.
     *
     * @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);
});

Tip：你可以将中间件分配给控制器操作的一个子集；但是，它可能表明你的控制器正在变得很大。建议你将控制器拆分为多个较小的控制器。

资源控制器

Laravel 资源路由将典型的「CURD(增删改查)」路由分配给具有单行代码的控制器。 例如，你希望创建一个控制器来处理应用保存的 "照片" 的所有 HTTP 请求。使用Artisan 命令 make:controller ， 我们可以快速创建这样一个控制器：

php artisan make:controller PhotoController --resource

这个命令会生成一个控制器 app/Http/Controllers/PhotoController.php。 其中包括每个可用资源操作的方法。

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

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

这个单一的路由声明创建多个路由来处理资源上的各种行为。生成的控制器为每个行为保留了方法，包括了关于处理 HTTP 动词和 URLs 的声明注释。

你可以通过将数组传参到 resources 方法中的方式来一次性的创建多个资源控制器：

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

资源控制器操作处理

指定资源模型

如果你使用了路由模型绑定，并且想在资源控制器的方法中使用类型提示，你可以在生成控制器的时候使用 —model 选项：

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

伪造表单方法

因为 HTML 表单不能生成 PUT， PATCH， 和 DELETE 请求，所以你需要一个添加一个隐藏的 _method 字段来伪造 HTTP 动作。这个 Blade 指令 @method 可以为你创建这个字段：

<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 资源路由

当声明用于 APIs 的资源路由时，通常需要排除显示 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 路由生成如下的 URl ：

/users/{admin_user}

本地化资源 URIs

默认情况下， Route::resource 将会使用英文动词来创建资源 URI 。如果你需要本地化 create 和 edit 行为动作名，你可以在 AppServiceProvider 的 boot 方法中使用 Route::resourceVerbs 方法实现。

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

Tip：记住保持控制器的专一性。如果你发现自己经常需要典型资源操作之外的方法，请考虑将控制器拆分为较小的控制器。

依赖注入 & 控制器

构造函数注入

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

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepository;

class UserController extends Controller
{
    /**
     * The user repository instance.
     */
    protected $users;

    /**
     * Create a new controller instance.
     *
     * @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
{
    /**
     * Store a new user.
     *
     * @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
{
    /**
     * Update the given user.
     *
     * @param  Request  $request
     * @param  string  $id
     * @return Response
     */
    public function update(Request $request, $id)
    {
        //
    }
}

路由缓存

注意：基于闭包的路由无法被缓存。要使用路由缓存。你需要将任何闭包路由转换成控制器路由。

如果你的应用只使用了基于控制器的路由，那么你应该利用路由缓存。使用路由缓存将极大地减少注册所有应用路由所需的时间。某些情况下，路由注册的速度甚至会快100倍。要生成路由缓存，只需要执行 route:cache ：

php artisan route:cache

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

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

php artisan route:clear

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接 我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。