首页 » Laravel 5.3 中文文档 » 正文

「Laravel 5.3 中文文档」HTTP 层 – 控制器

| Laravel 5.3 中文文档 | 暂无评论 | (2评) |

简介

除了在路由文件中定义所有的请求处理逻辑外，你可能还希望可以使用控制器类来组织此行为。控制器可以把相关的请求处理逻辑分组到单个的类。控制器存放在 app/Http/Controllers 文件夹中。

基础控制器

定义控制器

下面是一个基础控制器类的例子。注意，类继承自 Laravel 提供的基础的控制器类。基类提供了一些方便的方法如 middleware 方法，它可以用来为控制器方法附加中间件：

<?php

namespace App\Http\Controllers;

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

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    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
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function __invoke($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

当注册路由到单方法控制器时，不需要指定方法：

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

控制器中间件

可以在路由文件中将中间件指定给控制器路由：

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

然而，更方便的方法是在控制器的构造函数中指定中间件。在控制器的构造函数中使用 middleware 方法，你可以很方便的为控制器方法指定中间件。你甚至可以限制中间件只对控制器中的某些方法起作用：

class UserController extends Controller
{
    /**
     * Instantiate a new new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');

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

        $this->middleware('subscribed')->except('store');
    }
}
你可以为控制方法的子集分配中间件，然而，这有可能使你的控制器变得太大。作为一种替代方式，你可以考虑把控制器分为多个更小的控制器。

资源控制器

Laravel 的资源路由只需一行代码就可以为一个控制器分配典型的“CRUD”路由。例如，你想为应用中存储的“图片”创建一个处理所有 HTTP 请求的控制器。使用 make:controller Artisan 命令，我们可以快速的创建这样一个控制器：

php artisan make:controller PhotoController --resource

这条命令会生成一个位于 app/Http/Controllers/PhotoController.php 的控制器。这个控制器包含了资源操作所需的所有方法。

然后，你可以这样注册一个资源路由到控制器：

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

单个路由声明创建了多个路由来处理资源中的各种行为。生成的控制器已经包含了每一种行为对应的方法，包括要处理的 URI 及方法对应的注释。

资源控制器处理的行为

VerbURIActionRoute Name
GET/photosindexphotos.index
GET/photos/createcreatephotos.create
POST/photosstorephotos.store
GET/photos/{photo}showphotos.show
GET/photos/{photo}/editeditphotos.edit
PUT/PATCH/photos/{photo}updatephotos.update
DELETE/photos/{photo}destroyphotos.destroy

表单方法欺骗

由于 HTML 表单不支持 PUT、PATCH、DELETE 请求，你需要添加一个 _method 隐藏域作为 HTTP 欺骗，method_field 辅助方法可以为你创建这个字段：

{{ method_field('PUT') }}

部分资源路由

当生命资源路由时，你可以指定需要处理的行为的子集，而不是默认行为的全集：

Route::resource('photo', 'PhotoController', ['only' => [
    'index', 'show'
]]);

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

资源路由命名

默认情况下，所有的资源控制器行为都有一个路由名称；不过你可以在选项中传递一个 names 数组来重写这些名称：

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

资源路由参数命名

默认情况下，Route::resource 会基于资源名称单数形式为你的资源路由创建参数。你可以在选项中传递一个 parameters 数组来覆盖这些名称。这个 parameters 数组应该是一个资源名称与参数名称的关联数组：

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

上面的例子会为资源的 show 方法生成下面的 URI：

/user/{admin_user}

附加资源控制器

如果你需要在默认的资源路由集合之外为资源控制器添加额外的路由，你可以在调用 Route::resource 之前定义它们；否则，resource 方法定义的路由可能会无意中覆盖掉你的附加路由：

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

Route::resource('photos', 'PhotoController');
记住确保控制器专一，如果你发现你需要典型的资源行为之外的方法，考虑把你的控制器分为两个更小的控制器。

依赖注入 & 控制器

构造函数注入

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 contract 进行类型提示。如果容器能够获取它，你就可以使用它。根据你应用的需求为你的控制器注入依赖可以提供更好的可测试性。

方法注入

除了在构造函数注入，你还可以在类的方法中为依赖作类型提示。常见的方法注入是为你的控制器方法注入 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)
    {
        //
    }
}

路由缓存

基于闭包的路由不能被缓存。要使用路由缓存，你必须把闭包路由转换为控制器类。

如果你的应用只使用了基于控制器的路由，你可以使用 Laravel 的路由缓存。使用路由缓存可以大幅降低注册全部路由所需的时间。在某些情况下，你的路由注册甚至可能快上 100 倍。要生成路由缓存，只需要执行 route:cache Artisan 命令：

php artisan route:cache

允许这个命令后，每一个请求都会加载你的缓存路由文件。记住，添加任何路由后你都需要重新生成一个新的路由缓存。所以，你只有在项目部署时才需要运行 route:cache 命令。

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

php artisan route:clear

 

该篇属于专题:《Laravel 5.3 中文文档》

发表评论

友情链接