HTTP 会话

• 简介
  • 配置
  • 驱动程序先决条件
• 与会话交互
  • 检索数据
  • 存储数据
  • 闪存数据
  • 删除数据
  • 重新生成会话 ID
• 会话阻塞
• 添加自定义会话驱动程序
  • 实现驱动程序
  • 注册驱动程序

简介

由于 HTTP 驱动的应用程序是无状态的，因此会话提供了一种跨多个请求存储用户信息的方法。该用户信息通常放置在持久存储/后端中，可以从后续请求中访问。

Laravel 提供多种会话后端，可通过富有表现力的统一 API 访问。支持流行的后端，例如 Memcached、Redis 和数据库。

配置

您的应用程序的会话配置文件存储在 config/session.php 中。请务必查看此文件中可用的选项。默认情况下，Laravel 配置为使用 database 会话驱动程序。

会话 driver 配置选项定义每个请求的会话数据将存储在哪里。Laravel 包括多种驱动程序

驱动程序先决条件

数据库

当使用 database 会话驱动程序时，您需要确保您有一个数据库表来包含会话数据。通常，这包含在 Laravel 的默认 0001_01_01_000000_create_users_table.php 数据库迁移 中；但是，如果出于任何原因您没有 sessions 表，您可以使用 make:session-table Artisan 命令生成此迁移

php artisan make:session-table
 
php artisan migrate

Redis

在 Laravel 中使用 Redis 会话之前，您需要通过 PECL 安装 PhpRedis PHP 扩展，或者通过 Composer 安装 predis/predis 包 (~1.0)。有关配置 Redis 的更多信息，请查阅 Laravel 的 Redis 文档。

与会话交互

检索数据

在 Laravel 中处理会话数据有两种主要方式：全局 session 助手函数和通过 Request 实例。首先，让我们看看如何通过 Request 实例访问会话，该实例可以在路由闭包或控制器方法上进行类型提示。请记住，控制器方法依赖项是通过 Laravel 服务容器 自动注入的

<?php
 
namespace App\Http\Controllers;
 
use Illuminate\Http\Request;
use Illuminate\View\View;
 
class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     */
    public function show(Request $request, string $id): View
    {
        $value = $request->session()->get('key');
 
        // ...
 
        $user = $this->users->find($id);
 
        return view('user.profile', ['user' => $user]);
    }
}

当您从会话中检索项目时，您还可以将默认值作为 get 方法的第二个参数传递。如果会话中不存在指定的键，则将返回此默认值。如果您将闭包作为默认值传递给 get 方法，并且请求的键不存在，则将执行闭包并返回其结果

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

全局会话助手函数

您还可以使用全局 session PHP 函数来检索和存储会话中的数据。当使用单个字符串参数调用 session 助手函数时，它将返回该会话键的值。当使用键/值对数组调用助手函数时，这些值将存储在会话中

Route::get('/home', function () {
    // Retrieve a piece of data from the session...
    $value = session('key');
 
    // Specifying a default value...
    $value = session('key', 'default');
 
    // Store a piece of data in the session...
    session(['key' => 'value']);
});

检索所有会话数据

如果您想检索会话中的所有数据，可以使用 all 方法

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

检索会话数据的一部分

only 和 except 方法可用于检索会话数据的子集

$data = $request->session()->only(['username', 'email']);
 
$data = $request->session()->except(['username', 'email']);

确定会话中是否存在项目

要确定会话中是否存在项目，可以使用 has 方法。如果该项目存在且不为 null，则 has 方法返回 true

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

要确定会话中是否存在项目，即使其值为 null，您也可以使用 exists 方法

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

要确定会话中不存在项目，可以使用 missing 方法。如果该项目不存在，则 missing 方法返回 true

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

存储数据

要将会话中的数据存储，通常您将使用请求实例的 put 方法或全局 session 助手函数

// Via a request instance...
$request->session()->put('key', 'value');
 
// Via the global "session" helper...
session(['key' => 'value']);

将数据推送到数组会话值

push 方法可用于将新值推送到作为数组的会话值上。例如，如果 user.teams 键包含一个团队名称数组，则可以将新值推送到该数组上，如下所示

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

检索和删除项目

pull 方法将在单个语句中检索并删除会话中的项目

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

递增和递减会话值

如果您的会话数据包含您希望递增或递减的整数，则可以使用 increment 和 decrement 方法

$request->session()->increment('count');
 
$request->session()->increment('count', $incrementBy = 2);
 
$request->session()->decrement('count');
 
$request->session()->decrement('count', $decrementBy = 2);

闪存数据

