会话

引言

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

Laravel 附带了各种会话后端，它们通过一个富有表现力、统一的 API 进行访问。其中包括对 Memcached、Redis 和数据库等流行后端的支持。

配置

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

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

• file - 会话存储在 storage/framework/sessions 中。
• cookie - 会话存储在安全的加密 cookie 中。
• database - 会话存储在关系数据库中。
• memcached / redis - 会话存储在这些快速的、基于缓存的存储之一中。
• dynamodb - 会话存储在 AWS DynamoDB 中。
• array - 会话存储在 PHP 数组中，并且不会被持久化。

驱动程序先决条件

数据库

当使用 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 () {
    // 从会话中检索一条数据...
    $value = session('key');

    // 指定一个默认值...
    $value = session('key', 'default');

    // 在会话中存储一条数据...
    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 辅助函数：

// 通过请求实例...
$request->session()->put('key', 'value');

// 通过全局“session”辅助函数...
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 方法：

// 忘记单个键...
$request->session()->forget('name');

// 忘记多个键...
$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。

由于这些方法的目的不是很容易理解，以下是每种方法的目的概述：

• open 方法通常用于基于文件的会话存储系统。由于 Laravel 附带了 file 会话驱动程序，因此您很少需要在该方法中放入任何内容。您可以简单地将此方法留空。
• close 方法，与 open 方法一样，通常也可以忽略。对于大多数驱动程序，它是不需要的。
• read 方法应返回与给定 $sessionId 关联的会话数据的字符串版本。在您的驱动程序中检索或存储会话数据时，无需进行任何序列化或其他编码，因为 Laravel 将为您执行序列化。
• write 方法应将与 $sessionId 关联的给定 $data 字符串写入某个持久存储系统，例如 MongoDB 或您选择的另一个存储系统。同样，您不应执行任何序列化 - Laravel 将为您处理。
• destroy 方法应从持久存储中删除与 $sessionId 关联的数据。
• gc 方法应销毁所有比给定 $lifetime（一个 UNIX 时间戳）更旧的会话数据。对于像 Memcached 和 Redis 这样的自过期系统，此方法可以留空。

注册驱动程序

一旦您的驱动程序已实现，您就可以将其注册到 Laravel。要向 Laravel 的会话后端添加额外的驱动程序，您可以使用 Session facade 提供的 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 驱动程序指定为您的应用程序的会话驱动程序。