Session · tp5文档

# 会话 `ThinkPHP5.0`使用`think\Session`类进行`Session`的操作管理。 - - [Session初始化](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#-code-session-code-) - [读取Session](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#-code-session-code--1) - [SESSION操作](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#-code-session-code--2) - [助手函数](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#u52A9u624Bu51FDu6570) - [模板输出](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#u6A21u677Fu8F93u51FA) - [Session驱动](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#-code-session-code--3) - [Session示例](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/183828#session-) ## `Session`初始化大多数情况，我们不需要手动进行Session初始化操作。`ThinkPHP5`会在第一次调用`Session`类的时候按照配置的参数自动初始化和开启`Session`（如果`auto_start`设置为`true`的话），例如，我们在应用配置中添加如下配置： ``` <pre class="calibre18"> ``` 'session' => [ 'prefix' => 'think', 'type' => '', 'auto_start' => true, ], ``` ``` 无需任何操作就可以直接调用`Session`类的相关方法，例如： ``` <pre class="calibre18"> ``` Session::set('name','thinkphp'); Session::get('name'); ``` ``` 如果你的应用不同模块需要不同的`session`配置参数，那么可以在模块配置文件中重新设置： ``` <pre class="calibre18"> ``` 'session' => [ 'prefix' => 'module', 'type' => '', 'auto_start' => true, ], ``` ``` 或者在模块的公共文件中调用`init`方法进行初始化： ``` <pre class="calibre18"> ``` Session::init([ 'prefix' => 'module', 'type' => '', 'auto_start' => true, ]); ``` ``` > 如果你没有使用Session类进行Session操作的话，例如直接操作`$_SESSION`,必须使用上面的方式手动初始化或者直接调用`session_start()`方法进行`session`初始化，但不建议直接操作`$_SESSION`全局变量。 ## 读取`Session` 建议的读取`Session`数据的方法是通过`Request`请求对象的`session`方法，例如： ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Request; class User{ public function index(Request $request){ echo $request->session('user_name'); // 读取二维数组echo $request->session('user.name'); } } ``` ``` > 通过Request对象读取Session数据支持默认值及过滤方法，因此也更加安全，并且支持多维数组的读取。当然也支持使用`Session`类直接读取数据： ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Session; class User{ public function index(){ echo Session::get('user_name'); echo Session::get('user.name'); } } ``` ``` > `Session`类的`get`方法只支持最大二维数组的读取，而`Request`对象的`session`方法可以支持任意级别的二维数组获取。 ## `SESSION`操作使用`think\Session`类进行`Session`的操作和管理，例如： ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Session; class User{ public function index(){ // 赋值（当前作用域） Session::set('name','thinkphp'); // 赋值think作用域 Session::set('name','thinkphp','think'); // 判断（当前作用域）是否赋值 Session::has('name'); // 判断think作用域下面是否赋值 Session::has('name','think'); // 取值（当前作用域） Session::get('name'); // 取值think作用域 Session::get('name','think'); // 指定当前作用域 Session::prefix('think'); // 删除（当前作用域） Session::delete('name'); // 删除think作用域下面的值 Session::delete('name','think'); // 清除session（当前作用域） Session::clear(); // 清除think作用域 Session::clear('think'); // 赋值（当前作用域） Session::set('name.item','thinkphp'); // 判断（当前作用域）是否赋值 Session::has('name.item'); // 取值（当前作用域） Session::get('name.item'); // 删除（当前作用域） Session::delete('name.item'); } } ``` ``` ## 助手函数系统也提供了助手函数`session`完成相同的功能，例如： ``` <pre class="calibre18"> ``` // 初始化session session([ 'prefix' => 'module', 'type' => '', 'auto_start' => true, ]); // 赋值（当前作用域） session('name', 'thinkphp'); // 赋值think作用域 session('name', 'thinkphp', 'think'); // 判断（当前作用域）是否赋值 session('?name'); // 取值（当前作用域） session('name'); // 取值think作用域 session('name', '', 'think'); // 删除（当前作用域） session('name', null); // 清除session（当前作用域） session(null); // 清除think作用域 session(null, 'think'); ``` ``` ## 模板输出如果需要在模板中输出Session数据，可以使用下面的方法： ``` <pre class="calibre18"> ``` {$Request.session.user_name} ``` ``` 也可以支持二维数组的输出 ``` <pre class="calibre18"> ``` {$Request.session.user.name} ``` ``` ## `Session`驱动支持指定 Session 驱动，配置文件如下： ``` <pre class="calibre18"> ``` 'session' => [ 'prefix' => 'module', 'type' => 'redis', 'auto_start' => true, // redis主机'host' => '127.0.0.1', // redis端口'port' => 6379, // 密码'password' => '', ] ``` ``` 表示使用`redis`作为`session`类型。 ## Session示例下面举一个例子。 ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Controller; use think\Session; class Index extends Controller{ public function index(){ return $this->fetch(); } public function save($name=''){ Session::set('user_name',$name); $this->success('Session设置成功'); } } ``` ``` 定义默认文件（`application/index/view/index.html`）如下： ``` <pre class="calibre18"> ``` <!doctype html><html><head><meta charset="UTF-8"><title>Session示例</title><style>body { font-family:"Microsoft Yahei","Helvetica Neue",Helvetica,Arial,sans-serif; font-size:16px; padding:5px; }.form{ padding: 15px; font-size: 16px; }.form .text { padding: 3px; margin:2px 10px; width: 240px; height: 24px; line-height: 28px; border: 1px solid #D4D4D4; }.form .btn{ margin:6px; padding: 6px; width: 120px; font-size: 16px; border: 1px solid #D4D4D4; cursor: pointer; background:#eee; }a{ color: #868686; cursor: pointer; }a:hover{ text-decoration: underline; } h2{ color: #4288ce; font-weight: 400; padding: 6px 0; margin: 6px 0 0; font-size: 28px; border-bottom: 1px solid #eee; }div{ margin:8px; }.info{ padding: 12px 0; border-bottom: 1px solid #eee; }.copyright{ margin-top: 24px; padding: 12px 0; border-top: 1px solid #eee; }</style></head><body><h2>Session示例</h2><FORM method="post" class="form" action="{:url('save')}"> 输入用户名：<INPUT type="text" class="text" name="name" value="{$Request.session.user_name}" ><br/><INPUT type="submit" class="btn" value=" 保存 "></FORM><div class="copyright"><a title="官方网站" href="http://www.thinkphp.cn">ThinkPHP</a><span>V5</span><span>{ 十年磨一剑-为API开发设计的高性能框架 }</span></div></body></html> ``` ``` 访问URL地址 ``` <pre class="calibre18"> ``` http: //tp5.com ``` ``` 页面显示： ![](https://img.kancloud.cn/72/a9/72a9358252fa6474c57dead184765658_488x233.png) 当我们输入`ThinkPHP`后点击保存按钮 ![](https://img.kancloud.cn/2a/24/2a24bc6e237eb2435e6b3ce5d0ceb6f3_472x235.png) ![](https://img.kancloud.cn/1b/7a/1b7ac9abe7c49038bf5116d33639b142_392x234.png) 然后页面后用户名输入框中会显示已经保存的`session`值。 ![](https://img.kancloud.cn/2a/24/2a24bc6e237eb2435e6b3ce5d0ceb6f3_472x235.png)