* * * * * [TOC] ## 簡介 由于 HTTP 是無狀態的，Session 提供了一種在多個請求之間存儲有關用戶信息的方法。Laravel 附帶支持了多種 Session 后端驅動，它們都可以通過語義化統一的 API 訪問。Laravel 本身支持比較熱門的 Session 后端驅動，如?[Memcached](https://memcached.org/)、[Redis](http://redis.io/)?和數據庫。 ### 配置 Session 相關的配置文件存儲在?`config/session.php`。請務必查看此文件中對于你可用的選項。默認設置下，Laravel 的配置是使用文件作為 Session 驅動，大多數情況下能夠運行良好。在生產環境下，你可以考慮使用?`memcached`?或?`redis`?驅動來達到更出色的性能表現。 Session 配置的?`driver`?的選項定義了每次請求的 Session 數據的存儲位置。Laravel 附帶了幾個不錯且可開箱即用的驅動： * `file`?- 將 Session 保存在?`storage/framework/sessions`。 * `cookie`?- Session 保存在安全加密的 Cookie 中。 * `database`?- Session 保存在關系型數據庫。 * `memcached`?/?`redis`?- 將 Sessions 保存在其中一個快速且基于緩存的存儲系統中。 * `array`?- 將 Sessions 保存在簡單的 PHP 數組中，并只存在于本次請求. > {tip} 數組驅動一般用于?[測試](Laravel 測試入門指南.md)?防止存儲在 Session 的數據被持久化。 ### 驅動條件 #### 數據庫 使用 數據庫 作為 Session 驅動時，你需要創建一張包含 Session 各項數據的表。以下例子是使用?`Schema`?建表： ~~~ Schema::create('sessions', function ($table) { $table->string('id')->unique(); $table->integer('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 在使用 Redis 作為 Session 驅動之前，你需要通過 Composer 安裝?`predis/predis`?擴展包(~1.0)。你還需要在?`database`?配置文件中指定 Redis 連接參數信息。在 Session 配置文件中的?`connection`?選項中指定 Session 使用的 Redis 連接。 ## 使用 Session ### 獲取 Session 數據 Laravel 中有兩種主要的方式使用 Session 數據的方式：一種是全局的輔助函數?`session`，另一種是通過 HTTP 請求實例。首先，我們先看一下第二種方法，就是通過具有控制器方法類型提示的 HTTP 請求實例來訪問 Session。請記住，控制器方法的依賴關系會通過 Laravel 的?[服務容器](服務容器.md)自動注入： ~~~ <?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'); // } } ~~~ 當從 Session 獲取值時，你也可以傳遞一個默認值作為?`get`?方法的第二個參數。如果 Session 中并不存在指定的鍵值便會返回傳入的默認值。若傳遞一個閉包作為?`get`?方法的默認值且請求的鍵值并不存在時，此時?`get`?方法會返回這個閉包函數運行后的返回值： ~~~ $value = $request->session()->get('key', 'default'); $value = $request->session()->get('key', function () { return 'default'; }); ~~~ #### 全局 Session 輔助函數 你也可以使用全局的 PHP 函數?`session`?來獲取和存儲 Session 數據。 使用單個字符串類型的值作為參數調用?`session`?函數時，它將返回字該符串參數對應的 Session 鍵值。當使用一個 key / value 鍵值對數組作為參數調用?`session`?函數時，傳入的鍵值將會存入 Session： ~~~ Route::get('home', function () { // 獲取 Session 中的一條數據... $value = session('key'); // 指定一個默認值... $value = session('key', 'default'); // 存儲一條數據至 Session 中... session(['key' => 'value']); }); ~~~ > {tip} HTTP 請求實例與?`Session`?全局輔助函數使用 Session 并沒有實質上的區別。兩種方法都是可以通過?`assertSessionHas`?方法?[測試](Laravel 測試入門指南.md)?，`assertSessionHas`?方法在所有的測試用例都是可用的。關于測試的更多信息，請閱讀文檔?[測試](Laravel 測試入門指南.md) #### 獲取所有 Session 數據 如果你想要獲取所有的 Session 數據，可以使用?`all`?方法： ~~~ $data = $request->session()->all(); ~~~ #### 判斷某個 Session 值是否存在 使用?`has`?方法檢查某個值是否存在于 Session 內，如果該值存在并且不為 null，那么則返回 true： ~~~ if ($request->session()->has('users')) { // } ~~~ 在判斷值是否在 Session 中是否存時，如果該值可能為 null，你需要使用 exists 方法，如果該值存在，那么則返回 true： ~~~ if ($request->session()->exists('users')) { // } ~~~ ### 存儲 Session 數據 存儲數據到 Session，你可用使用?`put`?方法，或者?`session`?輔助函數。 ~~~ // 通過 HTTP 請求實例... $request->session()->put('key', 'value'); // 通過全局輔助函數 session(['key' => 'value']); ~~~ #### 保存數據進 Session 數組值中 push 方法可以將一個新的值加入至一個 Session 數組內。例如，假設 user.teams 這個鍵是包含團隊名稱的數組，你可以將一個新的值加入此數組中。比如這樣： ~~~ $request->session()->push('user.teams', 'developers'); ~~~ #### 從 Session 中取出并刪除數據 `pull`?方法將把數據從 Session 內取出，并且刪除： ~~~ $value = $request->session()->pull('key', 'default'); ~~~ ### 閃存數據到 Session 有時候你想存入一條緩存的數據，讓它只在下一次的請求內有效，則可以使用?`flash`?方法。使用這個方法保存 session，只能將數據保留到下個 HTTP 請求，然后就會被自動刪除。閃存數據在短期的狀態消息中很有用： ~~~ $request->session()->flash('status', 'Task was successful!'); ~~~ 如果需要保留閃存數據給更多請求，可以使用?`reflash`?方法，這將會將所有的閃存數據保留給額外的請求。如果想保留特定的閃存數據，則可以使用?`keep`?方法： ~~~ $request->session()->reflash(); $request->session()->keep(['username', 'email']); ~~~ ### 刪除 Session 數據 `forget`?方法可以從 Session 內刪除一條數據。如果你想刪除 Session 內所有數據，則可以使用?`flush`?方法： ~~~ $request->session()->forget('key'); $request->session()->flush(); ~~~ ### 重新生成 Session ID 重新生成 Session ID，通常時為了防止惡意用戶利用?[session fixation](https://en.wikipedia.org/wiki/Session_fixation)?對應用進行攻擊。 如果你使用了內置函數?`LoginController`，那么 Laravel 會自動重新生成 Session ID，否則，你需要手動使用?`regenerate`?方法重新生成 Session ID ~~~ $request->session()->regenerate(); ~~~ ## 添加自定義 Session 驅動 #### 實現驅動 你自定義的 Session 驅動必須實現?`SessionHandlerInterface`?接口。這個接口包含了一些基本需要實現的方法。一個基本的 MongoDB 實現應該看起來像這樣： ~~~ <?php namespace App\Extensions; class MongoHandler 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 默認沒有附帶擴展目錄，你可以把它放在你喜歡的目錄內。在下面這個例子中，我們創建了一個?`Extensions`?目錄放置自定義的?`MongoHandler`?擴展。 接口中的這些方法不太容易容易理解。讓我們來快速了解每個方法的作用： * `open`?方法通常用于基于文件的 Session 存儲系統。因為 Laravel 已經附帶了一個?`file`?的驅動，所以在該方法中不需要放置任何代碼。PHP 要求必需要有這個方法的實現，但你可以把這方法置空也沒關系。 * `close`?方法跟?`open`?方法很相似，通常也可以被忽略。對大多數的驅動而言，此方法并不是需要的。 * `read`?方法應當返回與給定的?`$sessionId`?相匹配的 Session 數據的字符串版本。從這個自定義的驅動中獲取或存儲 Session 數據不需要做任何序列化或其它編碼，因為 Laravel 已經為我們做了序列化。 * `write`?將與?`$sessionId`?關聯的特定?`$data`?字符串，寫入到持久化存儲系統，如 MongoDB、Dynamo 等等。再次重申，你不需要做任何序列化或其它編碼，因為 Laravel 會自動處理這些事情。 * `destroy`?方法從持久化存儲中移除?`$sessionId`?對應的數據。 * `gc`?方法能銷毀?`$lifetime`?之前的所有數據，`$lifetime`?是一個 UNIX 的時間戳。對本身擁有過期機制的系統如 Memcached 和 Redis 而言，該方法可以留空。 #### 注冊驅動 在 Session 驅動實現了?`SessionHandlerInterface`?接口后，你還需要在框架中注冊該驅動，將該擴展驅動添加到 Laravel Session 后端。你可以使用?`Session`?Facade 的?`extend`?方法。在?[服務提供者](服務提供者.md)?的?`boot`?方法內調用?`extend`?方法。你可用使用已經存在的?`AppServiceProvider`?或者創建一個新的提供者。 ~~~ <?php namespace App\Providers; use App\Extensions\MongoSessionStore; use Illuminate\Support\Facades\Session; use Illuminate\Support\ServiceProvider; class SessionServiceProvider extends ServiceProvider { /** * 提供注冊后運行的服務。 * * @return void */ public function boot() { Session::extend('mongo', function ($app) { // Return implementation of SessionHandlerInterface... return new MongoSessionStore; }); } /** * 在容器中注冊綁定。 * * @return void */ public function register() { // } } ~~~ 一旦 Session 驅動被注冊，則必須在?`config/session.php`?的配置文件內使用?`Mongo`?驅動。