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

在使用 Redis 会话与 Laravel 之前，您需要通过 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。要向 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 驱动程序作为您的应用程序的会话驱动程序。