Laravel Http層--Session

1、介紹

由于 HTTP 驅動的應用是無狀態(tài)的，所以我們使用 Session 來存儲用戶請求信息。Laravel通過干凈、統(tǒng)一的 API 處理后端各種 Session 驅動，目前支持的流行后端驅動包括 Memcached、Redis 和數(shù)據(jù)庫。

配置
Session 配置文件位于 config/session.php 。默認情況下，Laravel 使用的 Session 驅動為 file驅動，這對許多應用而言是沒有什么問題的。在生產(chǎn)環(huán)境中，你可能考慮使用 memcached 或者 redis 驅動以便獲取更快的 Session 性能。

  • Session 驅動定義請求的 Session 數(shù)據(jù)存放在哪里，Laravel 可以處理多種類型的驅動：
  • file – Session 數(shù)據(jù)存儲在 storage/framework/sessions 目錄下；
  • cookie – Session 數(shù)據(jù)存儲在經(jīng)過加密的安全的 Cookie 中；
  • database – Session 數(shù)據(jù)存儲在數(shù)據(jù)庫中
  • memcached / redis – Session 數(shù)據(jù)存儲在 Memcached/Redis 中；
  • array – Session 數(shù)據(jù)存儲在簡單 PHP 數(shù)組中，在多個請求之間是非持久化的。

注意：數(shù)組驅動通常用于運行測試以避免 Session 數(shù)據(jù)持久化。

Session 驅動預備知識

數(shù)據(jù)庫

當使用 database 作為 Session 驅動時，需要設置表包含 Session 字段，下面是該數(shù)據(jù)表的表結構聲明：

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

在 Laravel 中使用 Redis 作為 Session 驅動前，需要通過 Composer 安裝 predis/predis 包?？梢栽?database 配置文件中配置 Redis 連接，在 Session 配置文件中，connection 選項用于指定 Session 使用哪一個 Redis 連接。

2、使用Session

獲取數(shù)據(jù)

在 Laravel 中主要有兩種方式處理 Session 數(shù)據(jù)：全局的輔助函數(shù) session，或者通過 Request 實例。首先，我們通過 Request 實例來訪問 Session 數(shù)據(jù)，可以在控制器方法中通過類型提示引入該實例，記住，控制器方法依賴通過 Laravel 服務容器自動注入：

<?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 中獲取數(shù)據(jù)的時候，還可以傳遞默認值作為第二個參數(shù)到 get 方法，默認值在指定鍵在Session 中不存在時返回。如果你傳遞一個閉包作為默認值到 get 方法，該閉包會執(zhí)行并返回執(zhí)行結果：

$value = $request->session()->get('key', 'default');
$value = $request->session()->get('key', function() {
 return 'default';
});

全局Session輔助函數(shù)

還可以使用全局的PHP函數(shù) session 來獲取和存儲 Session 中的數(shù)據(jù)，如果只傳遞一個字符串參數(shù)到 session 方法，則返回該 Session 鍵對應的值；如果傳遞的參數(shù)是 key/value 鍵值對數(shù)組，則將這些數(shù)據(jù)保存到 Session：

Route::get('home', function () {
 // 從session中獲取數(shù)據(jù)... 
$value = session('key');
 // 指定默認值... 
$value = session('key', 'default');
 // 存儲數(shù)據(jù)到session... 
session(['key' => 'value']);});

注：通過 HTTP 請求實例和輔助函數(shù) session 處理數(shù)據(jù)并無實質(zhì)性差別，這兩個方法在測試用例中都可以通過 assertSessionHas 方法進行測試。

獲取所有Session值

如果你想要從 Session 中獲取所有數(shù)據(jù)，可以使用 all 方法：

$data = $request->session()->all();

判斷Session中是否存在指定項

has 方法可用于檢查數(shù)據(jù)項在 Session 中是否存在。如果存在并且不為 null 的話返回 true：

if ($request->session()->has('users')) {
 //
}

要判斷某個值在 Session中是否存在，即使是 null 的話也無所謂，則可以使用 exists 方法。如果值存在的話 exists 返回 true：

if ($request->session()->exists('users')) {
 //
}

存儲數(shù)據(jù)

