服務 ―― Session

服務 —— Session

1、簡介

由于HTTP。

1.1 配置

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

session驅(qū)動定義請求的session數(shù)據(jù)存放在哪里，Laravel可以處理多種類型的驅(qū)動：

• 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ù)組驅(qū)動通常用于運行測試以避免session數(shù)據(jù)持久化。

1.2 Session驅(qū)動預備知識

1.2.1 數(shù)據(jù)庫

當使用databasesession驅(qū)動時，需要設(shè)置表包含session項，下面是該數(shù)據(jù)表的表結(jié)構(gòu)聲明：

Schema::create('sessions', function ($table) {
    $table->string('id')->unique();
    $table->text('payload');
    $table->integer('last_activity');
});

你可以使用Artisan命令session:table來生成遷移：

php artisan session:table
composer dump-autoload
php artisan migrate

1.2.2?Redis

在Laravel中使用Redis?session驅(qū)動前，需要通過Composer安裝predis/predis包。

1.3 其它Session相關(guān)問題

Laravel框架內(nèi)部使用flash?session鍵，所以你不應該通過該名稱添加數(shù)據(jù)項到session。

如果你需要所有存儲的session數(shù)據(jù)經(jīng)過加密，在配置文件中設(shè)置encrypt配置為true。

2、基本使用

訪問session

首先，我們來訪問session，我們可以通過HTTP請求訪問session實例，可以在控制器方法中通過類型提示引入請求實例，記住，控制器方法依賴通過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 showProfile(Request $request, $id)
    {
        $value = $request->session()->get('key');

        //
    }
}

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

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

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

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

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

還可以使用全局的PHP函數(shù)session來獲取和存儲session中的數(shù)據(jù)：

Route::get('home', function () {
    // 從session中獲取數(shù)據(jù)...
    $value = session('key');

    // 存儲數(shù)據(jù)到session...
    session(['key' => 'value']);
});

判斷session中是否存在指定項

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

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

在session中存儲數(shù)據(jù)

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

$request->session()->put('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');

從session中刪除數(shù)據(jù)項

forget方法從session中移除指定數(shù)據(jù)，如果你想要從session中移除所有數(shù)據(jù)，可以使用flush方法：

$request->session()->forget('key');
$request->session()->flush();

重新生成Session ID

如果你需要重新生成session ID，可以使用regenerate方法：

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

2.1 一次性數(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']);

3、添加自定義Session驅(qū)動

要為Laravel后端session添加更多驅(qū)動，可以使用Session門面上的extend方法。可以在服務提供者的boot方法中調(diào)用該方法：

<?php

namespace App\Providers;

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

class SessionServiceProvider extends ServiceProvider{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Session::extend('mongo', function($app) {
            // Return implementation of SessionHandlerInterface...
            return new MongoSessionStore;
        });
    }

    /**
     * Register bindings in the container.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

需要注意的是自定義session驅(qū)動需要實現(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) {}
}

由于這些方法并不像緩存的StoreInterface接口方法那樣容易理解，我們接下來快速過一遍每一個方法：

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

session驅(qū)動被注冊之后，就可以在配置文件config/session.php中使用mongo?驅(qū)動了。