Session
Session
HTTP 會話機制
簡介
由于 HTTP 驅(qū)動的應(yīng)用程序是無狀態(tài)的,Session 提供了一種在多個請求之間存儲有關(guān)用戶信息的方法,Laravel 通過同一個可讀性強的 API 處理各種自帶的后臺驅(qū)動程序。支持諸如比較熱門的 Memcached, Redis 和數(shù)據(jù)庫。
配置
Session 的配置文件存儲在 config/session.php
文件中。請務(wù)必查看此文件中對于你而言可用的選項。默認情況下,Laravel 為絕大多數(shù)應(yīng)用程序配置的 Session 驅(qū)動為 file
。在生產(chǎn)環(huán)境中,你可以考慮使用 memcached
或 redis
驅(qū)動,讓 Session 的性能更加出色。
Session driver
的配置預(yù)設(shè)了每個請求存儲 Session 數(shù)據(jù)的位置。Laravel 自帶了幾個不錯而且開箱即用的驅(qū)動:
file
- 將 Session 存儲在storage/framework/sessions
中。cookie
- Sessions 被存儲在安全加密的 cookie 中。database
- Sessions 被存儲在關(guān)系型數(shù)據(jù)庫中。memcached
/redis
- Sessions 被存儲在基于高速緩存的存儲系統(tǒng)中。array
- Sessions 存儲在 PHP 數(shù)組中,但不會被持久化。
{tip} 數(shù)組驅(qū)動一般用于 測試 并且防止存儲在 Session 中的數(shù)據(jù)被持久化。
驅(qū)動程序先決條件
數(shù)據(jù)庫
使用 database
作為 Session 驅(qū)動時,你需要創(chuàng)建一張包含 Session 各項數(shù)據(jù)的表。以下是使用 Schema
建表的例子:
Schema::create('sessions', function ($table) { $table->string('id')->unique(); $table->unsignedInteger('user_id')->nullable(); $table->string('ip_address', 45)->nullable(); $table->text('user_agent')->nullable(); $table->text('payload'); $table->integer('last_activity'); });
你可以使用 Artisan 命令 session:table
來生成此遷移:
php artisan session:table php artisan migrate
Redis
Laravel 在使用 Redis 作為 Session 驅(qū)動之前,需要通過 Composer 安裝 predis/predis
擴展包 (~1.0)。然后在 database
配置文件中配置 Redis 連接信息。在 session
配置文件中,connection
選項可用于指定 Session 使用哪個 Redis 連接。
使用 Session
獲取數(shù)據(jù)
Laravel 中處理 Session 數(shù)據(jù)有兩種主要方法:全局輔助函數(shù) session
和通過一個 Request
實例。首先,我們來看看通過控制器方法類型提示一個 Request
實例來訪問 session??刂破鞣椒ㄒ蕾図棔ㄟ^ Laravel 服務(wù)容器 實現(xiàn)自動注入:
<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use App\Http\Controllers\Controller; class UserController extends Controller{ /** * 展示給定用戶的配置文件。 * * @param Request $request * @param int $id * @return Response */ public function show(Request $request, $id) { $value = $request->session()->get('key'); // } }
當(dāng)你從 Session 獲取值時,你還可以傳遞一個默認值作為 get
方法的第二個參數(shù)。如果 Session 中不存在指定的鍵,便會返回這個默認值。若傳遞一個閉包作為 get
方法的默認值,并且所請求的鍵并不存在時,get
方法將執(zhí)行閉包并返回其結(jié)果:
$value = $request->session()->get('key', 'default'); $value = $request->session()->get('key', function () { return 'default'; });
全局輔助函數(shù) Session
你也可以使用全局的 PHP 輔助函數(shù) session
來獲取和存儲 Session 數(shù)據(jù)。 使用單個字符串類型的值作為參數(shù)調(diào)用輔助函數(shù) session
時,它會返回該字該符串對應(yīng)的 Session 鍵的值。當(dāng)使用一個鍵值對數(shù)組作為參數(shù)調(diào)用輔助函數(shù) session
時,傳入的鍵值將會存儲在 Session 中:
Route::get('home', function () { // 獲取 session 中的一條數(shù)據(jù)... $value = session('key'); // 指定一個默認值... $value = session('key', 'default'); // 在 Session 中存儲一條數(shù)據(jù)... session(['key' => 'value']); });
{tip} 通過 HTTP 請求實例操作 Session 與使用全局輔助函數(shù)
session
兩者之間并沒有實質(zhì)上的區(qū)別。這兩種方法都可以通過所有測試用例中可用的assertSessionHas
方法進行 測試 。
獲取所有的 Session 數(shù)據(jù)
如果你想要獲取所有的 Session 數(shù)據(jù),可以使用 all
方法:
$data = $request->session()->all();
判斷 Session 中是否存在某個值
要確定 Session 中是否存在某個值,可以使用 has
方法。如果該值存在且不為 null
,那么 has
方法會返回 true
:
if ($request->session()->has('users')) { // }
要確定 Session 中是否存在某個值,即使其值為 null
,也可以使用 exists
方法。如果值存在,則 exists
方法返回 true
:
if ($request->session()->exists('users')) { // }
存儲數(shù)據(jù)
想要存儲數(shù)據(jù)到 Session,你可以使用 put
方法,或者使用輔助函數(shù) session
。
// 通過請求實例... $request->session()->put('key', 'value'); // 通過全局輔助函數(shù)... session(['key' => 'value']);
在 Session 數(shù)組中保存數(shù)據(jù)
push
方法可以將一個新的值添加到 Session 數(shù)組內(nèi)。例如,假設(shè) user.teams
這個鍵是包括團隊名稱的數(shù)組,你可以這樣將一個新的值加入到數(shù)組中:
$request->session()->push('user.teams', 'developers');
檢索 & 刪除一條數(shù)據(jù)
pull
方法可以只使用一條語句就從 Session 中檢索并刪除一條語句:
$value = $request->session()->pull('key', 'default');
閃存數(shù)據(jù)
有時候你可能想在 Session 中保存數(shù)據(jù)用于下一次請求,這時你可以使用 flash
方法。使用這個方法保存在 Session 中的數(shù)據(jù),只會保留到下一個 HTTP 請求到來之前,然后就會被刪除。閃存數(shù)據(jù)主要用于短期的狀態(tài)消息:
$request->session()->flash('status', 'Task was successful!');
如果你需要在更多的請求中使用到該一次性數(shù)據(jù),你可以使用 reflash
方法,該方法會將所有一次性請求保留到下一次請求。如果你想保存一次性數(shù)據(jù),你可以用 keep
方法:
$request->session()->reflash(); $request->session()->keep(['username', 'email']);
刪除數(shù)據(jù)
forget
方法會從 Session 中刪除指定數(shù)據(jù),如果想從 Session 中刪除所有數(shù)據(jù),可以使用 flush
方法:
$request->session()->forget('key'); $request->session()->flush();
重新生成 Session ID
重新生成 session ID 通常是為了防止惡意用戶利用 session fixation 對你的應(yīng)用進行攻擊。
如果你使用了內(nèi)置函數(shù) LoginController
,Laravel 會自動重新生成身份認證中的 Session ID。否則,你需要手動使用 regenerate
方法重新生成 Session ID。
$request->session()->regenerate();
添加自定義 Session 驅(qū)動
實現(xiàn)驅(qū)動
你自定義的 Session 驅(qū)動必須實現(xiàn) SessionHandlerInterface
接口。這個接口包含了一些我們需要實現(xiàn)的簡單方法。下面是 MongoDB 實現(xiàn)的大概流程示例:
<?php namespace App\Extensions; class MongoSessionHandler implements \SessionHandlerInterface{ public function open($savePath, $sessionName) {} public function close() {} public function read($sessionId) {} public function write($sessionId, $data) {} public function destroy($sessionId) {} public function gc($lifetime) {} }
{tip} Laravel 默認沒有附帶一個用于包擴展的目錄,你可以把它放在你喜歡的目錄內(nèi)。在上面這個例子中,我們創(chuàng)建了一個
Extensions
目錄用于存放MongoSessionHandler
。
由于以上方法并不是很容易理解,所以我們接下來快速過一遍每一個方法:
open
方法通常用于基于文件的 Session 存儲系統(tǒng)。因為 Laravel 已經(jīng)附帶了一個file
Session 驅(qū)動。所以你不需要在該方法中放置任何代碼。PHP 要求必須要有這個方法的實現(xiàn)(這只是一個糟糕的接口設(shè)計),你只需要把這個方法置空。close
方法跟open
方法相似,通常也可以被忽略。對大多數(shù)的驅(qū)動而言,此方法不是必須的。read
方法應(yīng)當(dāng)返回與給定的$sessionId
相匹配的 Session 數(shù)據(jù)的字符串格式。在你的自定義的驅(qū)動中獲取或存儲 Session 數(shù)據(jù)時,不需要進行任何序列化或者其他編碼,因為 Laravel 會自動為你執(zhí)行序列化。write
方法將與$sessionId
關(guān)聯(lián)的給定的$data
字符串寫入到一些持久化存儲系統(tǒng),如 MongoDB、 Dynamo 等。再次重申,你不需要進行任何序列化或其他編碼,因為 Laravel 會自動為你處理這些事情。destroy
方法將會從持久化存儲中與刪除與$sessionId
相關(guān)的數(shù)據(jù)。gc
方法能銷毀給定的$lifetime
(UNIX 的時間戳)之前的所有數(shù)據(jù)。對本身擁有過期機制的系統(tǒng)如 Memcached 和 Redis 而言,該方法可以置空。
注冊驅(qū)動
當(dāng)實現(xiàn)驅(qū)動后,需要在框架中注冊它。在 Laravel
后端添加額外的驅(qū)動,需要使用 Session
facade 的 extend
方法。你應(yīng)該在 服務(wù)提供者 中的 boot
方法中調(diào)用 extend
方法。你可以在已有的 AppServiceProvider
或者另外創(chuàng)建一個服務(wù)提供者執(zhí)行此操作:
<?php namespace App\Providers; use App\Extensions\MongoSessionHandler; use Illuminate\Support\Facades\Session; use Illuminate\Support\ServiceProvider; class SessionServiceProvider extends ServiceProvider{ /** * 執(zhí)行服務(wù)的注冊后啟動 * * @return void */ public function boot() { Session::extend('mongo', function ($app) { // 返回實現(xiàn) SessionHandlerInterface 的對象 return new MongoSessionHandler; }); } /** * 在容器中注冊綁定關(guān)系 * * @return void */ public function register() { // } }
驅(qū)動完成注冊時,你可以在使用在配置文件 config/session.php
中使用 mongo
驅(qū)動。