控制器

Laravel 中文文档 / 基础功能

控制器

简介

除了在路由文件中用闭包定义所有的请求处理逻辑外,还可以将其组织到控制器类中。控制器可以将相关的请求处理逻辑分组到单个类中。控制器存储在 app/Http/Controllers 目录中。

基本控制器

定义控制器

以下是一个基本的控制器类的示例。需要注意的是,该控制器继承了 Laravel 自带的控制器基类。控制器基类提供了一些方便的方法,例如使用 middleware 方法为控制器操作添加中间件:

namespace App\Http\Controllers;

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

class UserController extends Controller
{
    /**
     * 显示给定用户的配置信息
     *
     * @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 方法。当然,路由参数也会传递给该方法。

控制器 不需要 继承自基类。但是,如果控制器没有继承基类,您将无法使用一些方便的功能,例如 middlewarevalidatedispatch 方法。

控制器 & 命名空间

需要注意的是,在定义控制器路由时,我们不需要指定完整的控制器命名空间。因为 RouteServiceProvider 会在一个包含命名空间的路由组中加载路由文件,所以我们只需要指定类名中 App\Http\Controllers 命名空间之后的部分。

如果控制器在 App\Http\Controllers 目录中,只需要使用相对于 App\Http\Controllers 根命名空间的具体类名。因此,如果完整的控制器类是 App\Http\Controllers\Photos\AdminController,那么应该像这样注册到控制器的路由:

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

单操作控制器

如果要定义一个只处理单个操作的控制器,可以在控制器中放置一个 __invoke 方法:

namespace App\Http\Controllers;

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

class ShowProfile extends Controller
{
    /**
     * 显示给定用户的配置信息
     *
     * @param  int  $id
     * @return Response
     */
    public function __invoke($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

在为单操作控制器注册路由时,无需指定方法:

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

可以在运行 Artisan 命令 nake:controller 时使用 --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 请求。可以使用 Artisan 命令 make:controller 快速创建控制器:

php artisan make:controller PhotoController --resource

该命名会生成一个控制器 app/Http/Controllers/PhotoController.php。控制器中包含了每个可用资源操作的方法。

接下来,您可以注册一个到控制器的资源路由:

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

该路由声明创建多个路由来处理资源的各种操作。生成的控制器已为每个操作预留了方法,还包括了处理的 HTTP 请求和 URI 的注释。

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

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

资源控制器处理的操作

HTTP 动词 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 表单不能进行 PUTPATCHDELETE 请求,因此需要添加一个 _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 资源路由

在声明用于 API 的资源路由时,您通常希望排除用于显示 HTML 模板的 createedit 路由。为了方便,可以使用 apiResource 方法自动排除这两个路由:

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

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

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

要快速生成不包含 createedit 方法的 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。如果您需要本地化 createedit 操作动词,可以使用 Route::resourceVerbs 方法。在 AppServiceProviderboot 方法中定义:

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 控制器。因此,您可以在构造函数中对任何控制器需要的依赖使用类型提示。声明的依赖会自动解析并注入到控制器实例:

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 Contract 使用类型提示。只要容器可以解析它,就能使用类型提示。根据应用,在控制器中注入依赖可能会提供更好的可测试性。

方法注入

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

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,如下所示:

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 的路由缓存。使用路由缓存将极大地减少注册应用所有路由所需的时间。某些情况下,路由注册的速度甚至可以快一百倍。要生成路由缓存,只需执行 Artisan 命令 route:cache

php artisan route:cache

运行此命令后,每个请求都会加载已缓存的路由文件。请记住,如果添加了任何新的路由,则需要生成新的路由缓存。因此,应该只在项目部署时才运行 route:cache 命令。

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

php artisan route:clear
  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...