资讯专栏INFORMATION COLUMN

Laravel学习笔记之Session源码解析(下)

Awbeci / 1908人阅读

摘要:实际上,在中关闭主要包括两个过程保存当前到介质中在中存入。,学习下关闭的源码吧先。总之,关闭的第二件事就是给添加。通过对的源码分析可看出共分为三大步启动操作关闭。总结本小系列主要学习了的源码,学习了的三大步。

说明:在中篇中学习了session的CRUD增删改查操作,本篇主要学习关闭session的相关源码。实际上,在Laravel5.3中关闭session主要包括两个过程:保存当前URL到session介质中;在Response Header中存入cookie。其中,Laravel5.3把垃圾回收提前到了中间件的前置操作,中篇有聊到。OK,学习下关闭session的源码吧先。

开发环境:Laravel5.3 + PHP7

关闭Session

首先看下IlluminateSessionMiddlewareStartSession::class中间件源码的handle()方法:

    public function handle($request, Closure $next)
    {
        ...
    
        $response = $next($request);

        // 检查config/session.php中"driver"是否设置,这里已经假设是redis作为存储介质
        if ($this->sessionConfigured()) {
            // 存储当前URL
            $this->storeCurrentUrl($request, $session);
            // 往Response Header中添加cookie
            $this->addCookieToResponse($response, $session);
        }

        return $response;
    }
    
    protected function sessionConfigured()
    {
        return ! is_null(Arr::get($this->manager->getSessionConfig(), "driver"));
    }

从源码中可知关闭session做了两件事:存储当前URL;往Response Header中添加cookie。

OK,先看第一件事:

    // IlluminateSessionMiddlewareStartSession
    protected function storeCurrentUrl(Request $request, $session)
    {
        // 如果是GET,并且不是ajax,且route对象不能为空
        if ($request->method() === "GET" && $request->route() && ! $request->ajax()) {
            $session->setPreviousUrl($request->fullUrl());
        }
    }
    
    public function setPreviousUrl($url)
    {
        // 使用中篇聊到的put()方法更新式存储$url,
        // 如sentry.app:8888/session,存入到redis中的"laravel:_previous.url"
        $this->put("_previous.url", $url);
    }

所以第一件事很简单,OK,看下第二件事:

    protected function addCookieToResponse(Response $response, SessionInterface $session)
    {
        // No, we use redis as a session handler.
        if ($this->usingCookieSessions()) {
            $this->manager->driver()->save();
        }

        // Yes, use redis as the persistent store bucket.
        if ($this->sessionIsPersistent($config = $this->manager->getSessionConfig())) {
            $response->headers->setCookie(new Cookie(
                // "laravel_session"
                $session->getName(),
                // Str::random(40)
                $session->getId(),
                // If it is not set to expire when the browser close. And after 60 minutes, the session will close.
                $this->getCookieExpirationDate(),
                // "/session"
                $config["path"],
                // "session_domain"
                $config["domain"],
                // true
                Arr::get($config, "secure", false),
                // true
                Arr::get($config, "http_only", true)
            ));
        }
    }
    
    // 检查是不是cookie存储作为handler,这里是使用redis作为handler
    protected function usingCookieSessions()
    {
        if (! $this->sessionConfigured()) {
            return false;
        }

        return $this->manager->driver()->getHandler() instanceof CookieSessionHandler;
    }
    
    // 检查是不是永久存储,array不是永久存储,这里使用redis是永久存储
    protected function sessionIsPersistent(array $config = null)
    {
        $config = $config ?: $this->manager->getSessionConfig();

        return ! in_array($config["driver"], [null, "array"]);
    }

第二件事也很简单,实例化SymfonyComponentHttpFoundationCookie,并存入到response header中。其中,实例化Cookie所需要的各个参数值为:

(1) $session->getName()

// $session就是IlluminateSessionStore对象

// 在实例化Store对象时,传入的name值是读取的app["config"]["session.cookie"]
// 见 IlluminateSessionSessionManager::buildSession() line 178
"laravel_session" = $session->getName(); 


(2) $session->getId()

// 在实例化Store时,传入的$id=null,则在Store构造函数中使用setId()设置$id值
//看下Store::setId()源码就知道id是随机生成的长度为40的字符串
Str::random(40) = $session->getId();

    public function setId($id)
    {
        if (! $this->isValidId($id)) {
            $id = $this->generateSessionId();
        }

        $this->id = $id;
    }
    public function isValidId($id)
    {
        return is_string($id) && ctype_alnum($id) && strlen($id) === 40;
    }
    protected function generateSessionId()
    {
        return Str::random(40);
    }

