Session會話
不支援操作$_SESSION數組,只能使用Session類別
6.0的Session類別可以很好的支援諸如Swoole/Workerman等環境。
開啟Session
Session功能預設沒有開啟,如果你需要使用Seesion,需要在全域的中間件定義檔中加上下面的中間件定義:
'think\middleware\SessionInit'
如果是多應用模式,並且你只是用於部分應用,那麼也可以在應用中間件定義檔中單獨開啟。
Session初始化
系統會自動依照session.php配置的參數自動初始化Session。
預設支援的session設定參數包括:
參數 | ##描述 |
---|
type | session類型 |
store | #當type設定為cache類型的時候指定儲存標識 |
expire | session過期時間(秒)必須大於0 |
#var_session_id | 要求session_id變數名稱 |
name | session_name |
prefix | session前綴 |
serialize | 序列化方法 |
無需任何操作就可以直接呼叫Session類別的相關方法,例如:
Session::set('name', 'thinkphp');
Session::get('name');
序列化
會話資料保存的時候會自動序列化,並在讀取的時候自動反序列化,你可以自訂序列化機制。
例如在設定檔中設定為使用JSON序列化:
'serialize' => ['json_encode', 'json_decode'],
要盡量避免把物件儲存到Session會話
基礎用法
賦值
Session::set('name', 'thinkphp');
// 支持两级赋值
Session::set('user.name', 'thinkphp');
判斷是否存在
Session::has('name');
Session::has('user.name');
取值
// 如果值不存在,返回null
Session::get('name');
// 如果值不存在,返回空字符串
Session::get('name', '');
// 支持多级
Session::get('user.name');
刪除
Session::delete('name');
取值並刪除
// 取值并删除
Session::pull('name');
如果name的值不存在,則回傳Null。
清空
Session::clear();
閃存數據,下次請求之前有效
// 设置session 并且在下一次请求之前有效
Session::flash('name','value');
提前清除當前請求有效的數據
// 清除当前请求有效的session
Session::flush();
注意,Session寫入資料的操作會在請求結束的時候統一進行本地化存儲,所以不要在寫入Session資料之後使用exit等中斷操作,可能會導致Session沒有正常寫入。
多層次數組
支援session的多層數組操作,例如:
// 赋值(当前作用域)
Session::set('name.item','thinkphp');
// 判断(当前作用域)是否赋值
Session::has('name.item');
// 取值(当前作用域)
Session::get('name.item');
// 删除(当前作用域)
Session::delete('name.item');
其中set和delete方法只能支援二級數組,其他方法支援任意級數組操作。
助手函數
系統也提供了助手函數session完成相同的功能,例如:
// 赋值
session('name', 'thinkphp');
// 判断是否赋值
session('?name');
// 取值
session('name');
// 删除
session('name', null);
// 清除session
session(null);
Request物件中讀取Session
可以在Request物件中讀取Session資料(不支援設定)
public function index(Request $request) {
// 读取某个session数据
$request->session('user.name', '');
// 获取全部session数据
$request->session();
}
但Request類別中不支援Session寫入操作。
應用獨立會話
如果使用預設的是檔案類型的話,多應用的Session保存路徑是相同的,也就是說多重應用之間是共用會話數據的,如果不希望共享會話數據,可以給每個應用程式設定不同的path或不同的前綴prefix。
如果是File類型的話,預設的session會話資料保存在runtime/session目錄下面,你可以設定path來改變儲存路徑。
如果是其它類型驅動的話,可以設定prefix配置參數來區分不同的應用會話資料。
Session驅動器
預設的Session驅動程式採用檔案快取方式記錄,並且支援如下配置
##參數 | 描述 |
path | #session保存路徑 |
data_compress | 是否壓縮資料 |
gc_divisor | GC回收機率 |
gc_probability | #GC回收機率 |
gc_maxlifetime | GC回收最大生命期 |
##除了檔案類型之外,還可以支援其它的Session類型,例如:
return [
'type' => 'redis',
'prefix' => 'think',
'auto_start' => true,
// redis主机
'host' => '127.0.0.1',
// redis端口
'port' => 6379,
// 密码
'password' => '',
]
表示使用redis作為session類型。
要以上的配置生效,請確保快取設定檔cache.php中的stores中已經新增了redis快取配置,例如:
return [
'default' => 'file',
'stores' => [
// 文件缓存
'file' => [
// 驱动方式
'type' => 'file',
// 设置不同的缓存保存目录
'path' => '../runtime/file/',
],
// redis缓存
'redis' => [
// 驱动方式
'type' => 'redis',
// 服务器地址
'host' => '127.0.0.1',
],
],
];
目前內建支援的類型包括redis、memcache和memcached。
自訂驅動器
如果需要自訂Session驅動,你的驅動類別必須實作think\contract\SessionHandlerInterface接口,包含了三個方法。
interface SessionHandlerInterface
{
public function read(string $sessionId): string;
public function delete(string $sessionId): bool;
public function write(string $sessionId, string $data): bool;
}
read方法是在呼叫Session::start()的時候執行,並且只會執行一次。
write方法是在本地化會話資料的時候執行(呼叫Session::save()方法),系統會在每次請求結束的時候自動執行。
delete方法是在銷毀會話的時候執行(呼叫Session::destroy()方法)。