ThinkPHP5的Session与Cookie

Published on 2016 - 12 - 21

Session

概述

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

版本 新增功能
5.0.2 增加flash方法和flush方法

Session初始化

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

'session'                => [
    'prefix'         => 'think',
    'type'           => '',
    'auto_start'     => true,
],

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

Session::set('name','thinkphp');
Session::get('name');

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

'session'                => [
    'prefix'         => 'module',
    'type'           => '',
    'auto_start'     => true,
],

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

Session::init([
    'prefix'         => 'module',
    'type'           => '',
    'auto_start'     => true,
]);

如果你没有使用Session类进行Session操作的话,例如直接操作$_SESSION,必须使用上面的方式手动初始化或者直接调用session_start()方法进行session初始化。

设置参数

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

参数 描述
type session类型
expire session过期时间
prefix session前缀
auto_start 是否自动开启
use_trans_sid 是否使用use_trans_sid
var_session_id 请求session_id变量名
id session_id
name session_name
path session保存路径
domain session cookie_domain
use_cookies 是否使用cookie
cache_limiter session_cache_limiter
cache_expire session_cache_expire

如果做了session驱动扩展,可能有些参数不一定有效。

基础用法

赋值

// 赋值(当前作用域)
Session::set('name','thinkphp');
// 赋值think作用域
Session::set('name','thinkphp','think');

判断是否存在

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

取值

// 取值(当前作用域)
Session::get('name');
// 取值think作用域
Session::get('name','think');

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

删除

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

指定作用域

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

取值并删除

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

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

清空

// 清除session(当前作用域)
Session::clear();
// 清除think作用域
Session::clear('think');

下次请求之前有效(v5.0.2+)

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

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

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

二级数组

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

// 赋值(当前作用域)
Session::set('name.item','thinkphp');
// 判断(当前作用域)是否赋值
Session::has('name.item');
// 取值(当前作用域)
Session::get('name.item');
// 删除(当前作用域)
Session::delete('name.item');

助手函数

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

// 初始化session
session([
    'prefix'     => 'module',
    'type'       => '',
    'auto_start' => true,
]);

// 赋值(当前作用域)
session('name', 'thinkphp');

// 赋值think作用域
session('name', 'thinkphp', 'think');

// 判断(当前作用域)是否赋值
session('?name');

// 取值(当前作用域)
session('name');

// 取值think作用域
session('name', '', 'think');

// 删除(当前作用域)
session('name', null);

// 清除session(当前作用域)
session(null);

// 清除think作用域
session(null, 'think');

Session驱动

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

'session' => [
    'prefix'     => 'module',
    'type'       => 'redis',
    'auto_start' => true,
     // redis主机
    'host'       => '127.0.0.1',
     // redis端口
    'port'       => 6379,
     // 密码
    'password'   => '',
]

表示使用redis作为session类型。

Cookie

概述

ThinkPHP采用think\Cookie类提供Cookie支持。

基本操作

初始化

// cookie初始化
Cookie::init(['prefix'=>'think_','expire'=>3600,'path'=>'/']);
// 指定当前前缀
Cookie::prefix('think_');

支持的参数及默认值如下:

// cookie 名称前缀
'prefix'    => '',
// cookie 保存时间
'expire'    => 0,
// cookie 保存路径
'path'      => '/',
// cookie 有效域名
'domain'    => '',
//  cookie 启用安全传输
'secure'    => false,
// httponly设置
'httponly'  => '',
// 是否使用 setcookie
'setcookie' => true,

设置

// 设置Cookie 有效期为 3600秒
Cookie::set('name','value',3600);
// 设置cookie 前缀为think_
Cookie::set('name','value',['prefix'=>'think_','expire'=>3600]);
// 支持数组
Cookie::set('name',[1,2,3]);

判断

Cookie::has('name');
// 判断指定前缀的cookie值是否存在
Cookie::has('name','think_');

获取

Cookie::get('name');
// 获取指定前缀的cookie值
Cookie::get('name','think_');

删除

//删除cookie

Cookie::delete('name');
// 删除指定前缀的cookie
Cookie::delete('name','think_');

清空

// 清空指定前缀的cookie
Cookie::clear('think_');

助手函数

系统提供了cookie助手函数用于基本的cookie操作,例如:

// 初始化
cookie(['prefix' => 'think_', 'expire' => 3600]);

// 设置
cookie('name', 'value', 3600);

// 获取
echo cookie('name');

// 删除
cookie('name', null);

// 清除
cookie(null, 'think_');

参考文档