Laravel 12.x 中文文档

简体中文

English

简体中文

English

主题

虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待

HTTP 会话 ​

介绍 ​

由于 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 数组中，不会被持久化。

NOTE

数组驱动程序主要用于 测试，并防止存储在会话中的数据被持久化。

驱动程序先决条件 ​

数据库 ​

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

shell
php artisan make:session-table

php artisan migrate

Redis ​

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

NOTE

SESSION_CONNECTION 环境变量或 session.php 配置文件中的 connection 选项可用于指定用于会话存储的 Redis 连接。

与会话交互 ​

检索数据 ​

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

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * 显示给定用户的个人资料。
     */
    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 方法，并且请求的键不存在，则将执行闭包并返回其结果：

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

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

全局会话助手 ​

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

php
Route::get('/home', function () {
    // 从会话中检索一条数据...
    $value = session('key');

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

    // 在会话中存储一条数据...
    session(['key' => 'value']);
});

NOTE

在 HTTP 请求实例中使用会话与使用全局 session 助手之间几乎没有实际区别。两种方法都可以通过 assertSessionHas 方法进行 测试，该方法在所有测试用例中可用。

检索所有会话数据 ​

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

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

检索部分会话数据 ​

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

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

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

确定会话中是否存在项目 ​

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

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

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

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

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

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

存储数据 ​

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

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

// 通过全局 "session" 助手...
session(['key' => 'value']);

推送到数组会话值 ​

push 方法可用于将新值推送到会话值的数组中。例如，如果 user.teams 键包含一个团队名称数组，可以像这样将新值推送到数组中：

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

检索并删除项目 ​

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

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

增加和减少会话值 ​

如果您的会话数据包含一个希望增加或减少的整数，可以使用 increment 和 decrement 方法：

php
$request->session()->increment('count');

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

$request->session()->decrement('count');

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

闪存数据 ​

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

php
$request->session()->flash('status', '任务成功完成！');

如果您需要将闪存数据保留多个请求，可以使用 reflash 方法，这将保留所有闪存数据以供额外请求使用。如果只需要保留特定的闪存数据，可以使用 keep 方法：

php
$request->session()->reflash();

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

要仅在当前请求中保留闪存数据，可以使用 now 方法：

php
$request->session()->now('status', '任务成功完成！');

删除数据 ​

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

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

// 忘记多个键...
$request->session()->forget(['name', 'status']);

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

重新生成会话 ID ​

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

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

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

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

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

会话缓存 ​

Laravel 的会话缓存提供了一种方便的方式来缓存限定于单个用户会话的数据。与全局应用缓存不同，会话缓存数据会在每个会话中自动隔离，并在会话过期或被销毁时清理。会话缓存支持所有熟悉的 Laravel 缓存方法，如 get、put、remember、forget 等，但其作用域限定为当前会话。

会话缓存非常适合存储临时的、特定用户的数据，这些数据需要在同一会话的多个请求之间持久化，但不需要永久保存。这包括表单数据、临时计算结果、API 响应，或任何其他应与特定用户会话绑定的短暂数据。

你可以通过会话上的 cache 方法访问会话缓存：

php
$discount = $request->session()->cache()->get('discount');

$request->session()->cache()->put(
    'discount', 10, now()->addMinutes(5)
);

关于 Laravel 缓存方法的更多信息，请参阅缓存文档。

会话阻塞 ​

WARNING

要使用会话阻塞，您的应用程序必须使用支持 原子锁 的缓存驱动程序。目前，这些缓存驱动程序包括 memcached、dynamodb、redis、mongodb（包含在官方的 mongodb/laravel-mongodb 包中）、database、file 和 array 驱动程序。此外，您不能使用 cookie 会话驱动程序。

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

为了解决这个问题，Laravel 提供了允许您限制给定会话的并发请求的功能。要开始，您可以简单地将 block 方法链接到您的路由定义中。在此示例中，对 /profile 端点的传入请求将获取会话锁。在此锁定期间，任何对共享相同会话 ID 的 /profile 或 /order 端点的传入请求将等待第一个请求完成执行后再继续执行：

php
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 秒：

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

添加自定义会话驱动程序 ​

实现驱动程序 ​

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

php
<?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 的会话数据，该 $lifetime 是一个 UNIX 时间戳。对于自我过期系统，如 Memcached 和 Redis，此方法可以留空。

注册驱动程序 ​

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

php
<?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
{
    /**
     * 注册任何应用程序服务。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 启动任何应用程序服务。
     */
    public function boot(): void
    {
        Session::extend('mongo', function (Application $app) {
            // 返回 SessionHandlerInterface 的实现...
            return new MongoSessionHandler;
        });
    }
}

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

版权所有 © 2024-2025 laravel.wiki