中间件

介绍

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

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

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

定义中间件

通过运行 make:middleware Artisan 命令来创建新的中间件:

  1. php artisan make:middleware CheckAge

该命令将会在 app/Http/Middleware 目录下创建一个新的 CheckAge类,在这个中间件中,我们仅允许 age 参数大于 200 的请求对此路由进行访问,否则,我们将此用户重定向到 home

  1. <?php
  2. namespace App\Http\Middleware;
  3. use Closure;
  4. class CheckAge
  5. {
  6. /**
  7. * 处理传入的请求
  8. *
  9. * @param \Illuminate\Http\Request $request
  10. * @param \Closure $next
  11. * @return mixed
  12. */
  13. public function handle($request, Closure $next)
  14. {
  15. if ($request->age <= 200) {
  16. return redirect('home');
  17. }
  18. return $next($request);
  19. }
  20. }

正如你所见,假如给定的 age 参数小于或等于 200 ,这个中间件将返回一个HTTP重定向到客户端;否则,请求将进一步传递到应用中。要让请求继续传递到应用程序中(即允许「通过」中间件验证的),只需使用 $request 作为参数去调用回调函数 $next

最好将中间件想象为一系列 HTTP 请求必须经过才能进入你应用的「层」。每一层都会检查请求(是否符合某些条件),(如果不符合)甚至可以(在请求访问你的应用之前)完全拒绝掉。

前置 & 后置中间件

中间件是在请求之前或之后运行取决于中间件本身。例如, 接下来的这个中间件将在应用处理请求 之前 执行其任务:

  1. <?php
  2. namespace App\Http\Middleware;
  3. use Closure;
  4. class BeforeMiddleware
  5. {
  6. public function handle($request, Closure $next)
  7. {
  8. // Perform action
  9. return $next($request);
  10. }
  11. }

而接下来的这个中间件将在应用处理请求 之后 执行其任务:

  1. <?php
  2. namespace App\Http\Middleware;
  3. use Closure;
  4. class AfterMiddleware
  5. {
  6. public function handle($request, Closure $next)
  7. {
  8. $response = $next($request);
  9. // 执行操作
  10. return $response;
  11. }
  12. }

注册中间件

全局中间件

假设你想让中间件在应用处理每个HTTP请求期间运行,只需要在 app/Http/Kernel.php 中的 $middleware 属性中列出这个中间件

为路由分配中间件

假设你想为指定的路由分配中间件,首先应该在 app/Http/Kernel.php 文件内为该中间件分配一个 。默认情况下, Kernel 类的 $routeMiddleware 属性下包含了Laravel内置的中间件。若要加入自定义的中间件,只需把它附加到列表后并为其分配一个自定义 即可。例如:

  1. // 在 App\Http\Kernel 类中
  2. protected $routeMiddleware = [
  3. 'auth' => \Illuminate\Auth\Middleware\Authenticate::class,
  4. 'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
  5. 'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
  6. 'can' => \Illuminate\Auth\Middleware\Authorize::class,
  7. 'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
  8. 'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
  9. ];

一旦在 Kernel 类中定义好了中间件,就可以通过 middleware 方法将为路由分配中间件:

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

你也可以为路由分配多个中间件:

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

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

  1. use App\Http\Middleware\CheckAge;
  2. Route::get('admin/profile', function () {
  3. //
  4. })->middleware(CheckAge::class);

中间件组

某些时候你可能希望使用一个 key 把多个中间件打包成一个组,方便将他们应用到路由中。你可以使用 Http kernel 的 $middlewareGroups 属性。

Laravel 内置了 webapi 两个中间件组,它们包含了常用的中间件,你可能会想应用到 web UI 和 API 路由中:

  1. /**
  2. * 应用程序的路由中间件组
  3. *
  4. * @var array
  5. */
  6. protected $middlewareGroups = [
  7. 'web' => [
  8. \App\Http\Middleware\EncryptCookies::class,
  9. \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
  10. \Illuminate\Session\Middleware\StartSession::class,
  11. \Illuminate\View\Middleware\ShareErrorsFromSession::class,
  12. \App\Http\Middleware\VerifyCsrfToken::class,
  13. \Illuminate\Routing\Middleware\SubstituteBindings::class,
  14. ],
  15. 'api' => [
  16. 'throttle:60,1',
  17. 'auth:api',
  18. ],
  19. ];

中间件组和单个中间件一样可以被应用到路由和控制器行为中。同时,中间组很方便得将多个中间件一次性应用到路由上:

  1. Route::get('/', function () {
  2. //
  3. })->middleware('web');
  4. Route::group(['middleware' => ['web']], function () {
  5. //
  6. });

{提示} RouteServiceProviderweb 中间组自动应用到 routes/web.php

中间件参数

中间件也可以接受额外的参数。举个例子,假如你的应用需要在执行特定操作之前验证用户是否为给定的 「角色」,你可以通过创建一个 CheckRole 中间件,由它来接收「角色」名称作为附加参数。

附加的中间件参数应该在 $next 参数之后被传递:

  1. <?php
  2. namespace App\Http\Middleware;
  3. use Closure;
  4. class CheckRole
  5. {
  6. /**
  7. * 处理传入的参数
  8. *
  9. * @param \Illuminate\Http\Request $request
  10. * @param \Closure $next
  11. * @param string $role
  12. * @return mixed
  13. */
  14. public function handle($request, Closure $next, $role)
  15. {
  16. if (! $request->user()->hasRole($role)) {
  17. // 重定向
  18. }
  19. return $next($request);
  20. }
  21. }

定义路由时通过一个 : 来隔开中间件名称和参数来指定中间件参数。多个参数就使用逗号分隔:

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

Terminable 中间件

有时中间件可能需要在 HTTP 响应发送到浏览器之后处理一些工作。比如,Laravel 内置的「session」中间件会在响应发送到浏览器之后将会话数据写入存储器中。如果你在中间件中定义一个 terminate 方法,则会在响应发送到浏览器后自动调用:

  1. <?php
  2. namespace Illuminate\Session\Middleware;
  3. use Closure;
  4. class StartSession
  5. {
  6. public function handle($request, Closure $next)
  7. {
  8. return $next($request);
  9. }
  10. public function terminate($request, $response)
  11. {
  12. // Store the session data...
  13. }
  14. }

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

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

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。