Skip to content

中间件

介绍

中间件为过滤进入应用程序的HTTP请求提供了一种方便的机制。例如,Laravel包含一个中间件,用于验证应用程序的用户是否已认证。如果用户未认证,中间件将重定向用户到登录页面。然而,如果用户已认证,中间件将允许请求进一步进入应用程序。

除了认证之外,还可以编写其他中间件来执行各种任务。例如,CORS中间件可能负责为离开应用程序的所有响应添加适当的头信息。日志中间件可能会记录所有进入应用程序的请求。

Laravel框架中包含了几种中间件,包括用于认证和CSRF保护的中间件。所有这些中间件都位于app/Http/Middleware目录中。

定义中间件

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

php
php artisan make:middleware CheckAge

此命令将在app/Http/Middleware目录中放置一个新的CheckAge类。在此中间件中,我们将仅允许访问路由,如果提供的age大于200。否则,我们将重定向用户回到home URI:

php
<?php

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重定向给客户端;否则,请求将被传递到应用程序的更深层。要将请求传递到应用程序的更深层(允许中间件“通过”),请使用$next回调和$request

最好将中间件设想为HTTP请求在到达应用程序之前必须通过的一系列“层”。每一层都可以检查请求,甚至完全拒绝它。

lightbulb

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

前置和后置中间件

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

php
<?php

namespace App\Http\Middleware;

use Closure;

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

        return $next($request);
    }
}

然而,此中间件将在请求被应用程序处理之后执行其任务:

php
<?php

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附带的中间件条目。要添加您自己的中间件,请将其附加到此列表并为其分配一个您选择的键:

php
// 在 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方法将中间件分配给路由:

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

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

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

在分配中间件时,您还可以传递完全限定的类名:

php
use App\Http\Middleware\CheckAge;

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

在将中间件分配给一组路由时,您可能偶尔需要防止中间件应用于组中的单个路由。您可以使用withoutMiddleware方法实现此目的:

php
use App\Http\Middleware\CheckAge;

Route::middleware([CheckAge::class])->group(function () {
    Route::get('/', function () {
        //
    });

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

withoutMiddleware方法只能移除路由中间件,不适用于全局中间件

中间件组

有时您可能希望将多个中间件分组在一个键下,以便更容易地分配给路由。您可以使用HTTP内核的$middlewareGroups属性来实现这一点。

Laravel开箱即用地提供了webapi中间件组,其中包含您可能希望应用于Web UI和API路由的常用中间件:

php
/**
 * 应用程序的路由中间件组。
 *
 * @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',
    ],
];

中间件组可以使用与单个中间件相同的语法分配给路由和控制器操作。再次强调,中间件组使得一次性为路由分配多个中间件更加方便:

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

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

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

开箱即用,web中间件组会自动应用于您的routes/web.php文件,由RouteServiceProvider提供。

中间件排序

很少情况下,您可能需要中间件以特定顺序执行,但无法控制它们在分配给路由时的顺序。在这种情况下,您可以使用app/Http/Kernel.php文件的$middlewarePriority属性指定中间件优先级:

php
/**
 * 优先级排序的中间件列表。
 *
 * 这会强制非全局中间件始终按给定顺序排列。
 *
 * @var array
 */
protected $middlewarePriority = [
    \Illuminate\Session\Middleware\StartSession::class,
    \Illuminate\View\Middleware\ShareErrorsFromSession::class,
    \Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,
    \Illuminate\Routing\Middleware\ThrottleRequests::class,
    \Illuminate\Session\Middleware\AuthenticateSession::class,
    \Illuminate\Routing\Middleware\SubstituteBindings::class,
    \Illuminate\Auth\Middleware\Authorize::class,
];

中间件参数

中间件还可以接收额外的参数。例如,如果您的应用程序需要在执行某个操作之前验证认证用户是否具有给定的“角色”,您可以创建一个CheckRole中间件,该中间件接收角色名称作为额外参数。

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

php
<?php

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)) {
            // 重定向...
        }

        return $next($request);
    }

}

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

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

可终止中间件

有时,中间件可能需要在HTTP响应发送到浏览器后执行一些工作。如果您在中间件上定义了一个terminate方法,并且您的Web服务器使用FastCGI,则在响应发送到浏览器后,terminate方法将自动被调用:

php
<?php

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方法注册中间件。通常,这应在AppServiceProvider.phpregister方法中完成:

php
use App\Http\Middleware\TerminableMiddleware;

/**
 * 注册任何应用程序服务。
 *
 * @return void
 */
public function register()
{
    $this->app->singleton(TerminableMiddleware::class);
}