Session

Testing Is Documentation

tests/Session/SessionTest.phpSession - 图1

QueryPHP 提供了 Session (会话) 可以用于保存用户登录状态。

内置支持的 session 驱动类型包括 file、redis，未来可能增加其他驱动。

使用方式

使用容器 sessions 服务

  1. \App::make('sessions')->set(string $name, $value): void;
  2. \App::make('sessions')->get(string $name, $defaults = null);

依赖注入

  1. class Demo
  2. {
  3.     private \Leevel\Session\Manager $session;
  5.     public function __construct(\Leevel\Session\Manager $session)
  6.     {
  7.         $this->session = $session;
  8.     }
  9. }

使用静态代理

  1. \Leevel\Session\Proxy\Session::set(string $name, $value): void;
  2. \Leevel\Session\Proxy\Session::get(string $name, $value = null);

session 配置

系统的 session 配置位于应用下面的 option/session.php 文件。

可以定义多个缓存连接，并且支持切换，每一个连接支持驱动设置。

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the your app package.
  7.  *
  8.  * The PHP Application For Code Poem For You.
  9.  * (c) 2018-2099 http://yourdomian.com All rights reserved.
  10.  *
  11.  * For the full copyright and license information, please view the LICENSE
  12.  * file that was distributed with this source code.
  13.  */
  15. return [
  16.     /*
  17.      * ---------------------------------------------------------------
  18.      * session 驱动
  19.      * ---------------------------------------------------------------
  20.      *
  21.      * 采用什么源保存 session 数据，默认采用文件
  22.      */
  23.     'default' => Leevel::env('SESSION_DRIVER', 'file'),
  25.     /*
  26.      * ---------------------------------------------------------------
  27.      * id
  28.      * ---------------------------------------------------------------
  29.      *
  30.      * 相当于 session_id
  31.      * null 表示自动生成随机字符串
  32.      */
  33.     'id' => null,
  35.     /*
  36.      * ---------------------------------------------------------------
  37.      * name
  38.      * ---------------------------------------------------------------
  39.      *
  40.      * 相当于 session_name
  41.      */
  42.     'name' => 'UID',
  44.     /*
  45.      * ---------------------------------------------------------------
  46.      * COOKIE 过期时间
  47.      * ---------------------------------------------------------------
  48.      *
  49.      * SESSION 依赖 COOKIE
  50.      * COOKIE 默认过期时间
  51.      * 小于等于 0 表示关闭浏览器即失效
  52.      */
  53.     'cookie_expire' => 86400,
  55.     /*
  56.      * ---------------------------------------------------------------
  57.      * session 驱动连接参数
  58.      * ---------------------------------------------------------------
  59.      *
  60.      * 这里为所有的 session 驱动的连接参数，每一种不同的驱动拥有不同的配置
  61.      * 虽然有不同的驱动，但是在使用上却有着一致性
  62.      */
  63.     'connect' => [
  64.         'file' => [
  65.             // driver
  66.             'driver' => 'file',
  68.             // 文件缓存驱动
  69.             'file_driver' => Leevel::env('SESSION_FILE_DRIVER', 'file_session'),
  70.         ],
  72.         'redis' => [
  73.             // driver
  74.             'driver' => 'redis',
  76.             // Redis 缓存驱动
  77.             'redis_driver' => Leevel::env('SESSION_REDIS_DRIVER', 'redis_session'),
  78.         ],
  80.         'test' => [
  81.             // driver
  82.             'driver' => 'test',
  83.         ],
  84.     ],
  85. ];

session 参数根据不同的连接会有所区别，通用的 sesion 参数如下：

配置项配置描述
id相当于 session_id
name相当于 session_name
cookie_expireCOOKIE 过期时间

注意

QueryPHP 并没有使用 PHP 原生 SESSION，而是模拟原生 SESSION 自己实现的一套，使用方法与原生用法几乎一致。与原生 SESSION 不一样的是，QueryPHP 会在最后通过 session 中间件统一写入。

Uses

  1. <?php
  3. use Leevel\Cache\File as CacheFile;
  4. use Leevel\Filesystem\Helper;
  5. use Leevel\Session\File;
  6. use Leevel\Session\ISession;

session 基本使用

session 的使用方法和原生差不多。

设置 session

  1. set(string $name, $value): void;

是否存在 session

  1. has(string $name): bool;

