Laravel Middleware

HTTP中间件

中间件(Middleware)作为Http请求(Request)和Http响应(Response)之间的中间人,本质是对HTTP过滤和完善的一种机制。可以完成对请求数据的拦截处理、数据校验,同时在进入逻辑处理后会判断是否允许进入下一个中间件。应用中通过多个中间件的层层过滤逐步完善以实现解耦。

在Laravel中Middleware起着过滤进入应用的HTTP请求对象(Request)并完善离开应用的HTTP响应对象(Response)的作用。因此中间件实际分为两大角色,过滤请求的称为前置中间件,完善响应的称之为后置中间件。

Middleware作用

  • 使用Middleware可为系统提供HTTP过滤层,可让系统层次更为明确。
  • Middleware在路由上拦截请求,为路由增加一层保护和过滤。

装饰器模式(Decorator Pattern)

Laravel是如何实现Middleware的呢?

Laravel中Middleware实现修饰器模式,通过捕获请求进而处理并将处理后的请求对象返回给下一个堆栈层。

编码中动态扩展类的功能经常会使用继承的方式来实现,随着动态扩展的功能越来越多,子类逐渐会越来越膨胀,系统也会变得越来越不够灵活。

装饰器模式允许向一个现有的对象中添加新的功能,同时又不改变其原来的结构。也就时说在类中动态扩展功能时依然保持类原本的灵活性。即实现在“开放封闭”原则下动态新增或删除功能。

开放封闭原则(OCP,Open Closed Principle)即对扩展开放对修改封闭。

比如在请求发送后且执行前,可能需进行Cookie加密、开启Session、CSRF保护等操作,但每个请求各有不同,而且执行请求后可能仍需执行某些操作。此时就需要根据请求的特性动态的新增操作。

应用场景

  • 授权认证
  • 加密解密
  • cookie队列
  • session读写
  • 速率限制
  • 请求解析

场景1:验证用户认证中间件
用户登录流程中,使用中间件来验证用户是否已认证,若认证失败则重定向至登录视图,若认证成功则登录请求会被认证中间件通过,并将请求传递给应用。

场景2:跨同源策略中间件
用于处理请求在被响应前添加正确的响应头

场景3:日志中间件
在应用被请求时优先记录下请求信息

[案例] 路由中使用SESSION回话
app/Http/routes.php

//未用中间件
Route::get('/', function () {
    session(['start_time'=>time()]);//存入session
    return view('welcome');
});
Route::get('/test',function(){
    return session('start_time');//获取session
});
//使用中间件
Route::group(['middleware'=>'web'],function(){
    Route::get('/', function () {
        session(['start_time'=>time()]);//存入session
        return view('welcome');
    });
    Route::get('/test',function(){
        return session('start_time');//获取session
    });
});

[疑问] 为什么 session() 放在 Route::group(['middleware'=>'web'],function(){...}) 才生效呢?
查看中间件注册文件 app/Http/Kernal.php,发现在$middlewareGrouops成员属性的web中存在SessionCookie相关的配置。

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        //关于Cookie的处理
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        //关于Session的处理
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
    ],
    'api' => [
        'throttle:60,1',
    ],
];

注册中间件

使用中间件之前必须创建并注册,Laravel中间件分为两种类型。

  • 全局中间件:在应用的每个HTTP请求中运行
  • 路由中间件:分配给特定路由使用的中间件

中间件的注册文件位于 app/Http/Kernal.php,在Kernal类中存在两个成员属性$middleware$routeMiddleware

class Kernal extends HttpKernal
{
  //注册全局中间件
  protected $middleware = [];
  //注册路由中间件
  protected $routeMiddleware = [];
}

创建中间件

可使用php artisan命令查看所有的命令选项,使用artisan命令创建中间件make:middleware,创建的中间件将保存在 app/Http/Middleware 目录下。

[验证] 中间件具有拦截HTTP请求的作用
步骤1:在CLI命令行提示界面运行命令,创建登录中间件。
使用命令行生成文件:php artisan make:middleware AdminLogin
生成中间件文件路径:app/Http/Middleware/AdminLogin.php
在中间件文件中添加配置信息

public function handler($request, Closure $next){
  echo 'stop'; //中间件具有拦截HTTP请求作用,此处应有输出。
  exit;//后续控制器中方法中断执行
  return $next($request);
}

步骤2:将AdminLogin中间件注册到路由中间件中
中间件配置文件路径:app/Http/Kernal.php

protected $routeMiddleware = [
  'admin.login'=>\App\Http\Middleware\AdminLogin::class,
];

步骤3:在路由配置文件中调用中间件
路由配置文件:app/Http/routes.php

Route::group(['middleware'=>['admin.login']], function(){
  Route::get('admin/login', 'Admin\LoginController@index');
})

步骤4:使用浏览器访问本地域名并查看页面输出
http://blog.com/admin/login

使用中间件

[案例] 用户登录时根据SESSION判断登录状态
步骤1:使用artisan命令创建后台登录中间件
php artisan make:middleware AdminLogin
步骤2:将中间件注册到路由中
app/Http/Kernal.php