獲取到 Session 實例后，就可以調(diào)用多個方法來與底層數(shù)據(jù)進行交互，例如，put 方法存儲新的數(shù)據(jù)到 session 中：

//通過put方法
$request->session()->put('key', 'value');

//通過全局輔助函數(shù)
session(['key' => 'value']);

推送數(shù)據(jù)到數(shù)組Session

push 方法可用于推送數(shù)據(jù)到值為數(shù)組的 Session，例如，如果 user.teams 鍵包含團隊名數(shù)組，可以像這樣推送新值到該數(shù)組：

$request->session()->push('user.teams', 'developers');

獲取并刪除數(shù)據(jù)

pull方法將會從 Session 獲取并刪除數(shù)據(jù)：

$value = $request->session()->pull('key', 'default');

一次性數(shù)據(jù)

有時候你可能想要在 Session 中存儲只在下個請求中有效的數(shù)據(jù)，可以通過 flash 方法來實現(xiàn)。使用該方法存儲的 Session 數(shù)據(jù)只在隨后的 HTTP 請求中有效，然后將會被刪除：

$request->session()->flash('status', 'Task was successful!');

如果你需要在更多請求中保持該一次性數(shù)據(jù)，可以使用 reflash 方法，該方法將所有一次性數(shù)據(jù)保留到下一個請求，如果你只是想要保存特定一次性數(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經(jīng)常用于阻止惡意用戶對應用進行session fixation攻擊（關于session fixation 攻擊可參考這篇文章：http://www.360doc.com/content/11/1028/16/1542811_159889635.shtml）。

如果你使用內(nèi)置的 LoginController 的話，Laravel 會在認證期間自動重新生成 session id，如果你需要手動重新生成 session ID，可以使用 regenerate 方法：

$request->session()->regenerate();

3、添加自定義Session驅動

實現(xiàn)驅動

自定義 Session 驅動需要實現(xiàn) SessionHandlerInterface 接口，該接口包含少許我們需要實現(xiàn)的方法，比如一個 MongoDB 的實現(xiàn)如下：

<?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) {}
}

注：Laravel 默認并沒有附帶一個用于包含擴展的目錄，你可以將擴展放置在任何地方，這里我們創(chuàng)建一個 Extensions 目錄用于存放 MongoHandler。

由于這些方法并不是很容易理解，所以我們接下來快速過一遍每一個方法：

  • open 方法用于基于文件的 Session 存儲系統(tǒng)，由于 Laravel 已經(jīng)有了一個 file Session 驅動，所以在該方法中不需要放置任何代碼，可以將其置為空方法。
  • close 方法和 open 方法一樣，也可以被忽略，對大多數(shù)驅動而言都用不到該方法。
  • read 方法應該返回與給定 $sessionId 相匹配的 Session 數(shù)據(jù)的字符串版本，從驅動中獲取或存儲 Session 數(shù)據(jù)不需要做任何序列化或其它編碼，因為 Laravel 已經(jīng)為我們做了序列化。
  • write 方法應該將給定 $data 寫到持久化存儲系統(tǒng)相應的 $sessionId, 例如 MongoDB, Dynamo 等等。再次重申，不要做任何序列化操作，Laravel已經(jīng)為我們處理好了。
  • destroy 方法從持久化存儲中移除 $sessionId 對應的數(shù)據(jù)。
  • gc 方法銷毀大于給定 $lifetime 的所有 Session 數(shù)據(jù)，對本身擁有過期機制的系統(tǒng)如 Memcached 和 Redis 而言，該方法可以留空。

注冊驅動

驅動被實現(xiàn)后，需要準備將其注冊到框架，要添加額外驅動到 Laravel Session 后端，可以使用 Session
門面上的 extend方法。我們在服務提供者的 boot 方法中調(diào)用該方法：

<?php

namespace App\Providers;

use App\Extensions\MongoSessionStore;
use Illuminate\Support\Facades\Session;
use Illuminate\Support\ServiceProvider;

class SessionServiceProvider extends ServiceProvider
{
    /**
     * 執(zhí)行服務注冊后 引導.
     *
     * @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 驅動了。

最后編輯于 ：
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容