删除 session

  1. delete(string $name): void;
  1. public function testBaseUse(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $this->assertInstanceof(ISession::class, $session);
  6.     $this->assertFalse($session->isStart());
  7.     $this->assertSame('', $session->getId());
  8.     $this->assertSame('UID', $session->getName());
  10.     $session->start();
  11.     $this->assertTrue($session->isStart());
  13.     $session->set('hello', 'world');
  14.     $this->assertSame(['hello' => 'world'], $session->all());
  15.     $this->assertTrue($session->has('hello'));
  16.     $this->assertSame('world', $session->get('hello'));
  18.     $session->delete('hello');
  19.     $this->assertSame([], $session->all());
  20.     $this->assertFalse($session->has('hello'));
  21.     $this->assertNull($session->get('hello'));
  23.     $session->start();
  24.     $this->assertTrue($session->isStart());
  25.     $this->assertTrue($session->open('foo', 'bar'));
  26.     $this->assertTrue($session->close());
  27.     $this->assertTrue($session->destroy('foo'));
  28.     $this->assertSame(0, $session->gc(500));
  29. }

setExpire 设置过期时间

过期时间规则如下：

  • null 表示默认 session 缓存时间
  • 小与等于 0 表示永久缓存
  • 其它表示缓存多少时间，单位秒
  1. public function testSetExpire(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->setExpire(50);
  6.     $session->set('hello', 'world');
  7.     $this->assertSame(['hello' => 'world'], $session->all());
  9.     $session->start();
  10.     $session->save();
  12.     $sessionId = $session->getId();
  13.     $dirPath = __DIR__.'/cache';
  14.     $filePath = $dirPath.'/'.$sessionId.'.php';
  15.     $this->assertFileExists($filePath);
  16.     $this->assertStringContainsString('[50,', file_get_contents($filePath));
  17. }

put 批量插入

  1. public function testPut(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->put('hello', 'world');
  6.     $this->assertSame(['hello' => 'world'], $session->all());
  8.     $session->put(['foo' => 'bar']);
  9.     $this->assertSame(['hello' => 'world', 'foo' => 'bar'], $session->all());
  11.     $session->put(['foo' => 'bar']);
  12.     $this->assertSame(['hello' => 'world', 'foo' => 'bar'], $session->all());
  13. }

clear 清空 session

  1. public function testClear(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->set('hello', ['sub' => 'me', 'foo' => 'bar', 'hello' => 'world']);
  6.     $this->assertSame(['hello' => ['sub' => 'me', 'foo' => 'bar', 'hello' => 'world']], $session->all());
  8.     $session->clear();
  9.     $this->assertSame([], $session->all());
  10. }

flash 闪存一个数据，当前请求和下一个请求可用

  1. public function testFlash(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->flash('hello', 'world');
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.new.key": [
  11.                 "hello"
  12.             ],
  13.             "flash.old.key": []
  14.         }
  15.         eot;
  17.     $this->assertSame(
  18.         $flash,
  19.         $this->varJson(
  20.             $session->all()
  21.         )
  22.     );
  24.     $session->flash('foo', ['bar']);
  26.     $flash = <<<'eot'
  27.         {
  28.             "flash.data.hello": "world",
  29.             "flash.new.key": [
  30.                 "hello",
  31.                 "foo"
  32.             ],
  33.             "flash.old.key": [],
  34.             "flash.data.foo": [
  35.                 "bar"
  36.             ]
  37.         }
  38.         eot;
  40.     $this->assertSame(
  41.         $flash,
  42.         $this->varJson(
  43.             $session->all()
  44.         )
  45.     );
  46. }

flashs 批量闪存数据，当前请求和下一个请求可用

  1. public function testFlashs(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->flashs(['hello' => 'world', 'foo' => 'bar']);
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.new.key": [
  11.                 "hello",
  12.                 "foo"
  13.             ],
  14.             "flash.old.key": [],
  15.             "flash.data.foo": "bar"
  16.         }
  17.         eot;
  19.     $this->assertSame(
  20.         $flash,
  21.         $this->varJson(
  22.             $session->all()
  23.         )
  24.     );
  25. }

nowFlash 闪存一个 flash 用于当前请求使用,下一个请求将无法获取

  1. public function testNowFlash(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->nowFlash('hello', 'world');
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.old.key": [
  11.                 "hello"
  12.             ]
  13.         }
  14.         eot;
  16.     $this->assertSame(
  17.         $flash,
  18.         $this->varJson(
  19.             $session->all()
  20.         )
  21.     );
  22. }

nowFlashs 批量闪存数据,用于当前请求使用，下一个请求将无法获取

  1. public function testNowFlashs(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->nowFlashs(['hello' => 'world', 'foo' => 'bar']);
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.old.key": [
  11.                 "hello",
  12.                 "foo"
  13.             ],
  14.             "flash.data.foo": "bar"
  15.         }
  16.         eot;
  18.     $this->assertSame(
  19.         $flash,
  20.         $this->varJson(
  21.             $session->all()
  22.         )
  23.     );
  24. }

