Laravel Session保存机制和terminate中间件

作者:袖梨 2022-06-25

在 Laravel 中可以使用 Session 的 get, put, pull, set, has, flash 等方法进行操作,如:Session::put([‘domain’=>’tanteng.me’, ‘host’=>’aliyun’]),就可以设置两个 session 值,看看 put 方法:

代码位于vendor/laravel/framework/src/Illuminate/Session/Store.phpPHP

/**
 * Put a key / value pair or array of key / value pairs in the session.
 *
 * @param  string|array  $key
 * @param  mixed       $value
 * @return void
 */
public function put($key, $value = null)
{
    if (! is_array($key)) {
        $key = [$key => $value];
    }

    foreach ($key as $arrayKey => $arrayValue) {
        $this->set($arrayKey, $arrayValue);
    }
}

代码位于 vendor/laravel/framework/src/Illuminate/Session/Store.php

它实际上通过 set 方法设置 session 值,set 方法:

/**
 * {@inheritdoc}
 */
public function set($name, $value)
{
    Arr::set($this->attributes, $name, $value);
}
可见 set 方法仅仅是将值保存在 Store 这个类的属性 attributes 中,也就是你多个保存 session 的操作都是将值保存在一个地方,此时并没有真正设置,而是最后一次保存,保存 session 的方法是 Store 类的 save 方法。

其中 save 方法:

/**
 * {@inheritdoc}
 */
public function save()
{
    $this->addBagDataToSession();
 
    $this->ageFlashData();
 
    $this->handler->write($this->getId(), $this->prepareForStorage(serialize($this->attributes)));
 
    $this->started = false;
}
那么在何处何时调用 save 方法设置 session 值呢?

Laravel 中间件 StartSession

这里就用到了 terminate 中间件,StartSession 这个中间件有个 terminate 方法,如下:

/**
 * Perform any final actions for the request lifecycle.
 *
 * @param  IlluminateHttpRequest  $request
 * @param  SymfonyComponentHttpFoundationResponse  $response
 * @return void
 */
public function terminate($request, $response)
{
    if ($this->sessionHandled && $this->sessionConfigured() && ! $this->usingCookieSessions()) {
        $this->manager->driver()->save();
    }
}
这里只讲讲 StartSession 的 terminate 方法,其中 $this->manager->driver()->save() 这句即是调用前文讲的 save 方法保存设置 session 值。

什么是 Terminable 中间件

这里引用其他地方的一句话:

有时候中间件需要在 HTTP 的响应已经发送到浏览器之后去做点事。比如在 Laravel 里包含的 session 这个中间件,它会在响应发送到浏览器之后,把 session 数据写入到存储里面。要实现这个功能,你可以把中间件定义成 terminable 。
原来是在响应之后再做的事情,保存 session 的步骤是一次性在最后进行,这就是 Laravel Session 保存的机制,以及 terminate 中间件的用法。

Laravel 的 Session 提供多个存储方式,file,memcache,redis,database 等等,可以通过配置文件设置。

相关文章

精彩推荐