关于扩展 Laravel 默认 Session 中间件导致的 Session 写入失效问题分析

最近由于项目开发需要，手机客户端和网页端统一使用一套接口，为保证 会话（Session） 能够正常且在各类情况下兼容，我希望能够改变 SessionID 的获取方式。默认情况下，所有网站都是通过 HTTP 请求的 Header 头部中的 Cookie 实现的，通过 Cookie 中指定的 SessionID 来关联到服务端对应数据，从而实现会话功能。

但对于手机客户端，可能并不会支持原始的 Cookie，亦或者根据平台需要而屏蔽，因此开发中要求通过增加一个请求头 X-Session-Token 来标识 SessionID。在 Laravel 框架中，实现 Session 初始化、读取和启动，都是通过 Illuminate\Session\Middleware\StartSession 这个中间件实现的，该中间件有一个关键方法 getSession ，这个方法就是获取 SessionId 从而告知 Session 组件以什么凭据恢复 Session 数据。

该中间件注册于 app/Http/Kernel.php 文件下。

我新建了一个类继承该中间件，同时替换了在 app/Http/Kernel.php 下的注册的地方，原来的 getSession 方法源码如下：

public function getSession(Request $request)
{
$session = $this->manager->driver();
$session->setId($request->cookies->get($session->getName()));
return $session;
}

在新的中间件中，我修改为：

public function getSession(Request $request)
{
$session = $this->manager->driver();
// 判断是否是接口访问并根据实际情况选择 SessionID 的获取方式
if ($request->headers->has('x-session-token')) {
$sessionId = $request->headers->has('x-session-token');
} else {
$sessionId = $request->cookies->get($session->getName());
}
$session->setId($sessionId);
return $session;
}

但是麻烦也随之而来。。。

修改完后，推送至分支，在合并至主开发分支之前往往需要跑一下单元测试，不幸的是，之前通过的 Case 这回竟然报错，问题是 CSRF 组件 报出 Token 错误，而我们在这一处提供的 Token 跟平时并无二致，问题肯定出在 Session 上。

值得注意的是，我修改中间件的代码，对框架的影响可以说根本没有，事实上也确实没有，因为我将我自己创建的中间件代码修改成继承的中间件代码一致也无济于事，但奇怪的是，在我将中间件换回原来的中间件就没有这个问题。

于是我将正常情况下和非正常情况下的代码都跑了一遍，在关键处断点调试，发现问题出在中间件的一个重要属性 $sessionHandled ， 若该值为 false 则会引起我们之前的状况。关键在于，中间件启动之时，都会走 handle 方法，而对于 Session 这个中间件， handle 方法的第一行代码就是：

$this->sessionHandled = true;

Interesting。。。

我们知道。Laravel 框架的特色是其 IoC 容器，框架中初始化各种类都是由其负责以实现各种依赖注入，以保证组件间的松耦合。中间件定然不例外。要知道，单例和普通实例最大的区别在于无论创建多少次，单例永远都是一个，实例中的属性不会被初始化，因此无问题的中间件必然是一个单例，而我自己创建的中间件只是个普通的类的实例。但本着知其然更要知其所以然，我需要确认我这一想法（其实解决办法已经想到了，后面说）。

那么问题大致就在于初始化中间件这块了，于是不得不打起精神，仔细理一下 Laravel 的启动代码。而这里面的重点，在于一个叫 Illuminate\Pipeline\Pipeline 的类。

这个类有三个重要方法 send 、 through 、 then 。其中 then 是开始一切的钥匙。这个类主要是连续执行几个框架启动步骤的玩意儿，首先是初始化处理过程需要的组件（Request 和 中间件），其次是将请求通过这些处理组件构成的堆栈（一堆中间件和路由派发组件），最后是返回处理结果（Response）。

可以说这玩意儿是 Laravel Http 部分的核心（额，，本来就是 Kernel）。那么之前的问题就在于 Pipeline 的 then 方法和其调用的 getSlice 方法，直接观察 getSlice 方法，可以发现它负责的是生成处理堆栈，并实例化 Middleware （中间件）类，整个方法代码如下：

