# HTTP Session - [簡介](#introduction) - [配置](#configuration) - [Session 驅動介紹](#driver-prerequisites) - [使用 Session](#using-the-session) - [獲取 Session 數據](#retrieving-data) - [存儲數據到 Session](#storing-data) - [閃存數據到 Session](#flash-data) - [從 Session 中移除數據](#deleting-data) - [重新生成 Session ID](#regenerating-the-session-id) - [添加自定義 Session 驅動](#adding-custom-session-drivers) - [實現驅動](#implementing-the-driver) - [注冊驅動](#registering-the-driver) <a name="introduction"></a> ## 簡介 由于 HTTP 協議是無狀態的，所以 session 提供了一種存儲用戶多個請求數據的方法。Laravel 附帶支持了多種 session 后端驅動，并通過統一的 API 進行使用。也內置支持 [Memcached](http://memcached.org)、[Redis](http://redis.io) 和數據庫這些熱門的后端驅動。 <a name="configuration"></a> ### 配置 Session 的配置文件在 `config/session.php`。請確認一下此配置文件中可用的設置選項。Laravel 默認使用 `file` 的 session 驅動，它在大多數應用中可以良好運作。在上線的應用程序中，你可能會考慮使用更快的 `memcached ` 或 `redis` 來驅動。 Session `driver` 定義每次請求的 session 數據，會使用怎樣的方式進行存儲。Laravel 附帶了幾個不錯且可開箱即用的驅動： <div class="content-list" markdown="1"> - `file` - 將 sessions 保存在 `storage/framework/sessions` 中。 - `cookie` - 將 sessions 安全的保存在加密后的 cookies 中。 - `database` - 將 sessions 保存在應用程序使用的數據庫中。 - `memcached` / `redis` - 將 sessions 保存在其中一個快速且基于緩存的存儲系統中。 - `array` - 將 sessions 保存在簡單的 PHP 數組中，并只存在于本次請求。 </div> > {tip} 數組驅動一般應在 [測試](/docs/{{version}}/testing) 環境下使用，以防止存儲在 session 中的數據持續存在。 -- > 譯者注：推薦使用 Redis 來做 Session 驅動。Session 和緩存一起使用 Redis 的話，還需要多余的配置，請參考 - [Laravel 下配置 Redis 讓緩存、Session 各自使用不同的 Redis 數據庫](https://phphub.org/topics/2466) <a name="driver-prerequisites"></a> ### Session 驅動介紹 #### 數據庫 當使用 `database` 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'); }); 你也可使用 `session:table` Artisan 命令生成遷移文件： php artisan session:table php artisan migrate #### Redis 在 Laravel 使用 Redis Session 之前，你需要先通過 Composer 安裝 `predis/predis`(~1.0) 擴展包，然后在 `database` 配置文件中配置 Redis 連接參數。 你還可以在 session 配置文件中的 connection 選項，指定使用的 Redis 連接。 <a name="using-the-session"></a> ## 使用 Session <a name="retrieving-data"></a> ### 獲取 Session 數據 在 Laravel 中有兩種方式使用 session 數據，一是使用全局 `session` 輔助函數，二是通過 HTTP 請求實例。 首先我們看一下第二種方式，在控制器方法內，我們是通過 HTTP 請求的類型提示，訪問 session 的。請記住，控制器方法的依賴是通過 Laravel 的 [服務容器](/docs/{{version}}/container) 注入的： <?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` 方法中的第二個參數內設置一個默認值，當指定的鍵名不存在時，將會返回設置的默認值。如果你傳入一個 `閉包` 作為 `get` 方法的默認值，該 `閉包` 將被運行并返回它的結果： $value = $request->session()->get('key', 'default'); $value = $request->session()->get('key', function() { return 'default'; }); #### 全局 Session 輔助函數 你也可使用全局的 `session` PHP 函數來獲取 session 中保存的數據。 當傳遞給 `session` 輔助函數的參數是單一字符串時，則返回該 session key 對應的值。 當傳遞給 `session` 輔助函數的參數是 'key / value' 數組時，則將數據存儲到 session 中。 Route::get('home', function () { // 獲取 session 中的一條數據... $value = session('key'); // 指定一個默認值... $value = session('key', 'default'); // 存儲一條數據至 session 中... session(['key' => 'value']); }); > {tip} 使用全局 `session` 輔助函數與通過 HTTP 請求實例來使用 `session` 兩者并無實質性差別。你可以通過 `assertSessionHas` 方法來進行測試。關于測試的更多信息，請閱讀文檔 [測試](/docs/{{version}}/testing)。 #### 獲取所有 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')) { // } <a name="storing-data"></a> ### 存儲數據到 Session 存儲數據到 Session，你可用使用 `put` 方法，或者 `session` 輔助函數。 // 通過 HTTP 請求存儲 Session ... $request->session()->put('key', 'value'); // 通過全局輔助函數存儲 Session ... session(['key' => 'value']); #### 保存數據進 Session 數組值中 `push` 方法可以將一個新的值加入至一個 session 數組內。例如，假設 `user.teams` 這個鍵是包含團隊名稱的數組，你可以將一個新的值加入此數組中。比如這樣： $request->session()->push('user.teams', 'developers'); #### 從 Session 中取出并刪除數據 `pull` 方法將把數據從 session 內取出，并且刪除它： $value = $request->session()->pull('key', 'default'); <a name="flash-data"></a> ### 閃存數據到 Session 有時候你想存入一條緩存的數據，讓它只在下一次的請求內有效，則可以使用 `flash` 方法。使用這個方法保存 session，只能將數據保留到下個 HTTP 請求，然后就會被自動刪除。閃存數據在短期的狀態消息中很有用： $request->session()->flash('status', 'Task was successful!'); 如果需要保留閃存數據給更多請求，可以使用 `reflash` 方法，這將會將所有的閃存數據保留給額外的請求。如果想保留特定的閃存數據，則可以使用 `keep` 方法： $request->session()->reflash(); $request->session()->keep(['username', 'email']); <a name="deleting-data"></a> ### 從 Session 中移除數據 `forget` 方法可以從 session 內刪除一條數據。如果你想刪除 session 內所有數據，則可以使用 `flush` 方法： $request->session()->forget('key'); $request->session()->flush(); <a name="regenerating-the-session-id"></a> ### 重新生成 Session ID 重新生成 Session ID，通常時為了防止惡意用戶利用 session 對應用進行攻擊。 via [session fixation](https://en.wikipedia.org/wiki/Session_fixation) 如果你使用了 `LoginController` 方法，那么 Laravel 會自動重新生成 Session ID，否則，你需要手動使用 `regenerate` 方法重新生成 session ID $request->session()->regenerate(); <a name="adding-custom-session-drivers"></a> ## 添加自定義的 Session 驅動 <a name="implementing-the-driver"></a> #### 實現驅動 你自定義的 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 擴展。 接口中的這些方法不太容易容易理解。讓我們來快速了解每個方法的作用： <div class="content-list" markdown="1"> - `open` 方法通常用于基于文件的 session 存儲系統。因為 Larvel 已經附帶了一個 `file` 的驅動，所以在該方法中不需要放置任何代碼。PHP 要求必需要有這個方法的實現，但你可以把這方法置空也沒關系。 - `close` 方法跟 `open` 方法很相似，通常也可以被忽略。對大多數的驅動而言，此方法并不是需要的。 - `read` 方法應當返回與給定的 $sessionId 相匹配的 session 數據的字符串版本。從這個自定義的驅動中獲取或存儲 session 數據不需要做任何序列化或其它編碼，因為 Laravel 已經為我們做了序列化。 - `write` 將與 `$sessionId` 關聯的特定 `$data` 字符串，寫入到持久化存儲系統，如 MongoDB、Dynamo 等等。再次重申，你不需要做任何序列化或其它編碼，因為 Laravel 會自動處理這些事情。 - `destroy` 方法從持久化存儲中移除 $sessionId 對應的數據。 - `gc` 方法能銷毀 `$lifetime` 之前的所有數據，`$lifetime` 是一個 UNIX 的時間戳。對本身擁有過期機制的系統如 Memcached 和 Redis 而言，該方法可以留空。 </div> <a name="registering-the-driver"></a> #### 注冊驅動 在 session 驅動實現了 `SessionHandlerInterface` 接口后，你還需要在框架中注冊該驅動，將該擴展驅動添加到 Laravel s session 后端。 你可以使用 `Session` [facade](/docs/{{version}}/facades)的 `extend` 方法。在 [服務提供者](/docs/{{version}}/providers) 的 `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) { // 返回 SessionHandlerInterface 的實現... return new MongoSessionStore; }); } /** * 在容器中注冊綁定。 * * @return void */ public function register() { // } } 一旦 session 驅動被注冊，則必須在 `config/session.php` 的配置文件內使用 `mongo` 驅動。 ## 譯者署名 | 用戶名 | 頭像 | 職能 | 簽名 | |---|---|---|---| | [WangYan](http://blog.wangyan.org) | <img class="avatar-66 rm-style" src="http://imgcdn.wangyan.org/a/120x120.jpg"> | 翻譯 | [About Me](http://blog.wangyan.org/about) |