(3) $this->getCookieExpirationDate()

    // config/session.php中默认expire_on_close = false, lifetime = 60
    // 表示如果浏览器关闭session不过期,则保留60分钟后再过期
    protected function getCookieExpirationDate()
    {
        $config = $this->manager->getSessionConfig();

        return $config["expire_on_close"] ? 0 : Carbon::now()->addMinutes($config["lifetime"]);
    }

(4) $config["path"]

// 默认是"/",这是设置"/session",等会看下响应头
"/session" = $config["path"]

(5) $config["domain"]

// 这里在config/session.php中设置成"session_domain",等会看下响应头
"session_domain" = $config["domain"]

(6) Arr::get($config, "secure", false)

// 就默认值false
false = Arr::get($config, "secure", false)

(7) Arr::get($config, "http_only", true)

// 就默认值true
true = Arr::get($config, "http_only", true)

这里输入路由sentry.app:8888/session(在本地环境配置你的路由)简单输出个字符串"session",主要看下响应头是不是设置了配置的cookie值:

看下响应头设置了"laravel_session" cookie,并且"path","domain"是刚刚在session.php中设置的"/session","session_domain"值。总之,Laravel关闭session的第二件事就是给Response Header添加"laravel_session" cookie。

通过对Laravel Session的源码分析可看出Session共分为三大步:启动Session;操作Session;关闭Session。启动Session包括Store实例化,从存储介质中如redis读取session数据,和垃圾回收;操作Session包括对Session的CRUD增删改查操作;关闭Session包括存储当前的URL和往Response Header添加Cookie。

总结:本小系列主要学习了Laravel Session的源码,学习了Session的三大步。后续有好的技术再分享吧,到时见。

欢迎关注Laravel-China。

RightCapital招聘Laravel DevOps

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/21941.html

相关文章

  • Laravel学习笔记Session源码解析(中)

    摘要:说明在上篇中学习了的启动过程,主要分为两步,一是的实例化,即的实例化二是从存储介质中读取的数据。第二步就是操作,包括对数据的增删改查操作,本文也主要聊下相关操作源码。下篇再学习下关闭,到时见。 说明:在上篇中学习了session的启动过程,主要分为两步,一是session的实例化,即IlluminateSessionStore的实例化;二是从session存储介质redis中读取id ...

    longshengwang 评论0 收藏0
  • Laravel学习笔记Session源码解析(上)

    摘要:然后中间件使用方法来启动获取实例,使用类来管理主要分为两步获取实例,主要步骤是通过该实例从存储介质中读取该次请求所需要的数据,主要步骤是。 说明:本文主要通过学习Laravel的session源码学习Laravel是如何设计session的,将自己的学习心得分享出来,希望对别人有所帮助。Laravel在web middleware中定义了session中间件IlluminateSess...

    NervosNetwork 评论0 收藏0
  • Laravel学习笔记bootstrap源码解析

    摘要:总结本文主要学习了启动时做的七步准备工作环境检测配置加载日志配置异常处理注册注册启动。 说明:Laravel在把Request通过管道Pipeline送入中间件Middleware和路由Router之前,还做了程序的启动Bootstrap工作,本文主要学习相关源码,看看Laravel启动程序做了哪些具体工作,并将个人的研究心得分享出来,希望对别人有所帮助。Laravel在入口index...

    xiaoxiaozi 评论0 收藏0
  • Laravel学习笔记IoC Container实例化源码解析

    摘要:说明本文主要学习容器的实例化过程,主要包括等四个过程。看下的源码如果是数组,抽取别名并且注册到中,上文已经讨论实际上就是的。 说明:本文主要学习Laravel容器的实例化过程,主要包括Register Base Bindings, Register Base Service Providers , Register Core Container Aliases and Set the ...

    ningwang 评论0 收藏0
  • Laravel学习笔记Container源码解析

    摘要:实际上的绑定主要有三种方式且只是一种的,这些已经在学习笔记之实例化源码解析聊过,其实现方法并不复杂。从以上源码发现的反射是个很好用的技术,这里给出个,看下能干些啥打印结果太长了,就不粘贴了。 说明:本文主要学习Laravel中Container的源码,主要学习Container的绑定和解析过程,和解析过程中的依赖解决。分享自己的研究心得,希望对别人有所帮助。实际上Container的绑...

    huayeluoliuhen 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<