protected function getSlice()
{
return function ($stack, $pipe) {
return function ($passable) use ($stack, $pipe) {
if ($pipe instanceof Closure) {
return call_user_func($pipe, $passable, $stack);
} else {
list($name, $parameters) = $this->parsePipeString($pipe);
return call_user_func_array([$this->container->make($name), $this->method],
array_merge([$passable, $stack], $parameters));
}
};
};
}

可以注意到 $this->container->make($name) ，这意味着其初始化一个中间件类，单纯的就是 make，若其不是单例则反复 new ，导致之前的属性被初始化。

那么解决办法也显而易见面，使其成为一个单例。

我在 app/Providers/AppServiceProvider.php 的 register 方法中添加如下一行代码，就解决了之前的问题：

$this->app->singleton(SessionStart::class); // SessionStart 是我那个中间件类名

以上给大家介绍了扩展 Laravel 默认 Session 中间件导致的 Session 写入失效问题分析的全部内容，希望大家喜欢。

赞 (0)

相关推荐

  • Laravel框架中扩展函数、扩展自定义类的方法

    一.扩展自己的类 在app/ 下建立目录 libraries\class 然后myTest.php 类名格式 驼峰 myTest 复制代码 代码如下: <?php class myTest { public  function test() { return '1asdasd111'; } } 在 app/start/global.php 复制代码 代码如下: ClassLoader::addDirectories(array( app_path().'/commands', app_path(

  • PHP开发框架Laravel数据库操作方法总结

    一.读/写连接 有时您可能希望使用一个SELECT语句的数据库连接,,另一个用于插入.更新和删除语句.Laravel使这微风,将始终使用正确的连接是否使用原始查询,查询生成器或雄辩的ORM. 如何读/写连接应该配置,让我们看看这个例子: 复制代码 代码如下: 'mysql' => array('read' => array('host' => '192.168.1.1'),'write' => array('host' => '196.168.1.2'),'driver' =

  • Laravel的throttle中间件失效问题解决方法

    本文实例讲述了Laravel的throttle中间件失效问题解决方法.分享给大家供大家参考,具体如下: 按官方解释,实现访问频率限制非常简单: Route::get('test', function(){ return 'helle world' ; })->middleware('throttle'); 也确实如此,cache存储访问次数,做出判断. 之前使用了zizaco/entrust(一个基于角色的权限管理包),其中把 .env 中的CACHE_DRIVER=file 改为了 CACHE

  • Laravel重写用户登录简单示例

    本文实例讲述了Laravel重写用户登录的方法.分享给大家供大家参考,具体如下: class AuthController extends Controller { // use ThrottlesLogins, AuthenticatesAndRegistersUsers; protected $redirectTo = 'admin/index'; protected $loginView = 'admin/login'; protected $guard = 'admin'; protec

  • Laravel5.1自定义500错误页面示例

    本文实例讲述了Laravel5.1自定义500错误页面的方法.分享给大家供大家参考,具体如下: Laravel 5.1中500错误是程序错误,程序错误一定是系统自带的500错误,可以通过以下步骤简单实现自定义500错误页面. 编辑PHP文件app/Exceptions/Handler.php内容如下: public function render($request, Exception $e) { if ($e instanceof ModelNotFoundException) { $e =

  • Laravel模板引擎Blade中section的一些标签的区别介绍

    Laravel 框架中的 Blade 模板引擎,很好用,但是在官方文档中有关 Blade 的介绍并不详细,有些东西没有写出来,而有些则是没有说清楚.比如,使用中可能会遇到这样的问题: 1.@yield 和 @section 都可以预定义可替代的区块,这两者有什么区别呢? 2.@section 可以用 @show, @stop, @overwrite 以及 @append 来结束,这三者又有什么区别呢? 本文试对这些问题做一个比较浅显但是直观的介绍. @yield 与 @section 首先,@y

  • Laravel框架数据库CURD操作、连贯操作总结

    一.Selects 检索表中的所有行 复制代码 代码如下: $users = DB::table('users')->get(); foreach ($users as $user) { var_dump($user->name); } 从表检索单个行 复制代码 代码如下: $user = DB::table('users')->where('name', 'John')->first(); var_dump($user->name); 检索单个列的行 复制代码 代码如下:

  • Laravel日志用法详解

    本文实例讲述了Laravel日志用法.分享给大家供大家参考,具体如下: 这里使用的Laravel版本仍是5.2 日志是非常重要的.本地开发可以开启调试模式,但是上线的项目查看日志是非常简洁有效的调试手段.Laravel集成了Monolog日志库以便提供多种功能强大的日志处理器. Laravel支持日志方法single, daily, syslog 和 errorlog.例如,如果你想要日志文件按日生成而不是生成单个文件,应该在配置文件config/app.php中设置log值如下: 'log'

  • Laravel中间件实现原理详解

    Laravel中间件实现原理详解

    本文实例讲述了Laravel的中间件实现原理.分享给大家供大家参考,具体如下: #1 什么是中间件? 对于一个Web应用来说,在一个请求真正处理前,我们可能会对请求做各种各样的判断,然后才可以让它继续传递到更深层次中.而如果我们用if else这样子来,一旦需要判断的条件越来越来,会使得代码更加难以维护,系统间的耦合会增加,而中间件就可以解决这个问题.我们可以把这些判断独立出来做成中间件,可以很方便的过滤请求. #2 Laravel中的中间件 在Laravel中,中间件的实现其实是依赖于Illu

  • Laravel实现用户注册和登录

    Laravel实现用户注册和登录

    Laravel身为最优雅的PHP框架,很多学习PHP的小伙伴造就对Laravel垂涎欲滴.今天就来实现你的愿望,让我们一起从零开始,利用Laravel实现Web应用最常见的注册和登录功能!所有的课程源码已放在Github上:laravel-start. Race Start ! 首先我们来明确一下我们这个课程需要的东西: Laravel 4.2 Bootstrap 3.3 Laravel就是我们关心的核心部分,Bootstrap用来快速设置一些前端的CSS样式. 1.安装Laravel 简单说明

  • Laravel 5.1 on SAE环境开发教程【附项目demo源码】

    本文实例讲述了Laravel 5.1 on SAE环境开发方法.分享给大家供大家参考,具体如下: Laravel-简洁.优雅的PHP开发框架,为 WEB 艺术家创造的 PHP 框架,如今正式移植到SAE环境. 由于Laravel 5.1相比于Laravel 4有很多的改动,不仅以目录结构更加清晰,而且功能也更丰富.但是Laravel官方还是没有原生支持SAE环境(估计永远不会支持),所以我就做了一个移植版本,可以很优雅的切换本地和SAE环境. 由于SAE的特殊性,那么这几个核心问题就必须要解决

  • Laravel中使用自己编写类库的3种方法

    虽然Composer使得我们可以重用很多现有的类库(例如packagist.org中的),但是我们仍然可能用到一些不兼容composer的包或者类库.另外在某一项目中,我们也可能会创建某一类库,而且可能并没有制作成为composer package 的打算.这个时候我们可以通过以下方式来使用自己的特有类库. 增加可直接实例化的类 有些需要直接在项目中使用的类,可以通过以下方式增加到Laravel中 1.创建类库文件app/libraries/class/myClass.php 2.写入文件内容

  • Laravel框架路由配置总结、设置技巧大全

    基本路由 您的应用程序的绝大多数路由将在 app/routes.php 文件中定义.Laravel 中最简单的路由由一个 URI 和一个闭包调用组成. 基本 GET 路由 复制代码 代码如下: Route::get('/', function() { return 'Hello World'; }); 基本 POST 路由 复制代码 代码如下: Route::post('foo/bar', function() { return 'Hello World'; }); 注册一个路由以响应所有 HT

  • Laravel框架表单验证详解

    基础验证例子 复制代码 代码如下: $validator = Validator::make( array('name' => 'Dayle'), array('name' => 'required|min:5') ); 传递给 make 函数的第一个参数是待验证的数据,第二个参数是对该数据需要应用的验证规则. 多个验证规则可以通过 "|" 字符进行隔开,或者作为数组的一个单独的元素. 通过数组指定验证规则 复制代码 代码如下: $validator = Validator

随机推荐