HTTP层 —— Session

 

1、简介

由于HTTP驱动的应用是无状态的，所以我们使用Session来存储用户请求信息。Laravel通过干净、统一的API处理后端各种Session驱动，目前支持的流行后端驱动包括Memcached、Redis和数据库。

配置

Session配置文件位于config/session.php。默认情况下，Laravel使用的session驱动为文件驱动，这对许多应用而言是没有什么问题的。在生产环境中，你可能考虑使用memcached或者redis驱动以便获取更快的session性能。

session驱动定义请求的Session数据存放在哪里，Laravel可以处理多种类型的驱动：

• file – session数据存储在 storage/framework/sessions目录下；
• cookie – session数据存储在经过加密的安全的cookie中；
• database – session数据存储在数据库中
• memcached / redis – session数据存储在memcached/redis中；
• array – session数据存储在简单PHP数组中，在多个请求之间是非持久化的。

注意：数组驱动通常用于运行测试以避免session数据持久化。

Session驱动预备知识

数据库

当使用databasesession驱动时，需要设置表包含session项，下面是该数据表的表结构声明：

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');
});

你可以使用Artisan命令session:table来生成迁移：

php artisan session:table
php artisan migrate

Redis

在Laravel中使用Redis作为 session驱动前，需要通过Composer安装predis/predis包。可以在database配置文件中配置Redis连接，在session配置文件中，database选项用于指定session使用哪一个redis连接。

2、使用Session

获取数据

在Laravel中主要有两种方式处理Session数据：全局的辅助函数session，或者通过Request实例。首先，我们通过Request实例来访问Session数据，可以在控制器方法中通过类型提示引入该实例，记住，控制器方法依赖通过Laravel服务容器自动注入：

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;
use AppHttpControllersController;

class UserController extends Controller{
    /**
     * 显示指定用户的属性
     *
     * @param  Request  $request
     * @param  int  $id
     * @return Response
     */
    public function showProfile(Request $request, $id)
    {
        $value = $request->session()->get('key');

        //
    }
}

从session中获取数据的时候，还可以传递默认值作为第二个参数到get方法，默认值在指定键在session中不存在时返回。如果你传递一个闭包作为默认值到get方法，该闭包会执行并返回执行结果：

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

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

全局辅助函数session

还可以使用全局的PHP函数session来获取和存储session中的数据，如果只传递一个字符串参数到session方法，则返回该session key对应的值；如果传递的参数是key/value键值对数组，则将这些数据保存到session：

Route::get('home', function () {
    // 从session中获取数据...
    $value = session('key');
    // 指定默认值...
    $value = session('key', 'default');
    // 存储数据到session...
    session(['key' => 'value']);
});

注：通过HTTP请求实例和辅助函数session处理数据并无实质性差别，这两个方法在测试用例中都可以通过assertSessionHas方法进行测试。

获取所有Session值

如果你想要从session中获取所有数据，可以使用all方法：

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

判断session中是否存在指定项

has方法可用于检查数据项在session中是否存在。如果存在并且不为null的话返回true：

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

要判断某个值在session中是否存在，即使是null的话也无所谓，则可以使用exists方法。如果值存在的话exists返回true：

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

存储数据

获取到session实例后，就可以调用多个方法来与底层数据进行交互，例如，put方法存储新的数据到session中：

//通过put方法
$request->session()->put('key', 'value');

//通过全局辅助函数
session(['key' => 'value']);

推送数据到数组session

push 方法可用于推送数据到值为数组的session，例如，如果user.teams键包含团队名数组，可以像这样推送新值到该数组：

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

获取并删除数据

pull方法将会从session获取并删除数据：

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

一次性数据

有时候你可能想要在session中存储只在下个请求中有效的数据，可以通过flash方法来实现。使用该方法存储的session数据只在随后的HTTP请求中有效，然后将会被删除：

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

如果你需要在更多请求中保持该一次性数据，可以使用reflash方法，该方法将所有一次性数据保留到下一个请求，如果你只是想要保存特定一次性数据，可以使用keep方法：

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

删除数据

forget方法从session中移除指定数据，如果你想要从session中移除所有数据，可以使用flush方法：

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

重新生成Session ID

重新生成Session ID经常用于阻止恶意用户对应用进行session fixation攻击（关于session fixation 攻击可参考这篇文章：http://www.360doc.com/content/11/1028/16/1542811_159889635.shtml）。

如果你使用内置的LoginController的话，Laravel会在认证期间自动重新生成session id，如果你需要手动重新生成session ID，可以使用regenerate方法：

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

3、添加自定义Session驱动

实现驱动

自定义session驱动需要实现SessionHandlerInterface接口，该接口包含少许我们需要实现的方法，比如一个MongoDB的实现如下：

<?php

namespace AppExtensions;

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) {}
}

注：Laravel默认并没有附带一个用于包含扩展的目录，你可以将扩展放置在任何地方，这里我们创建一个Extensions目录用于存放MongoHandler。

由于这些方法并不是很容易理解，所以我们接下来快速过一遍每一个方法：

• open 方法用于基于文件的session存储系统，由于Laravel已经有了一个 file session 驱动，所以在该方法中不需要放置任何代码，可以将其置为空方法。
• close 方法和open 方法一样，也可以被忽略，对大多数驱动而言都用不到该方法。
• read 方法应该返回与给定$sessionId 相匹配的session数据的字符串版本，从驱动中获取或存储session数据不需要做任何序列化或其它编码，因为Laravel已经为我们做了序列化。
• write 方法应该讲给定$data 写到持久化存储系统相应的$sessionId , 例如MongoDB, Dynamo等等。
• destroy 方法从持久化存储中移除 $sessionId 对应的数据。
• gc 方法销毁大于给定$lifetime 的所有 session数据，对本身拥有过期机制的系统如 Memcached 和Redis而言，该方法可以留空。

注册驱动

驱动被实现后，需要准备将其注册到框架，要添加额外驱动到Laravel session后端，可以使用Session门面上的extend方法。我们在服务提供者的boot方法中调用该方法：

<?php

namespace AppProviders;

use AppExtensionsMongoSessionStore;
use IlluminateSupportFacadesSession;
use IlluminateSupportServiceProvider;

class SessionServiceProvider extends ServiceProvider
{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Session::extend('mongo', function($app) {
            // Return implementation of SessionHandlerInterface...
            return new MongoSessionStore;
        });
    }

    /**
     * Register bindings in the container.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

session驱动被注册之后，就可以在配置文件config/session.php中使用mongo 驱动了。