中间件
介绍
中间件提供了一种方便的机制,用于检查和过滤进入应用程序的 HTTP 请求。例如,Laravel 包含一个中间件,用于验证应用程序的用户是否已认证。如果用户未认证,中间件将重定向用户到应用程序的登录界面。然而,如果用户已认证,中间件将允许请求进一步进入应用程序。
除了认证之外,还可以编写其他中间件来执行各种任务。例如,日志中间件可能会记录所有进入应用程序的请求。Laravel 框架中包含了几个中间件,包括用于认证和 CSRF 保护的中间件。所有这些中间件都位于app/Http/Middleware
目录中。
定义中间件
要创建新的中间件,请使用make:middleware
Artisan 命令:
php artisan make:middleware EnsureTokenIsValid
此命令将在app/Http/Middleware
目录中放置一个新的EnsureTokenIsValid
类。在此中间件中,我们将仅允许访问路由,如果提供的token
输入与指定值匹配。否则,我们将重定向用户回到home
URI:
<?php
namespace App\Http\Middleware;
use Closure;
class EnsureTokenIsValid
{
/**
* 处理传入的请求。
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
if ($request->input('token') !== 'my-secret-token') {
return redirect('home');
}
return $next($request);
}
}
如您所见,如果给定的token
与我们的秘密令牌不匹配,中间件将返回 HTTP 重定向给客户端;否则,请求将被传递到应用程序的更深层。要将请求传递到应用程序的更深层(允许中间件“通过”),您应该使用$request
调用$next
回调。
最好将中间件设想为 HTTP 请求在到达应用程序之前必须通过的一系列“层”。每一层都可以检查请求,甚至完全拒绝它。
所有中间件都是通过服务容器解析的,因此您可以在中间件的构造函数中类型提示任何所需的依赖项。
中间件与响应
当然,中间件可以在将请求传递到应用程序的更深层之前或之后执行任务。例如,以下中间件将在请求被应用程序处理之前执行某些任务:
<?php
namespace App\Http\Middleware;
use Closure;
class BeforeMiddleware
{
public function handle($request, Closure $next)
{
// 执行动作
return $next($request);
}
}
然而,此中间件将在请求被应用程序处理之后执行其任务:
<?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 附带的中间件条目。您可以将自己的中间件添加到此列表中,并为其分配一个您选择的键:
// 在 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('/profile', function () {
//
})->middleware('auth');
您可以通过将中间件名称数组传递给middleware
方法来为路由分配多个中间件:
Route::get('/', function () {
//
})->middleware(['first', 'second']);
在分配中间件时,您还可以传递完全限定的类名:
use App\Http\Middleware\EnsureTokenIsValid;
Route::get('/profile', function () {
//
})->middleware(EnsureTokenIsValid::class);
排除中间件
在将中间件分配给一组路由时,您可能偶尔需要防止中间件应用于组中的单个路由。您可以使用withoutMiddleware
方法实现此目的:
use App\Http\Middleware\EnsureTokenIsValid;
Route::middleware([EnsureTokenIsValid::class])->group(function () {
Route::get('/', function () {
//
});
Route::get('/profile', function () {
//
})->withoutMiddleware([EnsureTokenIsValid::class]);
});
您还可以从一组路由定义中排除给定的一组中间件:
use App\Http\Middleware\EnsureTokenIsValid;
Route::withoutMiddleware([EnsureTokenIsValid::class])->group(function () {
Route::get('/profile', function () {
//
});
});
withoutMiddleware
方法只能移除路由中间件,不适用于全局中间件。
中间件组
有时您可能希望将多个中间件分组在一个键下,以便更容易地分配给路由。您可以使用 HTTP 内核的$middlewareGroups
属性实现此目的。
Laravel 包含预定义的web
和api
中间件组,其中包含您可能希望应用于 Web 和 API 路由的常用中间件。请记住,这些中间件组是由应用程序的App\Providers\RouteServiceProvider
服务提供者自动应用于相应的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:api',
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
];
中间件组可以使用与单个中间件相同的语法分配给路由和控制器操作。同样,中间件组使得一次为路由分配多个中间件更加方便:
Route::get('/', function () {
//
})->middleware('web');
Route::middleware(['web'])->group(function () {
//
});
开箱即用,web
和api
中间件组会自动应用于应用程序的相应routes/web.php
和routes/api.php
文件中,由App\Providers\RouteServiceProvider
提供。
排序中间件
很少情况下,您可能需要中间件以特定顺序执行,但无法控制它们在分配给路由时的顺序。在这种情况下,您可以使用app/Http/Kernel.php
文件的$middlewarePriority
属性指定中间件优先级。此属性可能在您的 HTTP 内核中默认不存在。如果不存在,您可以复制其默认定义如下:
/**
* 优先级排序的中间件列表。
*
* 这会强制非全局中间件始终按给定顺序排列。
*
* @var string[]
*/
protected $middlewarePriority = [
\Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class,
\Illuminate\Cookie\Middleware\EncryptCookies::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,
\Illuminate\Routing\Middleware\ThrottleRequests::class,
\Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,
\Illuminate\Contracts\Session\Middleware\AuthenticatesSessions::class,
\Illuminate\Routing\Middleware\SubstituteBindings::class,
\Illuminate\Auth\Middleware\Authorize::class,
];
中间件参数
中间件还可以接收额外的参数。例如,如果您的应用程序需要在执行给定操作之前验证认证用户是否具有给定的“角色”,您可以创建一个EnsureUserHasRole
中间件,该中间件接收角色名称作为额外参数。
额外的中间件参数将在$next
参数之后传递给中间件:
<?php
namespace App\Http\Middleware;
use Closure;
class EnsureUserHasRole
{
/**
* 处理传入的请求。
*
* @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);
}
}
在定义路由时,可以通过用:
分隔中间件名称和参数来指定中间件参数。多个参数应以逗号分隔:
Route::put('/post/{id}', function ($id) {
//
})->middleware('role:editor');
可终止中间件
有时,中间件可能需要在 HTTP 响应发送到浏览器后执行一些工作。如果您在中间件上定义了一个terminate
方法,并且您的 Web 服务器使用 FastCGI,则在响应发送到浏览器后,terminate
方法将自动被调用:
<?php
namespace Illuminate\Session\Middleware;
use Closure;
class TerminatingMiddleware
{
/**
* 处理传入的请求。
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
return $next($request);
}
/**
* 在响应发送到浏览器后处理任务。
*
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Http\Response $response
* @return void
*/
public function terminate($request, $response)
{
// ...
}
}
terminate
方法应接收请求和响应。一旦定义了可终止中间件,您应该将其添加到app/Http/Kernel.php
文件中的路由或全局中间件列表中。
在调用中间件的terminate
方法时,Laravel 将从服务容器解析中间件的新实例。如果您希望在调用handle
和terminate
方法时使用相同的中间件实例,请使用容器的singleton
方法在容器中注册中间件。通常,这应该在AppServiceProvider
的register
方法中完成:
use App\Http\Middleware\TerminatingMiddleware;
/**
* 注册任何应用程序服务。
*
* @return void
*/
public function register()
{
$this->app->singleton(TerminatingMiddleware::class);
}