Session · laravel 5.4

<article><h1>Laravel 的 HTTP 會話機制</h1><ul><li><a href="#introduction">簡介</a><ul><li><a href="#configuration">配置</a></li><li><a href="#driver-prerequisites">驅動條件</a></li></ul></li><li><a href="#using-the-session">使用 Session</a><ul><li><a href="#retrieving-data">獲取 Session 數據</a></li><li><a href="#storing-data">存儲 Session 數據</a></li><li><a href="#flash-data">閃存數據到 Session</a></li><li><a href="#deleting-data">刪除 Session 數據</a></li><li><a href="#regenerating-the-session-id">重新生成 Session ID</a></li></ul></li><li><a href="#adding-custom-session-drivers">添加自定義 Session 驅動</a><ul><li><a href="#implementing-the-driver">實現驅動</a></li><li><a href="#registering-the-driver">注冊驅動</a></li></ul></li></ul><a name="introduction"></a><h2><a href="#introduction">簡介</a></h2>由于 HTTP 是無狀態的，Session 提供了一種在多個請求之間存儲有關用戶信息的方法。Laravel 附帶支持了多種 Session 后端驅動，它們都可以通過語義化統一的 API 訪問。Laravel 本身支持比較熱門的 Session 后端驅動，如 <a href="https://memcached.org">Memcached</a>、<a href="http://redis.io">Redis</a> 和數據庫。<a name="configuration"></a><h3>配置</h3>Session 相關的配置文件存儲在 <code class=" language-php">config/session.php</code>。請務必查看此文件中對于你可用的選項。默認設置下，Laravel 的配置是使用文件作為 Session 驅動，大多數情況下能夠運行良好。在生產環境下，你可以考慮使用 <code class=" language-php">memcached</code> 或 <code class=" language-php">redis</code> 驅動來達到更出色的性能表現。Session 配置的 <code class=" language-php">driver</code> 的選項定義了每次請求的 Session 數據的存儲位置。Laravel 附帶了幾個不錯且可開箱即用的驅動：<div class="content-list"><ul><li><code class=" language-php">file</code> - 將 Session 保存在 <code class=" language-php">storage/framework/sessions</code>。</li><li><code class=" language-php">cookie</code> - Session 保存在安全加密的 Cookie 中。</li><li><code class=" language-php">database</code> - Session 保存在關系型數據庫。</li><li><code class=" language-php">memcached</code> / <code class=" language-php">redis</code> - 將 Sessions 保存在其中一個快速且基于緩存的存儲系統中。</li><li><code class=" language-php">array</code> - 將 Sessions 保存在簡單的 PHP 數組中，并只存在于本次請求.</li></ul></div><blockquote class="has-icon tip"><div class="flag"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:a="http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/" version="1.1" x="0px" y="0px" width="56.6px" height="87.5px" viewBox="0 0 56.6 87.5" enable-background="new 0 0 56.6 87.5" xml:space="preserve"><path fill="#FFFFFF" d="M28.7 64.5c-1.4 0-2.5-1.1-2.5-2.5v-5.7 -5V41c0-1.4 1.1-2.5 2.5-2.5s2.5 1.1 2.5 2.5v10.1 5 5.8C31.2 63.4 30.1 64.5 28.7 64.5zM26.4 0.1C11.9 1 0.3 13.1 0 27.7c-0.1 7.9 3 15.2 8.2 20.4 0.5 0.5 0.8 1 1 1.7l3.1 13.1c0.3 1.1 1.3 1.9 2.4 1.9 0.3 0 0.7-0.1 1.1-0.2 1.1-0.5 1.6-1.8 1.4-3l-2-8.4 -0.4-1.8c-0.7-2.9-2-5.7-4-8 -1-1.2-2-2.5-2.7-3.9C5.8 35.3 4.7 30.3 5.4 25 6.7 14.5 15.2 6.3 25.6 5.1c13.9-1.5 25.8 9.4 25.8 23 0 4.1-1.1 7.9-2.9 11.2 -0.8 1.4-1.7 2.7-2.7 3.9 -2 2.3-3.3 5-4 8L41.4 53l-2 8.4c-0.3 1.2 0.3 2.5 1.4 3 0.3 0.2 0.7 0.2 1.1 0.2 1.1 0 2.2-0.8 2.4-1.9l3.1-13.1c0.2-0.6 0.5-1.2 1-1.7 5-5.1 8.2-12.1 8.2-19.8C56.4 12 42.8-1 26.4 0.1zM43.7 69.6c0 0.5-0.1 0.9-0.3 1.3 -0.4 0.8-0.7 1.6-0.9 2.5 -0.7 3-2 8.6-2 8.6 -1.3 3.2-4.4 5.5-7.9 5.5h-4.1H28h-0.5 -3.6c-3.5 0-6.7-2.4-7.9-5.7l-0.1-0.4 -1.8-7.8c-0.4-1.1-0.8-2.1-1.2-3.1 -0.1-0.3-0.2-0.5-0.2-0.9 0.1-1.3 1.3-2.1 2.6-2.1H41C42.4 67.5 43.6 68.2 43.7 69.6zM37.7 72.5H26.9c-4.2 0-7.2 3.9-6.3 7.9 0.6 1.3 1.8 2.1 3.2 2.1h4.1 0.5 0.5 3.6c1.4 0 2.7-0.8 3.2-2.1L37.7 72.5z"></path></svg></div> 數組驅動一般用于 <a href="/docs/5.4/testing">測試</a> 防止存儲在 Session 的數據被持久化。</blockquote><a name="driver-prerequisites"></a><h3>驅動條件</h3><h4>數據庫</h4>使用數據庫作為 Session 驅動時，你需要創建一張包含 Session 各項數據的表。以下例子是使用 <code class=" language-php">Schema</code> 建表：<pre class=" language-php"><code class=" language-php">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'); });</code></pre>也可以使用 <code class=" language-php">Artisan</code> 的 <code class=" language-php">session:table</code> 命令生成一個遷移文件：<pre class=" language-php"><code class=" language-php">php artisan session:table php artisan migrate</code></pre><h4>Redis</h4>在使用 Redis 作為 Session 驅動之前，你需要通過 Composer 安裝 <code class=" language-php">predis/predis</code> 擴展包(~1.0)。你還需要在 <code class=" language-php">database</code> 配置文件中指定 Redis 連接參數信息。在 Session 配置文件中的 <code class=" language-php">connection</code> 選項中指定 Session 使用的 Redis 連接。<a name="using-the-session"></a><h2><a href="#using-the-session">使用 Session</a></h2><a name="retrieving-data"></a><h3>獲取 Session 數據</h3>Laravel 中有兩種主要的方式使用 Session 數據的方式：一種是全局的輔助函數 <code class=" language-php">session</code>，另一種是通過 HTTP 請求實例。首先，我們先看一下第二種方法，就是通過具有控制器方法類型提示的 HTTP 請求實例來訪問 Session。請記住，控制器方法的依賴關系會通過 Laravel 的 <a href="/docs/5.4/container">服務容器</a>自動注入：<pre class=" language-php"><code class=" language-php"><?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'); // } }</code></pre>當從 Session 獲取值時，你也可以傳遞一個默認值作為 <code class=" language-php">get</code> 方法的第二個參數。如果 Session 中并不存在指定的鍵值便會返回傳入的默認值。若傳遞一個閉包作為 <code class=" language-php">get</code> 方法的默認值且請求的鍵值并不存在時，此時 <code class=" language-php">get</code> 方法會返回這個閉包函數運行后的返回值：<pre class=" language-php"><code class=" language-php">$value = $request->session()->get('key', 'default'); $value = $request->session()->get('key', function () { return 'default'; });</code></pre><h4>全局 Session 輔助函數</h4>你也可以使用全局的 PHP 函數 <code class=" language-php">session</code> 來獲取和存儲 Session 數據。使用單個字符串類型的值作為參數調用 <code class=" language-php">session</code> 函數時，它將返回字該符串參數對應的 Session 鍵值。當使用一個 key / value 鍵值對數組作為參數調用 <code class=" language-php">session</code> 函數時，傳入的鍵值將會存入 Session：<pre class=" language-php"><code class=" language-php">Route::get('home', function () { // 獲取 Session 中的一條數據... $value = session('key'); // 指定一個默認值... $value = session('key', 'default'); // 存儲一條數據至 Session 中... session(['key' => 'value']); });</code></pre><blockquote class="has-icon tip"><div class="flag"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:a="http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/" version="1.1" x="0px" y="0px" width="56.6px" height="87.5px" viewBox="0 0 56.6 87.5" enable-background="new 0 0 56.6 87.5" xml:space="preserve"><path fill="#FFFFFF" d="M28.7 64.5c-1.4 0-2.5-1.1-2.5-2.5v-5.7 -5V41c0-1.4 1.1-2.5 2.5-2.5s2.5 1.1 2.5 2.5v10.1 5 5.8C31.2 63.4 30.1 64.5 28.7 64.5zM26.4 0.1C11.9 1 0.3 13.1 0 27.7c-0.1 7.9 3 15.2 8.2 20.4 0.5 0.5 0.8 1 1 1.7l3.1 13.1c0.3 1.1 1.3 1.9 2.4 1.9 0.3 0 0.7-0.1 1.1-0.2 1.1-0.5 1.6-1.8 1.4-3l-2-8.4 -0.4-1.8c-0.7-2.9-2-5.7-4-8 -1-1.2-2-2.5-2.7-3.9C5.8 35.3 4.7 30.3 5.4 25 6.7 14.5 15.2 6.3 25.6 5.1c13.9-1.5 25.8 9.4 25.8 23 0 4.1-1.1 7.9-2.9 11.2 -0.8 1.4-1.7 2.7-2.7 3.9 -2 2.3-3.3 5-4 8L41.4 53l-2 8.4c-0.3 1.2 0.3 2.5 1.4 3 0.3 0.2 0.7 0.2 1.1 0.2 1.1 0 2.2-0.8 2.4-1.9l3.1-13.1c0.2-0.6 0.5-1.2 1-1.7 5-5.1 8.2-12.1 8.2-19.8C56.4 12 42.8-1 26.4 0.1zM43.7 69.6c0 0.5-0.1 0.9-0.3 1.3 -0.4 0.8-0.7 1.6-0.9 2.5 -0.7 3-2 8.6-2 8.6 -1.3 3.2-4.4 5.5-7.9 5.5h-4.1H28h-0.5 -3.6c-3.5 0-6.7-2.4-7.9-5.7l-0.1-0.4 -1.8-7.8c-0.4-1.1-0.8-2.1-1.2-3.1 -0.1-0.3-0.2-0.5-0.2-0.9 0.1-1.3 1.3-2.1 2.6-2.1H41C42.4 67.5 43.6 68.2 43.7 69.6zM37.7 72.5H26.9c-4.2 0-7.2 3.9-6.3 7.9 0.6 1.3 1.8 2.1 3.2 2.1h4.1 0.5 0.5 3.6c1.4 0 2.7-0.8 3.2-2.1L37.7 72.5z"></path></svg></div> HTTP 請求實例與 <code class=" language-php">Session</code> 全局輔助函數使用 Session 并沒有實質上的區別。兩種方法都是可以通過 <code class=" language-php">assertSessionHas</code> 方法 <a href="/docs/5.4/testing">測試</a> ，<code class=" language-php">assertSessionHas</code> 方法在所有的測試用例都是可用的。關于測試的更多信息，請閱讀文檔 <a href="/docs/5.4/testing">測試</a></blockquote><h4>獲取所有 Session 數據</h4>如果你想要獲取所有的 Session 數據，可以使用 <code class=" language-php">all</code> 方法：<pre class=" language-php"><code class=" language-php">$data = $request->session()->all();</code></pre><h4>判斷某個 Session 值是否存在</h4>使用 <code class=" language-php">has</code> 方法檢查某個值是否存在于 Session 內，如果該值存在并且不為 null，那么則返回 true：<pre class=" language-php"><code class=" language-php">if ($request->session()->has('users')) { // }</code></pre>在判斷值是否在 Session 中是否存時，如果該值可能為 null，你需要使用 exists 方法，如果該值存在，那么則返回 true：<pre class=" language-php"><code class=" language-php">if ($request->session()->exists('users')) { // }</code></pre><a name="storing-data"></a><h3>存儲 Session 數據</h3>存儲數據到 Session，你可用使用 <code class=" language-php">put</code> 方法，或者 <code class=" language-php">session</code> 輔助函數。<pre class=" language-php"><code class=" language-php">// 通過 HTTP 請求實例... $request->session()->put('key', 'value'); // 通過全局輔助函數 session(['key' => 'value']);</code></pre><h4>保存數據進 Session 數組值中</h4>push 方法可以將一個新的值加入至一個 Session 數組內。例如，假設 user.teams 這個鍵是包含團隊名稱的數組，你可以將一個新的值加入此數組中。比如這樣：<pre class=" language-php"><code class=" language-php">$request->session()->push('user.teams', 'developers');</code></pre><h4>從 Session 中取出并刪除數據</h4><code class=" language-php">pull</code> 方法將把數據從 Session 內取出，并且刪除：<pre class=" language-php"><code class=" language-php">$value = $request->session()->pull('key', 'default');</code></pre><a name="flash-data"></a><h3>閃存數據到 Session</h3>有時候你想存入一條緩存的數據，讓它只在下一次的請求內有效，則可以使用 <code class=" language-php">flash</code> 方法。使用這個方法保存 session，只能將數據保留到下個 HTTP 請求，然后就會被自動刪除。閃存數據在短期的狀態消息中很有用：<pre class=" language-php"><code class=" language-php">$request->session()->flash('status', 'Task was successful!');</code></pre>如果需要保留閃存數據給更多請求，可以使用 <code class=" language-php">reflash</code> 方法，這將會將所有的閃存數據保留給額外的請求。如果想保留特定的閃存數據，則可以使用 <code class=" language-php">keep</code> 方法：<pre class=" language-php"><code class=" language-php">$request->session()->reflash(); $request->session()->keep(['username', 'email']);</code></pre><a name="deleting-data"></a><h3>刪除 Session 數據</h3><code class=" language-php">forget</code> 方法可以從 Session 內刪除一條數據。如果你想刪除 Session 內所有數據，則可以使用 <code class=" language-php">flush</code> 方法：<pre class=" language-php"><code class=" language-php">$request->session()->forget('key'); $request->session()->flush();</code></pre><a name="regenerating-the-session-id"></a><h3>重新生成 Session ID</h3>重新生成 Session ID，通常時為了防止惡意用戶利用 <a href="https://en.wikipedia.org/wiki/Session_fixation">session fixation</a> 對應用進行攻擊。如果你使用了內置函數 <code class=" language-php">LoginController</code>，那么 Laravel 會自動重新生成 Session ID，否則，你需要手動使用 <code class=" language-php">regenerate</code> 方法重新生成 Session ID<pre class=" language-php"><code class=" language-php">$request->session()->regenerate();</code></pre><a name="adding-custom-session-drivers"></a><h2><a href="#adding-custom-session-drivers">添加自定義 Session 驅動</a></h2><a name="implementing-the-driver"></a><h4>實現驅動</h4>你自定義的 Session 驅動必須實現 <code class=" language-php">SessionHandlerInterface</code> 接口。這個接口包含了一些基本需要實現的方法。一個基本的 MongoDB 實現應該看起來像這樣：<pre class=" language-php"><code class=" language-php"><?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) {} }</code></pre><blockquote class="has-icon tip"><div class="flag"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:a="http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/" version="1.1" x="0px" y="0px" width="56.6px" height="87.5px" viewBox="0 0 56.6 87.5" enable-background="new 0 0 56.6 87.5" xml:space="preserve"><path fill="#FFFFFF" d="M28.7 64.5c-1.4 0-2.5-1.1-2.5-2.5v-5.7 -5V41c0-1.4 1.1-2.5 2.5-2.5s2.5 1.1 2.5 2.5v10.1 5 5.8C31.2 63.4 30.1 64.5 28.7 64.5zM26.4 0.1C11.9 1 0.3 13.1 0 27.7c-0.1 7.9 3 15.2 8.2 20.4 0.5 0.5 0.8 1 1 1.7l3.1 13.1c0.3 1.1 1.3 1.9 2.4 1.9 0.3 0 0.7-0.1 1.1-0.2 1.1-0.5 1.6-1.8 1.4-3l-2-8.4 -0.4-1.8c-0.7-2.9-2-5.7-4-8 -1-1.2-2-2.5-2.7-3.9C5.8 35.3 4.7 30.3 5.4 25 6.7 14.5 15.2 6.3 25.6 5.1c13.9-1.5 25.8 9.4 25.8 23 0 4.1-1.1 7.9-2.9 11.2 -0.8 1.4-1.7 2.7-2.7 3.9 -2 2.3-3.3 5-4 8L41.4 53l-2 8.4c-0.3 1.2 0.3 2.5 1.4 3 0.3 0.2 0.7 0.2 1.1 0.2 1.1 0 2.2-0.8 2.4-1.9l3.1-13.1c0.2-0.6 0.5-1.2 1-1.7 5-5.1 8.2-12.1 8.2-19.8C56.4 12 42.8-1 26.4 0.1zM43.7 69.6c0 0.5-0.1 0.9-0.3 1.3 -0.4 0.8-0.7 1.6-0.9 2.5 -0.7 3-2 8.6-2 8.6 -1.3 3.2-4.4 5.5-7.9 5.5h-4.1H28h-0.5 -3.6c-3.5 0-6.7-2.4-7.9-5.7l-0.1-0.4 -1.8-7.8c-0.4-1.1-0.8-2.1-1.2-3.1 -0.1-0.3-0.2-0.5-0.2-0.9 0.1-1.3 1.3-2.1 2.6-2.1H41C42.4 67.5 43.6 68.2 43.7 69.6zM37.7 72.5H26.9c-4.2 0-7.2 3.9-6.3 7.9 0.6 1.3 1.8 2.1 3.2 2.1h4.1 0.5 0.5 3.6c1.4 0 2.7-0.8 3.2-2.1L37.7 72.5z"></path></svg></div> Laravel 默認沒有附帶擴展目錄，你可以把它放在你喜歡的目錄內。在下面這個例子中，我們創建了一個 <code class=" language-php">Extensions</code> 目錄放置自定義的 <code class=" language-php">MongoHandler</code> 擴展。</blockquote>接口中的這些方法不太容易容易理解。讓我們來快速了解每個方法的作用：<div class="content-list"><ul><li><code class=" language-php">open</code> 方法通常用于基于文件的 Session 存儲系統。因為 Larvel 已經附帶了一個 <code class=" language-php">file</code> 的驅動，所以在該方法中不需要放置任何代碼。PHP 要求必需要有這個方法的實現，但你可以把這方法置空也沒關系。</li><li><code class=" language-php">close</code> 方法跟 <code class=" language-php">open</code> 方法很相似，通常也可以被忽略。對大多數的驅動而言，此方法并不是需要的。</li><li><code class=" language-php">read</code> 方法應當返回與給定的 <code class=" language-php">$sessionId</code> 相匹配的 Session 數據的字符串版本。從這個自定義的驅動中獲取或存儲 Session 數據不需要做任何序列化或其它編碼，因為 Laravel 已經為我們做了序列化。</li><li><code class=" language-php">write</code> 將與 <code class=" language-php">$sessionId</code> 關聯的特定 <code class=" language-php">$data</code> 字符串，寫入到持久化存儲系統，如 MongoDB、Dynamo 等等。再次重申，你不需要做任何序列化或其它編碼，因為 Laravel 會自動處理這些事情。</li><li><code class=" language-php">destroy</code> 方法從持久化存儲中移除 <code class=" language-php">$sessionId</code> 對應的數據。</li><li><code class=" language-php">gc</code> 方法能銷毀 <code class=" language-php">$lifetime</code> 之前的所有數據，<code class=" language-php">$lifetime</code> 是一個 UNIX 的時間戳。對本身擁有過期機制的系統如 Memcached 和 Redis 而言，該方法可以留空。</li></ul></div><a name="registering-the-driver"></a><h4>注冊驅動</h4>在 Session 驅動實現了 <code class=" language-php">SessionHandlerInterface</code> 接口后，你還需要在框架中注冊該驅動，將該擴展驅動添加到 Laravel Session 后端。你可以使用 <code class=" language-php">Session</code> Facade 的 <code class=" language-php">extend</code> 方法。在 <a href="/docs/5.4/providers">服務提供者</a> 的 <code class=" language-php">boot</code> 方法內調用 <code class=" language-php">extend</code> 方法。你可用使用已經存在的 <code class=" language-php">AppServiceProvider</code> 或者創建一個新的提供者。<pre class=" language-php"><code class=" language-php"><?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() { // } }</code></pre>一旦 Session 驅動被注冊，則必須在 <code class=" language-php">config/session.php</code> 的配置文件內使用 <code class=" language-php">Mongo</code> 驅動。<h2>譯者署名</h2><table><thead><tr><th>用戶名</th><th>頭像</th><th>職能</th><th>簽名</th></tr></thead><tbody><tr><td><a href="http://weibo.com/wangkaibo">@王凱波</a></td><td><img class="avatar-66 rm-style" src="https://dn-phphub.qbox.me/uploads/avatars/1924_1487053084.jpeg?imageView2/1/w/100/h/100"></td><td>翻譯</td><td>面向工資編程 ?? <a href="https://github.com/wangkaibo/">@wangkaibo</a></td></tr></tbody></table></article>