扩展 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 是我那个中间件类名
其实也就那么简单。本文??抡饷炊嘀皇窍M?璐巳么蠹伊私飧?嘤幸馑嫉亩??~

再总结一下,其实这是一个典型问题,对于在一个完整的程序生命周期之内,反复使用的类的实例,若需要其保持上下文状态,就必须要注意使其成为单例,而不是反复实例化后的结果。这次的 Session 问题无非是自带中间件是作为一个单例默认被注册,而我自定义的则不是,解决方法也正如问题本质。对于日常开发中出现的问题,很多时候都是由于各种忽略框架本质造成的。

时间: 2024-10-25 05:56:14

扩展 Laravel 默认 Session 中间件导致的 Session 写入失效问题的相关文章

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

最近由于项目开发需要,手机客户端和网页端统一使用一套接口,为保证 会话(Session) 能够正常且在各类情况下兼容,我希望能够改变 SessionID 的获取方式.默认情况下,所有网站都是通过 HTTP 请求的 Header 头部中的 Cookie 实现的,通过 Cookie 中指定的 SessionID 来关联到服务端对应数据,从而实现会话功能. 但对于手机客户端,可能并不会支持原始的 Cookie,亦或者根据平台需要而屏蔽,因此开发中要求通过增加一个请求头 X-Session-Token

R5 DSAPI 用户认证之后,Domino没有建立session,导致进入每一个页面都需要重复认证

问题描述 在R5上,进行DSAPI用户认证之后,认证信息是从其他的cookie得到的,在cAPI中设置,Domino没有建立session,导致进入每一个页面都需要重复认证,代码如下intAuthenticate(FilterContext*context,FilterAuthenticate*authData){char*user;if(!authData||authData->foundInCache){printf("founduserincache~~~~~~~~~~~~~~~~~

Laravel 默认重置密码功能代码重构方法

需要使用laravel搭建一个后台内容管理系统,但是laravel默认的登陆注册不能满足目前的需求,重置密码的话因为是用在后台,并且不需要发送邮件进行重置,所以默认的重置密码肯定是不行的. 1.首先确定重置密码的路由 我们在安装好laravel的时候默认生成的重置密码是在用户未登录的情况下进行的.所以使用原来的控制器是不可行的,并且原有的重置密码,并不需要查看原始密码是否正确,而是通过邮件来进行直接更改密码,所以控制器方法的话,我们也需要重新写个.我们使用 php artisan make:co

php中session与thinkphp中session的一些用法

PHP服务端默认的session存储是文件存放方式,在Windows上PHP默认的Session服务端文件存放在C:/WINDOWS/Temp下,*NIX下默认存放在/tmp下,如果说并发访问很大或者session建立太多,在这两个目录下就会存在大量类似sess_xxxxxx的session文件,同一个目录下文件数过多会导致性能下降,并且可能导致受到攻击最终出现文件系统错误.针对这样的情况,PHP本身体提供了比较好的解决办法. 不少朋友可能都没有注意到php.ini里面Session设置部分中有

抛开Cookie使用SESSION-PHP中SESSION不能跨页传递问题的解决办法

cookie|session|解决|问题 抛开cookie使用sessionPHP中SESSION不能跨页传递问题的解决办法 在PHP中使用过SESSION的朋友可能会碰到这么一个问题,SESSION变量不能跨页传递.这令我苦恼了好些日子,最终通过查资料思考并解决了这个问题.我认为,出现这个问题的原因有以下几点:1.客户端禁用了cookie2.浏览器出现问题,暂时无法存取cookie3.php.ini中的session.use_trans_sid = 0或者编译时没有打开--enable-tra

java中使用Cookie替代Session解决跨域Session失效问题

分布式系统中,各个子域名跨域访问的时候,会出现session失效问题,导致登录失败. 例如:用户在www.111cn.net 上登录成功了.但是切换到他的个性化域名 mb.111cn.net 上的时候session失效. 怎么办? 可以采用session复制方案,比如nfs session共享,membercache session存储,还有使用terracotta也可以. 采取以上方案都可以,但是上述方案会导致开发环境过于复杂,运维环境也过于复杂,而且session跨网络传输响应速度会减慢.

在PHP3中实现SESSION的功能(一、SESSION函数库:session.inc.php3)(转译)

session|函数 <?phpif (!isset($__session_inc__)){$__session_inc__=1;//require("cookie.inc.php3");# ------------------------------------------------------------------- # Session Management v1.0 21.6.1998 # (c) Wild Karl Heinz <kh.wild@wicom.at

库-VB.NEt利用水晶报表的API,给Oracle创建session后不能释放session的问题

问题描述 VB.NEt利用水晶报表的API,给Oracle创建session后不能释放session的问题 vb.net2010调用水晶报表的API,先使用PEOpenEngine,然后PEOpenPrintJob,然后使用PESetNthTableLocation后,会自动给Oracle创建一个 session来连接数据库,调用数据库中的数据以打印报表,接着用PEStartPrintJob打印报表,然后用PEClosePrintJob来关闭报表, 然后PECloseEngine关闭水晶报表引擎

Laravel的throttle中间件失效问题解决方法_php实例

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