[ Lumen 5.1 文档 ] 更多特性 —— Session

1、简介

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

1.1 开启Session

要开启session,你需要取消bootstrap/app.php文件中$app->middleware()方法调用前的注释。

1.2 配置

session驱动由.env文件中的配置选项SESSION_DRIVER来控制。默认情况下,Lumen使用的session驱动为memcached,这对许多应用而言是没有什么问题的。在生产环境中,你可以考虑使用memcached或者redis驱动以便获取更快的session性能。

session驱动定义请求的session数据存放在哪里,Lumen可以处理多种类型的驱动:

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

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

1.3 Session驱动预备知识

数据库

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

Schema::create('sessions', function ($table) {
    $table->string('id')->unique();
    $table->text('payload');
    $table->integer('last_activity');
});

Redis

在Lumen中使用Redis session驱动前,需要通过Composer安装predis/predis包以及illuminate/redis包。

1.4 其它Session相关问题

Lumen框架内部使用flash session键,所以你不应该通过该名称添加数据项到session。

2、基本使用

访问session

首先,我们来访问session,我们可以通过HTTP请求访问session实例,可以在控制器方法中通过类型提示引入请求实例,记住,控制器方法依赖通过Lumen服务容器注入:

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

        //
    }
}

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

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

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

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

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

还可以使用全局的PHP函数session来获取和存储session中的数据:

$app->get('home', function () {
    // 从session中获取数据...
    $value = session('key');

    // 存储数据到session...
    session(['key' => 'value']);
});

判断session中是否存在指定项

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

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

在session中存储数据

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

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

推送数据到数组session

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

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

获取并删除数据

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

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

从session中删除数据项

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

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

重新生成Session ID

如果你需要重新生成session ID,可以使用regenerate方法:

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

2.1 一次性数据

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

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

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

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

学院君

学院君 has written 548 articles

资深PHP工程师,Laravel学院院长