rebuildFlash 保持所有闪存数据

  1. public function testRebuildFlash(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->nowFlashs(['hello' => 'world', 'foo' => 'bar']);
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.old.key": [
  11.                 "hello",
  12.                 "foo"
  13.             ],
  14.             "flash.data.foo": "bar"
  15.         }
  16.         eot;
  18.     $this->assertSame(
  19.         $flash,
  20.         $this->varJson(
  21.             $session->all()
  22.         )
  23.     );
  25.     $session->rebuildFlash();
  27.     $flash = <<<'eot'
  28.         {
  29.             "flash.data.hello": "world",
  30.             "flash.old.key": [],
  31.             "flash.data.foo": "bar",
  32.             "flash.new.key": [
  33.                 "hello",
  34.                 "foo"
  35.             ]
  36.         }
  37.         eot;
  39.     $this->assertSame(
  40.         $flash,
  41.         $this->varJson(
  42.             $session->all()
  43.         )
  44.     );
  45. }

keepFlash 保持闪存数据

  1. public function testKeepFlash(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->nowFlashs(['hello' => 'world', 'foo' => 'bar']);
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.old.key": [
  11.                 "hello",
  12.                 "foo"
  13.             ],
  14.             "flash.data.foo": "bar"
  15.         }
  16.         eot;
  18.     $this->assertSame(
  19.         $flash,
  20.         $this->varJson(
  21.             $session->all()
  22.         )
  23.     );
  25.     $session->keepFlash(['hello', 'foo']);
  27.     $flash = <<<'eot'
  28.         {
  29.             "flash.data.hello": "world",
  30.             "flash.old.key": [],
  31.             "flash.data.foo": "bar",
  32.             "flash.new.key": [
  33.                 "hello",
  34.                 "foo"
  35.             ]
  36.         }
  37.         eot;
  39.     $this->assertSame(
  40.         $flash,
  41.         $this->varJson(
  42.             $session->all()
  43.         )
  44.     );
  45. }

getFlash 返回闪存数据

  1. public function testGetFlash(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->nowFlashs(['hello' => 'world', 'foo' => 'bar']);
  7.     $this->assertSame('world', $session->getFlash('hello'));
  8.     $this->assertSame('bar', $session->getFlash('foo'));
  10.     $session->flash('test', ['foo', 'bar']);
  11.     $this->assertSame(['foo', 'bar'], $session->getFlash('test'));
  12.     $this->assertNull($session->getFlash('notFound'));
  14.     $session->flash('bar', ['sub' => ['foo' => 'bar']]);
  15.     $this->assertSame(['foo', 'bar'], $session->getFlash('test'));
  16.     $this->assertNull($session->getFlash('test\\notFound'));
  17. }

clearFlash 清理所有闪存数据

  1. public function testClearFlash(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $session->flashs(['hello' => 'world', 'foo' => 'bar']);
  7.     $flash = <<<'eot'
  8.         {
  9.             "flash.data.hello": "world",
  10.             "flash.new.key": [
  11.                 "hello",
  12.                 "foo"
  13.             ],
  14.             "flash.old.key": [],
  15.             "flash.data.foo": "bar"
  16.         }
  17.         eot;
  19.     $this->assertSame(
  20.         $flash,
  21.         $this->varJson(
  22.             $session->all()
  23.         )
  24.     );
  26.     $session->clearFlash();
  28.     $flash = <<<'eot'
  29.         {
  30.             "flash.new.key": [],
  31.             "flash.old.key": [
  32.                 "hello",
  33.                 "foo"
  34.             ]
  35.         }
  36.         eot;
  38.     $this->assertSame(
  39.         $flash,
  40.         $this->varJson(
  41.             $session->all()
  42.         )
  43.     );
  44. }

setPrevUrl.prevUrl 设置和返回前一个请求地址

  1. public function testPrevUrl(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  4.     $this->assertNull($session->prevUrl());
  5.     $session->setPrevUrl('foo');
  6.     $this->assertSame('foo', $session->prevUrl());
  7. }

destroySession 终止会话

  1. public function testDestroy(): void
  2. {
  3.     $session = $this->createFileSessionHandler();
  5.     $this->assertFalse($session->isStart());
  6.     $this->assertSame('', $session->getId());
  7.     $this->assertSame('UID', $session->getName());
  9.     $session->start();
  10.     $this->assertTrue($session->isStart());
  11.     $this->assertNotNull($session->getId());
  12.     $this->assertNotNull($session->getName());
  14.     $session->destroySession();
  15.     $this->assertFalse($session->isStart());
  16.     $this->assertSame('', $session->getId());
  17.     $this->assertSame('UID', $session->getName());
  18. }