中间件

Laravel 中文文档 / 基础功能

中间件

简介

中间件提供了方便的机制来过滤进入应用的 HTTP 请求。例如,Laravel 包含一个验证应用的用户是否通过身份认证的中间件。如果用户没有通过身份认证,中间件会将用户重定向到登录界面。相反,如果用户已通过身份认证,中间件将允许该请求进一步进入应用。

当然,除了身份认证以外,还可以编写其它中间件来执行各种任务。CORS 中间件负责为离开应用的所有响应添加合适的头信息。日志中间件会记录所有传入应用的请求。

Laravel 自带了多个中间件,包括身份认证、CSRF 保护中间件。所有这些中间件都位于 app/Http/Middleware 目录中。

定义中间件

要创建新的中间件,使用 Artisan 命令 make:middleware

php artisan make:middleware CheckAge

该命令会在 app/Http/Middleware 目录中新建一个 CheckAge 类。在此中间件中,只有当提供的参数 age 大于 200 时,我们才允许访问该路由。否则,我们会将用户重定向到 home

namespace App\Http\Middleware;

use Closure;

class CheckAge
{
    /**
     * 处理传入的请求
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if ($request->age <= 200) {
            return redirect('home');
        }

        return $next($request);
    }
}

如您所见,如果给定的 age 小于或等于 200,中间件会返回一个 HTTP 重定向到客户端;否则,请求会进一步传入应用。如果允许请求继续传入应用(即允许「通过」中间件),可以将 $request 作为参数调用回调函数 $next

最好将中间件想象为 HTTP 请求在到达应用前必须经过的一连串的「层」。每一层都可以检查请求,甚至完全拒绝它。

所有中间件都通过 服务容器 解析,因此您可以在中间件的构造函数中对任何依赖使用类型提示。

前置 & 后置中间件

中间件在请求之前还是之后运行取决于中间件本身。例如,以下的中间件会在应用处理请求 之前 执行一些任务:

namespace App\Http\Middleware;

use Closure;

class BeforeMiddleware
{
    public function handle($request, Closure $next)
    {
        // 执行操作

        return $next($request);
    }
}

但是,下面的中间件会在应用处理请求 之后 执行其任务:

namespace App\Http\Middleware;

use Closure;

class AfterMiddleware
{
    public function handle($request, Closure $next)
    {
        $response = $next($request);

        // 执行操作

        return $response;
    }
}

注册中间件

全局中间件

如果要在应用的每个 HTTP 请求时都运行中间件,只需在 app/Http/Kernel.php 类的 $middleware 属性里列出该中间件类 。

为路由分配中间件

如果要将中间件分配给指定路由,首先应该在 app/Http/Kernel.php 文件为该中间件指定一个键。默认情况下,$routeMiddleware 属性包含 Laravel 内置的中间件列表。如果要添加自己的,可以将其追加到列表最后并为其指定一个自定义键:

App\Http\Kernel

protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
];

在 HTTP 内核中定义中间件后,可以使用 middleware 将中间件分配给路由:

Route::get('admin/profile', function () {
    //
})->middleware('auth');

您还可以为路由分配多个中间件:

Route::get('/', function () {
    //
})->middleware('first', 'second');

分配中间件时,您还可以传递完整的类名:

use App\Http\Middleware\CheckAge;

Route::get('admin/profile', function () {
    //
})->middleware(CheckAge::class);

中间件组

有时您可能希望将多个中间件组合起来放到一个键下面,使其更容易分配给路由。可以使用 HTTP 内核的 $middlewareGroups 属性来实现。

Laravel 自带开箱即用的 webapi 中间件组,包含了在 Web 用户界面和 API 路由中使用的常见中间件:

/**
 * 应用的路由中间件组
 *
 * @var array
 */
protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],

    'api' => [
        'throttle:60,1',
        'auth:api',
    ],
];

可以使用和单个中间件相同的语法将中间件组分配给路由和控制器操作。同理,使用中间件组可以更方便地同时为路由分配多个中间件:

Route::get('/', function () {
    //
})->middleware('web');

Route::group(['middleware' => ['web']], function () {
    //
});

开箱即用,web 中间件组会自动被 RouteServiceProvider 应用到 routes/web.php 文件。

中间件参数

中间件也可以接收额外参数。例如,如果应用需要在执行指定操作之前,验证通过身份认证的用户是否具有给定的「角色」,那么您可以新建一个 CheckRole 中间件,接收角色名作为额外参数。

额外中间件参数将在 $next 参数后传递给中间件:

namespace App\Http\Middleware;

use Closure;

class CheckRole
{
    /**
     * 处理传入的请求
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @param  string  $role
     * @return mixed
     */
    public function handle($request, Closure $next, $role)
    {
        if (! $request->user()->hasRole($role)) {
            // Redirect...
        }

        return $next($request);
    }

}

定义路由时,通过 : 分隔中间件名称和参数来指定中间件参数。多个参数应使用逗号进行分隔:

Route::put('post/{id}', function ($id) {
    //
})->middleware('role:editor');

Terminable 中间件

有时中间件可能需要在准备好 HTTP 响应后处理一些工作。例如,Laravel 内置的「Session」中间件会在响应完全准备好后将 Session 数据写入存储。如果在中间件中定义了 terminate 方法,那么在准备好发送响应到浏览器时会自动调用该方法。

namespace Illuminate\Session\Middleware;

use Closure;

class StartSession
{
    public function handle($request, Closure $next)
    {
        return $next($request);
    }

    public function terminate($request, $response)
    {
        // 存储会话数据
    }
}

terminate 方法应该同时接收请求和响应。定义该中间件后,应该将其添加到 app/Http/Kernel.php 文件的路由列表或全局中间件中。

在中间件上调用 terminate 方法时,Laravel 会从 服务容器 中解析出一个新的中间件实例。如果要在调用 handleterminate 方法时使用相同的中间件实例,应使用容器的 singleton 方法向容器注册中间件。

  上一篇 下一篇  

作者:ilaoniu

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