HTTP 中间件

学习笔记之Lumen

简介

HTTP中间件提供了一个方便的机制过滤进入应用的请求.例如,Lumen包含了一个验证CSRF token的中间件.

当然,除了CSRF验证,中间件可以被用来执行多种任务.CORS中间件负责为应用的response添加合适的header.logging中间件可以用来记录所有进入应用的请求.

所有的中间件通常位于app/Http/Middleware目录.

定义中间件

要创建一个中间件,简单的创建一个拥有一个handle方法类:

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

For example, let's create a middleware that will only allow access to the route if the supplied age is greater than 200. Otherwise, we will redirect the users back to the "home" URI.

举例,让我们创建一个中间件,只在提供的age大于200时允许访问路由.否则,我们会将用户重新导向 home URI 。

<?php namespace App\Http\Middleware;
class OldMiddleware {
    /**
     * Run the request filter.
     *
     * @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);
    }
}

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

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

Before / After Middleware

一个中间件运行在请求前后依赖于它自身.
这个中间件在请求被处理之前执行一些任务

<?php namespace App\Http\Middleware;
class BeforeMiddleware implements Middleware {
    public function handle($request, Closure $next)
    {
        // Perform action
        return $next($request);
    }
}

然而,这个中间件执行它的任务在请求被处理之后.

<?php namespace App\Http\Middleware;
class AfterMiddleware implements Middleware {
    public function handle($request, Closure $next)
    {
        $response = $next($request);
        // Perform action
        return $response;
    }
}

注册中间件

全局中间件

如果你想在每一次HTTP请求时运行一个中间件,仅仅需要在bootstrap/app.php文件用的$app->middleware()中列出你的中间件类.

指派中间件给路由

如果你想要为特定的路由指定中间件,你应该首先在bootstrap/app.php文件中为中间件指定一个简短的key.

系统默认用$app->routeMiddleware()方法包含一些中间件.要添加自己的中间件,简单的追加在这个列表,并指定一个key.例如:

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

一旦这个中间件被定义进HTTP kernel,你可以在路由options array应用中间件key:

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

可终止中间件

有些时候中间件需要在 HTTP 响应已被发送到用户端之后才执行，例如，Laravel 和Lumen 内置的 session 中间件，保存 session 数据是在响应已被发送到用户端之后才执行。为了做到这一点，你需要定义继承 Illuminate\Contracts\Routing\TerminableMiddleware的中间件。

use Illuminate\Contracts\Routing\TerminableMiddleware;
class StartSession implements TerminableMiddleware {
    public function handle($request, $next)
    {
        return $next($request);
    }
    public function terminate($request, $response)
    {
        // Store the session data...
    }
}

如你所见，除了定义 handle 方法之外， TerminableMiddleware 定义一个 terminate 方法。这个方法接收请求和响应。一旦定义了 terminable 中间件，你需要将它增加到 HTTP kernel 的全局中间件清单列表中。