Laravel 5.2 中文文档

简体中文

English

简体中文

English

主题

会话 ​

介绍 ​

由于HTTP驱动的应用程序是无状态的，会话提供了一种在请求之间存储用户信息的方法。Laravel提供了多种会话后端，通过一个干净、统一的API可供使用。支持流行的后端如Memcached、Redis和数据库的支持是开箱即用的。

配置 ​

会话配置文件存储在config/session.php中。请务必查看此文件中提供的详细选项。默认情况下，Laravel配置为使用file会话驱动，这对于许多应用程序来说都能很好地工作。在生产应用程序中，您可以考虑使用memcached或redis驱动以获得更快的会话性能。

会话driver定义了每个请求的会话数据将存储在哪里。Laravel开箱即用地提供了几个优秀的驱动：

  • file - 会话存储在storage/framework/sessions中。
  • cookie - 会话存储在安全、加密的cookie中。
  • database - 会话存储在应用程序使用的数据库中。
  • memcached / redis - 会话存储在这些快速的基于缓存的存储中。
  • array - 会话存储在一个简单的PHP数组中，不会在请求之间持久化。
lightbulb

数组驱动通常用于运行测试，以防止会话数据持久化。

驱动先决条件 ​

数据库 ​

使用database会话驱动时，您需要设置一个表来包含会话项。以下是表的Schema声明示例：

php
Schema::create('sessions', function ($table) {
    $table->string('id')->unique();
    $table->integer('user_id')->nullable();
    $table->string('ip_address', 45)->nullable();
    $table->text('user_agent')->nullable();
    $table->text('payload');
    $table->integer('last_activity');
});

您可以使用session:table Artisan命令为您生成此迁移！

php
php artisan session:table

composer dump-autoload

php artisan migrate

Redis ​

在使用Laravel的Redis会话之前，您需要通过Composer安装predis/predis包（~1.0）。

其他会话注意事项 ​

Laravel框架内部使用flash会话键，因此您不应通过该名称向会话添加项。

如果您需要加密所有存储的会话数据，请将encrypt配置选项设置为true。

基本用法 ​

访问会话 ​

首先，让我们访问会话。我们可以通过HTTP请求访问会话实例，可以在控制器方法中进行类型提示。请记住，控制器方法依赖项是通过Laravel服务容器注入的：

php
<?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');

        //
    }
}

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

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

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

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

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

您还可以使用全局session PHP函数在会话中检索和存储数据：

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

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

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

has方法可用于检查会话中是否存在某项。如果该项存在，此方法将返回true：

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

在会话中存储数据 ​

一旦您访问了会话实例，您可以调用各种函数来与底层数据进行交互。例如，put方法在会话中存储一条新数据：

php
$request->session()->put('key', 'value');

推送到数组会话值 ​

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

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

检索并删除某项 ​

pull方法将从会话中检索并删除某项：

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

从会话中删除项 ​

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

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

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

重新生成会话ID ​

如果您需要重新生成会话ID，可以使用regenerate方法：

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

闪存数据 ​

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

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

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

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

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

添加自定义会话驱动 ​

要向Laravel的会话后端添加其他驱动，您可以在Sessionfacade上使用extend方法。您可以从服务提供者的boot方法中调用extend方法：

php
<?php

namespace App\Providers;

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

class SessionServiceProvider extends ServiceProvider
{
    /**
     * 执行服务的注册后引导。
     *
     * @return void
     */
    public function boot()
    {
        Session::extend('mongo', function($app) {
            // 返回SessionHandlerInterface的实现...
            return new MongoSessionStore;
        });
    }

    /**
     * 在容器中注册绑定。
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

请注意，您的自定义会话驱动应实现SessionHandlerInterface。此接口仅包含几个简单的方法需要我们实现。一个存根的MongoDB实现看起来像这样：

php
<?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方法通常用于基于文件的会话存储系统。由于Laravel附带了一个file会话驱动，您几乎不需要在此方法中放置任何内容。您可以将其留为空存根。这只是一个糟糕的接口设计的事实（我们稍后会讨论），PHP要求我们实现此方法。
  • close方法，像open方法一样，通常也可以忽略。对于大多数驱动，它是不需要的。
  • read方法应返回与给定$sessionId关联的会话数据的字符串版本。在检索或存储会话数据时，您的驱动中不需要进行任何序列化或其他编码，因为Laravel会为您执行序列化。
  • write方法应将与$sessionId关联的给定$data字符串写入某个持久存储系统，例如MongoDB、Dynamo等。
  • destroy方法应从持久存储中删除与$sessionId关联的数据。
  • gc方法应销毁所有比给定$lifetime（UNIX时间戳）更旧的会话数据。对于自我过期系统如Memcached和Redis，此方法可以留空。

一旦会话驱动注册，您可以在config/session.php配置文件中使用mongo驱动。

版权所有 © 2024-2025 laravel.wiki