概述

ThinkPHP采用think\Session类提供Session功能支持。

版本新增功能
5.0.5增加安全选项参数securehttponly
5.0.2增加flash方法和flush方法

Session初始化

在ThinkPHP5.0中使用\think\Session类进行Session相关操作,Session会在第一次调用Session类的时候按照配置的参数自动初始化,例如,我们在应用配置中添加如下配置:

  1. 'session' => [
  2. 'prefix' => 'think',
  3. 'type' => '',
  4. 'auto_start' => true,
  5. ],

如果我们使用上述的session配置参数的话,无需任何操作就可以直接调用Session类的相关方法,例如:

  1. Session::set('name','thinkphp');
  2. Session::get('name');

如果你应用下面的不同模块需要不同的session参数,那么可以在模块配置文件中重新设置:

  1. 'session' => [
  2. 'prefix' => 'module',
  3. 'type' => '',
  4. 'auto_start' => true,
  5. ],

或者调用init方法进行初始化:

  1. Session::init([
  2. 'prefix' => 'module',
  3. 'type' => '',
  4. 'auto_start' => true,
  5. ]);
如果你没有使用Session类进行Session操作的话,例如直接操作$_SESSION,必须使用上面的方式手动初始化或者直接调用session_start()方法进行session初始化。

设置参数

默认支持的session设置参数包括:

参数描述
typesession类型
expiresession过期时间
prefixsession前缀
auto_start是否自动开启
use_trans_sid是否使用use_trans_sid
var_session_id请求session_id变量名
idsession_id
namesession_name
pathsession保存路径
domainsession cookie_domain
use_cookies是否使用cookie
cache_limitersession_cache_limiter
cache_expiresession_cache_expire
如果做了session驱动扩展,可能有些参数不一定有效。

基础用法

赋值

  1. // 赋值(当前作用域)
  2. Session::set('name','thinkphp');
  3. // 赋值think作用域
  4. Session::set('name','thinkphp','think');

判断是否存在

  1. // 判断(当前作用域)是否赋值
  2. Session::has('name');
  3. // 判断think作用域下面是否赋值
  4. Session::has('name','think');

取值

  1. // 取值(当前作用域)
  2. Session::get('name');
  3. // 取值think作用域
  4. Session::get('name','think');

如果name的值不存在,返回null

删除

  1. // 删除(当前作用域)
  2. Session::delete('name');
  3. // 删除think作用域下面的值
  4. Session::delete('name','think');

指定作用域

  1. // 指定当前作用域
  2. Session::prefix('think');

取值并删除

  1. // 取值并删除
  2. Session::pull('name');

如果name的值不存在,返回Null

清空

  1. // 清除session(当前作用域)
  2. Session::clear();
  3. // 清除think作用域
  4. Session::clear('think');

闪存数据,下次请求之前有效(v5.0.2+

  1. // 设置session 并且在下一次请求之前有效
  2. Session::flash('name','value');

提前清除当前请求有效的数据(v5.0.2+

  1. // 清除当前请求有效的session
  2. Session::flush();

二级数组

支持session的二维数组操作,例如:

  1. // 赋值(当前作用域)
  2. Session::set('name.item','thinkphp');
  3. // 判断(当前作用域)是否赋值
  4. Session::has('name.item');
  5. // 取值(当前作用域)
  6. Session::get('name.item');
  7. // 删除(当前作用域)
  8. Session::delete('name.item');

助手函数

系统也提供了助手函数session完成相同的功能,例如:

  1. // 初始化session
  2. session([
  3. 'prefix' => 'module',
  4. 'type' => '',
  5. 'auto_start' => true,
  6. ]);
  7. // 赋值(当前作用域)
  8. session('name', 'thinkphp');
  9. // 赋值think作用域
  10. session('name', 'thinkphp', 'think');
  11. // 判断(当前作用域)是否赋值
  12. session('?name');
  13. // 取值(当前作用域)
  14. session('name');
  15. // 取值think作用域
  16. session('name', '', 'think');
  17. // 删除(当前作用域)
  18. session('name', null);
  19. // 清除session(当前作用域)
  20. session(null);
  21. // 清除think作用域
  22. session(null, 'think');

Session驱动

支持指定 Session 驱动,配置文件如下:

  1. 'session' => [
  2. 'prefix' => 'module',
  3. 'type' => 'redis',
  4. 'auto_start' => true,
  5. // redis主机
  6. 'host' => '127.0.0.1',
  7. // redis端口
  8. 'port' => 6379,
  9. // 密码
  10. 'password' => '',
  11. ]

表示使用redis作为session类型。