## 概述
可以直接使用`think\facade\Session`類操作`Session`。
> 新版本不支持操作原生`$_SESSION`數組和所有`session_`開頭的函數,只能通過`Session`類(或者助手函數)來操作。會話數據統一在當前請求結束的時候統一寫入 所以不要在`session`寫入操作之后執行`exit`等中斷操作,否則會導致`Session`數據寫入失敗。
`6.0`的`Session`類可以很好的支持諸如`Swoole`/`Workerman`等環境。
## 開啟Session
`Session`功能默認是沒有開啟的(API應用通常不需要使用`Session`),如果你需要使用`Seesion`,需要在全局的中間件定義文件中加上下面的中間件定義`'think\middleware\SessionInit'`:
~~~
return [
// 全局請求緩存
// \think\middleware\CheckRequestCache::class,
// 多語言加載
// \think\middleware\LoadLangPack::class,
// Session初始化
\think\middleware\SessionInit::class,
];
~~~
>[danger] 如果是多應用模式,并且你只是用于部分應用,那么也可以在應用中間件定義文件中單獨開啟。
## Session初始化
系統會自動按照`session.php`配置的參數自動初始化`Session`。
默認支持的`session`設置參數包括:
| 參數 | 描述 |
| --- | --- |
| type | session類型(`File`或者`Cache`) |
| 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');
~~~
會話數據保存(請求結束)的時候會自動序列化,并在讀取的時候自動反序列化,默認使用`serialize`/`unserialize`進行序列化操作,你可以自定義序列化機制。
例如在配置文件中設置為使用`JSON`序列化:
~~~
'serialize' => ['json_encode', 'json_decode'],
~~~
> 盡量避免把對象保存到`Session`會話
## 基礎用法
### 賦值
~~~
Session::set('name', 'thinkphp');
~~~
### 判斷是否存在
~~~
Session::has('name');
~~~
### 取值
~~~
// 如果值不存在,返回null
Session::get('name');
// 如果值不存在,返回空字符串
Session::get('name', '');
// 獲取全部數據
Session::all();
~~~
### 刪除
~~~
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`是跨應用的,也就是說多應用之間是共享會話數據的,如果不希望共享會話數據,可以給每個應用設置不同的前綴`prefix`。
如果是File類型的話,默認的`session`會話數據保存在`runtime/session`目錄下面,你可以設置`path`改變存儲路徑。
## Session驅動
默認的`Session`驅動采用文件緩存方式記錄,并且支持如下配置
| 參數 | 描述 |
| --- | --- |
| path | session保存路徑 |
| data\_compress | 是否壓縮數據 |
| gc\_divisor | GC回收概率 |
| gc\_probability | GC回收概率 |
除了文件類型之外,還可以支持直接使用緩存作為`Session`類型,例如:
~~~
return [
'type' => 'cache',
'store' => 'redis',
'prefix' => 'think',
]
~~~
表示使用`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',
],
],
];
~~~
## 自定義驅動
如果需要自定義`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()`方法)。
- 空白目錄
- php語法結構
- 安裝與更新
- 開啟調試模式及代碼跟蹤器
- 架構
- 源碼分析
- 應用初始化
- 請求流程
- 中間件源碼分析
- 請求處理源碼分析
- Request源碼分析
- 模板編譯流程
- 路由與請求流程
- 容器
- 獲取目錄位置
- 入口文件
- 多應用模式及URL訪問
- 依賴注入與容器
- 容器屬性及方法
- Container
- App
- facade
- 中間件(middleware)
- 系統服務
- extend 擴展類庫
- 筆記
- 配置
- env配置定義及獲取
- 配置文件的配置獲取
- 單應用模式-(配置)文件目錄結構(默認)
- 多應用模式(配置)文件目錄結構(配置文件)
- 配置文件
- 應用配置:app.php
- 緩存配置: cache.php
- 數據庫配置:database.php
- 路由和URL配置:route.php
- Cookie配置:cookie.php
- Session配置:session.php
- 命令行配置:console.php
- 多語言配置:lang.php
- 日志配置:log.php
- 頁面Trace配置:trace.php
- 磁盤配置: filesystem.php
- 中間件配置:middleware.php
- 視圖配置:view.php
- 改成用yaconf配置
- 事件
- 例子:省略事件類的demo
- 例子2:完整事件類
- 例子3:事件訂閱,監聽多個事件
- 解析
- 路由
- 路由定義
- 路由地址
- 變量規則
- MISS路由
- URL生成
- 閉包支持
- 路由參數
- 路由中間件
- 路由分組
- 資源路由
- 注解路由
- 路由綁定
- 域名路由
- 路由緩存
- 跨域路由
- 控制器
- 控制器定義
- 空控制器、空操作
- 空模塊處理
- RESTFul資源控制器
- 控制器中間件
- 請求對象Request(url參數)
- 請求信息
- 獲取輸入變量($_POST、$_GET等)
- 請求類型的獲取與偽裝
- HTTP頭信息
- 偽靜態
- 參數綁定
- 請求緩存
- 響應對象Response
- 響應輸出
- 響應參數
- 重定向
- 文件下載
- 錯誤頁面的處理辦法
- 應用公共文件common.php
- 模型
- 模型定義及常規屬性
- 模型數據獲取與模型賦值
- 查詢
- 數據集
- 增加
- 修改
- 刪除
- 條件
- 查詢范圍scope
- 獲取器
- 修改器
- 搜索器
- 軟刪除
- 模型事件
- 關聯預載入
- 模型關聯
- 一對一關聯
- 一對多關聯
- 多對多關聯
- 自動時間戳
- 事務
- 數據庫
- 查詢構造器
- 查詢合集
- 子查詢
- 聚合查詢
- 時間查詢
- 視圖查詢(比join簡單)
- 獲取查詢參數
- 快捷方法
- 動態查詢
- 條件查詢
- 打印sql語句
- 增
- 刪
- 改
- 查
- 鏈式操作
- 查詢表達式
- 分頁查詢
- 原生查詢
- JSON字段
- 鏈接數據庫配置
- 分布式數據庫
- 查詢事件
- Db獲取器
- 事務操作
- 存儲過程
- Db數據集
- 數據庫驅動
- 視圖
- 模板
- 模板配置
- 模板位置
- 模板渲染
- 模板變量與賦值(assign)
- 模板輸出替換
- url生成
- 模板詳解
- 內置標簽
- 三元運算
- 變量輸出
- 函數輸出
- Request請求參數
- 模板注釋及原樣輸出
- 模板繼承
- 模板布局
- 原生PHP
- 模板引擎
- 視圖過濾
- 視圖驅動
- 驗證
- 驗證進階之最終版
- 錯誤和日志
- 異常處理
- 日志處理
- 調試
- 調試模式
- Trace調試
- SQL調試
- 變量調試
- 遠程調試
- 雜項
- 緩存
- Session
- Cookie
- 多語言
- 上傳
- 擴展說明
- N+1查詢
- TP類庫
- 擴展類庫
- 數據庫遷移工具
- Workerman
- think助手工具庫
- 驗證碼
- Swoole
- request
- app
- Response
- View
- Validate
- Config
- 命令行
- 助手函數
- 升級指導(功能的添加與刪除說明)
- siyucms
- 開始
- 添加頁面流程
- 列表頁加載流程
- 彈出框
- 基礎控制器
- 基礎模型
- 快速構建
- 表單form構建
- 表格table構建
- MakeBuilder
- 前端組件
- 日期組件
- layer 彈層組件
- Moment.js 日期處理插件
- siyucms模板布局
- 函數即其變量
- 前端頁面
- $.operate.方法
- $.modal.方法:彈出層
- $.common.方法:通用方法
- 被cms重寫的表格options
- 自定義模板
- 搜索框
- 自定義form表單
- 獲取表單搜索參數并組裝為url字符串