Laravel 5.2 中文文档

简体中文

English

简体中文

English

主题

HTTP 控制器 ​

介绍 ​

与其在单个 routes.php 文件中定义所有请求处理逻辑，不如使用控制器类来组织这些行为。控制器可以将相关的 HTTP 请求处理逻辑分组到一个类中。控制器存储在 app/Http/Controllers 目录中。

基本控制器 ​

以下是一个基本控制器类的示例。所有 Laravel 控制器都应继承默认 Laravel 安装中包含的基控制器类：

php
<?php

namespace App\Http\Controllers;

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

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

我们可以这样路由到控制器动作：

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

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

控制器与命名空间 ​

需要特别注意的是，在定义控制器路由时，我们不需要指定完整的控制器命名空间。我们只定义了 App\Http\Controllers 命名空间 "根" 之后的类名部分。默认情况下，RouteServiceProvider 将在包含根控制器命名空间的路由组中加载 routes.php 文件。

如果您选择使用更深的 PHP 命名空间嵌套或组织控制器，只需使用相对于 App\Http\Controllers 根命名空间的特定类名即可。因此，如果您的完整控制器类是 App\Http\Controllers\Photos\AdminController，您可以这样注册路由：

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

命名控制器路由 ​

与闭包路由一样，您可以在控制器路由上指定名称：

php
Route::get('foo', ['uses' => 'FooController@method', 'as' => 'name']);

您还可以使用 route 辅助函数生成指向命名控制器路由的 URL：

php
$url = route('name');

控制器中间件 ​

中间件 可以像这样分配给控制器的路由：

php
Route::get('profile', [
    'middleware' => 'auth',
    'uses' => 'UserController@showProfile'
]);

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

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

        $this->middleware('log', ['only' => [
            'fooAction',
            'barAction',
        ]]);

        $this->middleware('subscribed', ['except' => [
            'fooAction',
            'barAction',
        ]]);
    }
}

RESTful 资源控制器 ​

资源控制器使围绕资源构建 RESTful 控制器变得轻而易举。例如，您可能希望创建一个控制器来处理应用程序存储的 "照片" 的 HTTP 请求。使用 make:controller Artisan 命令，我们可以快速创建这样的控制器：

php
php artisan make:controller PhotoController --resource

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

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

php
Route::resource('photo', 'PhotoController');

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

资源控制器处理的操作 ​

动词路径操作路由名称
GET/photoindexphoto.index
GET/photo/createcreatephoto.create
POST/photostorephoto.store
GET/photo/{photo}showphoto.show
GET/photo/{photo}/editeditphoto.edit
PUT/PATCH/photo/{photo}updatephoto.update
DELETE/photo/{photo}destroyphoto.destroy

请记住，由于 HTML 表单无法发出 PUT、PATCH 或 DELETE 请求，您需要添加一个隐藏的 _method 字段来伪造这些 HTTP 动词：

php
<input type="hidden" name="_method" value="PUT">

部分资源路由 ​

在声明资源路由时，您可以指定要在路由上处理的操作子集：

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

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

命名资源路由 ​

默认情况下，所有资源控制器操作都有一个路由名称；但是，您可以通过在选项中传递 names 数组来覆盖这些名称：

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

命名资源路由参数 ​

默认情况下，Route::resource 将根据资源名称创建资源路由的路由参数。您可以通过在选项数组中传递 parameters 来轻松覆盖此设置。parameters 数组应为资源名称和参数名称的关联数组：

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

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

php
/user/{admin_user}

除了传递参数名称数组，您还可以简单地传递单词 singular 来指示 Laravel 使用默认参数名称，但将其 "单数化"：

php
Route::resource('users.photos', 'PhotoController', [
    'parameters' => 'singular'
]);

// /users/{user}/photos/{photo}

或者，您可以将资源路由参数全局设置为单数，或为资源参数名称设置全局映射：

php
Route::singularResourceParameters();

Route::resourceParameters([
    'user' => 'person', 'photo' => 'image'
]);

在自定义资源参数时，重要的是要记住命名优先级：

  1. 显式传递给 Route::resource 的参数。
  2. 通过 Route::resourceParameters 设置的全局参数映射。
  3. 通过 parameters 数组传递给 Route::resource 的 singular 设置或通过 Route::singularResourceParameters 设置。
  4. 默认行为。

补充资源控制器 ​

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

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

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

依赖注入与控制器 ​

构造函数注入 ​

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

php
<?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
<?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->input('name');

        //
    }
}

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

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

您仍然可以类型提示 Illuminate\Http\Request 并通过以下方式定义控制器方法来访问路由参数 id：

php
<?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)
    {
        //
    }
}

路由缓存 ​

lightbulb

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

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

php
php artisan route:cache

就是这样！现在将使用缓存的路由文件，而不是 app/Http/routes.php 文件。请记住，如果您添加了任何新路由，则需要生成新的路由缓存。因此，您应该仅在项目部署期间运行 route:cache 命令。

要在不生成新缓存的情况下删除缓存的路由文件，请使用 route:clear 命令：

php
php artisan route:clear

版权所有 © 2024-2025 laravel.wiki