HTTP Middleware

未匹配的标注
本文档最新版为 6.x,旧版本可能放弃维护,推荐阅读最新版!

HTTP Middleware

简介

HTTP 中间件提供了一个方便的机制来过滤进入应用程序的 HTTP 请求,例如,Lumen 本身使用中间件来验证用户的身份,如果用户未通过身份验证,中间件将会把用户导向登录页面,反之,当用户通过了身份验证,中间件将会通过此请求并接着往下执行。

当然,除了身份验证之外,中间件也可以被用来运行各式各样的任务,CORS 中间件负责替所有即将离开程序的响应加入适当的标头。而日志中间件则可以记录所有传入应用程序的请求。

创建中间件

要创建一个新的中间件,则可以使用 make:middleware 这个 Artisan 命令:

所有的中间件都放在 app/Http/Middleware 目录内,创建一个中间件,只需要在类里面增加 handle 方法,如下:

/**
 * Filter the incoming request.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Closure  $next
 * @return mixed
 */
public function handle($request, Closure $next)
{
    //
}

例如在以下 OldMiddleware,在这个中间件内我们只允许请求的 age 变量大于 200 时才能访问路由,否则,我们会将用户重定向到「home」这个 URI 上。

<?php

namespace App\Http\Middleware;

use Closure;

class OldMiddleware
{
    /**
     * Filter the incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if ($request->input('age') <= 200) {
            return redirect('home');
        }

        return $next($request);
    }

}

如你所见,若是 age 小于 200,中间件将会返回 HTTP 重定位给用户端,否则,请求将会进一步传递到应用程序。只需调用带有 $request 的 $next 方法,即可将请求传递到更深层的应用程序(允许通过中间件)。

HTTP 请求在实际碰触到应用程序之前,最好是可以层层通过中间件。每一层都可以对请求进行检查,甚至完全拒绝请求。

前置中间件 / 后置中间件

「前置中间件(BeforeMiddleware)」运行于请求处理之前:

<?php

namespace App\Http\Middleware;

use Closure;

class BeforeMiddleware
{
    public function handle($request, Closure $next)
    {
        // Perform action

        return $next($request);
    }
}

Summer 前置中间件运行的时间点是在每一个请求处理之前,可以参阅此文章加深理解:如何查看 Laravel 5 的所有数据库请求

这个中间件会在应用程序处理请求运行它的任务:

<?php

namespace App\Http\Middleware;

use Closure;

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

        // Perform action

        return $response;
    }
}

Summer 后置中间件运行的时间点是在请求处理之后,可以参阅此文章加深理解:如何查看 Laravel 5 的所有数据库请求

注册中间件

全局中间件

若是希望每个 HTTP 请求都经过一个中间件,只要将中间件的类加入到 bootstrap/app.php$app->middleware() 属性清单列表中。

为路由指派中间件

如果你要指派中间件给特定路由,你得先在 bootstrap/app.php 给中间件设置一个好记的键,默认情况下,这个文件内的 $app->routeMiddleware() 属性已包含了 Lumen 目前设置的中间件,你只需要在清单列表中加上一组自定义的键即可。

$app->routeMiddleware([
    'old' => 'App\Http\Middleware\OldMiddleware',
]);

中间件一旦在 HTTP kernel 文件内被定义,即可在路由选项内使用 middleware 键值指定:

$app->get('admin/profile', ['middleware' => 'auth', function () {
    //
}]);

中间件参数

中间件也可以接收自定义传参,例如,如果应用程序要在运行特定操作之前检查通过已验证用户是否具备该操作的「角色」,可以创建 RoleMiddleware 来接收角色名称作为额外的传参。

附加的中间件参数将会在 $next 参数之后被传入中间件:

<?php

namespace App\Http\Middleware;

use Closure;

class RoleMiddleware
{
    /**
     * Run the request filter.
     *
     * @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);
    }

}

在路由中可使用冒号 : 来区隔中间件名称与指派参数,多个参数可使用逗号作为分隔:

$app->put('post/{id}', ['middleware' => 'role:editor', function ($id) {
    //
}]);

Terminable 中间件

有些时候中间件需要在 HTTP 响应被发送到浏览器之后才运行,例如,Lumen 内置的「session」中间件存储的 session 数据是在响应被发送到浏览器之后才进行写入的。想要做到这一点,你需要定义中间件为「terminable」。

<?php namespace Illuminate\Session\Middleware;

use Closure;

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

    public function terminate($request, $response)
    {
        // Store the session data...
    }
}

terminate 方法必须接收请求及响应。一旦定义了 terminable 中间件,你便需要将它增加到 bootstrap/app.php$app->middleware() 全局中间件清单列表中。

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

上一篇 下一篇
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 0
发起讨论 只看当前版本


暂无话题~