有时您可能希望将会话中的项目存储到下一个请求。您可以使用 flash 方法来实现此目的。使用此方法存储在会话中的数据将立即在后续 HTTP 请求期间可用。在后续 HTTP 请求之后，闪存数据将被删除。闪存数据主要用于短时间的状态消息

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

如果您需要在多个请求之间保留闪存数据，您可以使用 reflash 方法，它会将所有闪存数据保留到下一个请求。如果您只需要保留特定的闪存数据，可以使用 keep 方法。

$request->session()->reflash();
 
$request->session()->keep(['username', 'email']);

要仅为当前请求保留闪存数据，您可以使用 now 方法。

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

删除数据

forget 方法会从会话中删除一条数据。如果您想删除会话中的所有数据，可以使用 flush 方法。

// Forget a single key...
$request->session()->forget('name');
 
// Forget multiple keys...
$request->session()->forget(['name', 'status']);
 
$request->session()->flush();

重新生成会话 ID

重新生成会话 ID 通常是为了防止恶意用户利用 会话固定 攻击您的应用程序。

如果您正在使用 Laravel 应用程序启动套件或 Laravel Fortify，Laravel 会在身份验证期间自动重新生成会话 ID；但是，如果您需要手动重新生成会话 ID，可以使用 regenerate 方法。

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

如果您需要重新生成会话 ID 并在一个语句中删除会话中的所有数据，可以使用 invalidate 方法。

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

会话阻塞

默认情况下，Laravel 允许使用相同会话的请求并发执行。因此，例如，如果您使用 JavaScript HTTP 库向您的应用程序发出两个 HTTP 请求，它们将同时执行。对于许多应用程序来说，这不是问题；但是，在少数同时向两个不同的应用程序端点发出并发请求且两者都向会话写入数据的应用程序中，可能会发生会话数据丢失。

为了缓解这种情况，Laravel 提供了允许您限制给定会话的并发请求的功能。要开始使用，您只需将 block 方法链接到您的路由定义即可。在此示例中，对 /profile 端点的传入请求将获取会话锁。在持有此锁时，任何传入到 /profile 或 /order 端点且共享相同会话 ID 的请求都将等待第一个请求完成执行，然后再继续执行。

Route::post('/profile', function () {
    // ...
})->block($lockSeconds = 10, $waitSeconds = 10)
 
Route::post('/order', function () {
    // ...
})->block($lockSeconds = 10, $waitSeconds = 10)

block 方法接受两个可选参数。block 方法接受的第一个参数是会话锁应保持的最大秒数，之后会被释放。当然，如果请求在此时间之前完成执行，锁将更早释放。

block 方法接受的第二个参数是请求在尝试获取会话锁时应等待的秒数。如果在给定的秒数内请求无法获取会话锁，将抛出 Illuminate\Contracts\Cache\LockTimeoutException 异常。

如果未传递这两个参数，则锁将最多获取 10 秒，并且请求在尝试获取锁时将最多等待 10 秒。

Route::post('/profile', function () {
    // ...
})->block()

添加自定义会话驱动程序

实现驱动程序

如果现有的会话驱动程序都不能满足您应用程序的需求，Laravel 允许您编写自己的会话处理程序。您的自定义会话驱动程序应实现 PHP 内置的 SessionHandlerInterface。此接口只包含几个简单的方法。一个存根的 MongoDB 实现如下所示：

<?php
 
namespace App\Extensions;
 
class MongoSessionHandler 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 不包含用于存放扩展的默认目录。您可以将它们放置在您喜欢的任何位置。在此示例中，我们创建了一个 Extensions 目录来存放 MongoSessionHandler。

由于这些方法的用途不易理解，以下是每个方法用途的概述：

注册驱动程序

一旦您的驱动程序实现完成，您就可以将其注册到 Laravel。要向 Laravel 的会话后端添加其他驱动程序，您可以使用 Session 外观提供的 extend 方法。您应从服务提供者的 boot 方法中调用 extend 方法。您可以从现有的 App\Providers\AppServiceProvider 执行此操作，也可以创建一个全新的提供者。

<?php
 
namespace App\Providers;
 
use App\Extensions\MongoSessionHandler;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Session;
use Illuminate\Support\ServiceProvider;
 
class SessionServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }
 
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Session::extend('mongo', function (Application $app) {
            // Return an implementation of SessionHandlerInterface...
            return new MongoSessionHandler;
        });
    }
}

注册会话驱动程序后，您可以使用 SESSION_DRIVER 环境变量或在应用程序的 config/session.php 配置文件中将 mongo 驱动程序指定为应用程序的会话驱动程序。