protected $routeMiddleware = [
  'admin.login'=>\App\Http\Middleware\AdminLogin::class,
];

步骤3:配置路由规则
(1)设置后台登录路由
app/Http/routes.php

Route::group(['middleware'=>'web'],function(){
  //进入后台用户登录页面
  Route::get('admin/login', 'Admin\IndexController.php@login');
});

(2)处理用户登录
app\Http\Controllers\Admin\IndexController.php

public function login(){
  //用户登录成功后写入session
  session(['login_user_id'=>999]);
  return __FUNCTION__;
}

(3)设置后台首页路由
app/Http/routes.php

Route::group(['prefix'=>'admin', 'namespace'=>'Admin', 'middleware'=>['web','admin.login']], function(){
  //后台首页获取session数据
  Route('index', 'IndexController@index');//预设后台首页控制器及操作
});

(5)设置后台登录中间件
app/Http/Middleware/AdminLogin.php

public function handler($request, Closure $next){
  //若session中不存在用户登录信息则跳转至登录页面
  if(!session('login_user_id')){
    return redirect('admin/index');
  }
  //否则进入预设控制器
  return $next($request);
}

(4)预设后台首页
app/Http/Controllers/Admin/IndexController.php

public function index(){
   echo 'admin index page'; 
}

小结

  • 中间节位于路由和控制器之间
  • 中间件对HTTP请求拦截并过滤
  • 中间件自动创建 php artisan make:middleware MiddleName
  • 中间件在路由配置的关键为middleware
  • 中间件针对路由分为全局$middleware和特定routeMiddleware
  • 中间件注册和使用时应使用驼峰转小写和点号连接方式
  • 自定义中间件在 handler() 内进行编写拦截过滤业务逻辑
  • sessioncookie 需在路由分组的 middleware 参数配置 web

Laravel中间件

中间节的使用场景如用户认证、权限验证、访问记录、重定向、日志、开启回话等,Laravel中可以把HTTP中间件看做“装饰器”, 在请求达到最终动作之前对请求进行过滤和处理。

Laravel的请求在进入逻辑处理之前会通过HTTP中间件进行处理,也就是说HTPT请求的逻辑是

  1. 创建中间件
  2. 注册中间件
  3. 使用中间件

创建中间件

# 在 app/Http/Middleware 目录下生成中间件
$ php artisan make:middleware MiddlewareName

# eg
$ php artisan make:middleware BuildMenu

app/Http/Middleware/BuildMenu

<?php

namespace App\Http\Middleware;

use Closure;

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

中间件在HTTP请求阶段会调用自己的handle()处理器方法,同时中间件也可在响应阶段使用,不过此时会调用自己的terminate()方法。

  1. 中间件处理请求
handle($request, $next)
@param mixed request 请求参数,包含输入、URL、文件上传等信息。
@param mixed next 闭包函数,处理请求的业务逻辑
@return mixed 
  1. 中间件处理响应
terminate($request, $response)

注册中间件

中间件可针对route路由,也可针对所有HTTP请求。

  1. 针对所有HTTP请求的中间件

若中间在每个HTTP请求期间都被执行,仅需将中间件类设置到 app/Http/Kernal.php$middleware数组属性中。

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
    \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
    \App\Http\Middleware\TrimStrings::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    \App\Http\Middleware\TrustProxies::class,
];
  1. 针对特定route路由的中间件

对于针对特定路由的中间件,app/Http/Kernel.php类中$routeMiddleware属性包含了Laravel内置的入口中间件,在其中追加并设置别名即可。

protected $routeMiddleware = [
    'auth' => \Illuminate\Auth\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'menu'=>\App\Http\Middleware\BuildMenu::class
];
'menu'=>\App\Http\Middleware\BuildMenu::class

使用中间件

注册完毕中间件后要开始绑定中间件到路由,绑定路由有两种方式。

  1. 通过数组分配
Route::get('/', ['middleware'=>['auth', 'menu']], function(){

});
Route::group(['namespace'=>'Admin','prefix'=>'admin','middleware'=>['web','menu']],function($router){
    $router->any('/login', 'LoginController@login')->name('agent.login');
    $router->any('/logout', 'LoginController@logout');
    $router->any('/', 'IndexController@index');
});
  1. 通过方法连来分配

Route::get('/', function(){

})->middleware(['auth', 'menu']);

也可以在控制器的构造器中调用中间件

public function __construct()
{
  $this->middleware('menu');
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,600评论 18 139
  • 中间件 简介 HTTP 中间件为你的应用提供了一种便利的机制去过滤客户端的请求,比如说laravel中自带的用来验...
    Dearmadman阅读 1,897评论 3 2
  • 0.1配置1.模板继承2.控制器3.git4.支付宝支付的流程5.路由6.中间件7.请求8.laravel 学习笔...
    云龙789阅读 803评论 0 5
  • 什么是中间键 对于一个Web应用来说,在一个请求真正处理前,我们可能会对请求做各种各样的判断,然后才可以让它继续传...
    伊Summer阅读 1,662评论 0 3
  • 那你是为了什么 可能并不为什么
    有座喵喵宅阅读 167评论 0 0