Skip to main content
Version: Latest

GoFrame 框架提供了完善的 Session 管理能力，由 gsession 组件实现。由于 Session 机制在 HTTP 服务中最常用，因此后续章节中将着重以 HTTP 服务为示例介绍 Session 的使用。

基本介绍​

接口文档： https://pkg.go.dev/github.com/gogf/gf/v2/os/gsession

任何时候都可以通过 ghttp.Request 获取 Session 对象，因为 Cookie 和 Session 都是和请求会话相关，因此都属于 Request 的成员对象，并对外公开。 GoFrame 框架的 Session 默认过期时间是 24小时。

SessionId 默认通过 Cookie 来传递，并且也支持客户端通过 Header 传递 SessionId， SessionId 的识别名称可以通过 ghttp.Server 的 SetSessionIdName 进行修改。 Session 的操作是支持 并发安全 的，这也是框架在对 Session 的设计上不采用直接以 map 的形式操作数据的原因。在 HTTP 请求流程中，我们可以通过 ghttp.Request 对象来获取 Session 对象，并执行相应的数据操作。

此外， ghttp.Server 中的 SessionId 使用的是客户端的 RemoteAddr + Header 请求信息通过 guid 模块来生成的，保证随机及唯一性： https://github.com/gogf/gf/blob/master/net/ghttp/ghttp_request.go

gsession 模块​

Session 的管理功能由独立的 gsession 模块实现，并已完美整合到了 ghttp.Server 中。由于该模块是解耦独立的，因此可以应用到更多不同的场景中，例如： TCP 通信、 gRPC 接口服务等等。在 gsession 模块中有比较重要的三个对象/接口：

  1. gsession.Manager：管理 Session 对象、 Storage 持久化存储对象、以及过期时间控制。
  2. gsession.Session：单个 Session 会话管理对象，用于 Session 参数的增删查改等数据管理操作。
  3. gsession.Storage：这是一个接口定义，用于 Session 对象的持久化存储、数据写入/读取、存活更新等操作，开发者可基于该接口实现自定义的持久化存储特性。 该接口定义详见： https://github.com/gogf/gf/blob/master/os/gsession/gsession_storage.go

存储实现方式​

gsession 实现并为开发者提供了常见的四种 Session 存储实现方式：

Storage支持分布式支持持久化内存占用执行效率简要介绍
StorageFile否是中中基于文件存储（默认）。单节点部署方式下比较高效的持久化存储方式： Session-File
StorageMemory否否高高基于纯内存存储。单节点部署，性能最高效，但是无法持久化保存，重启即丢失： Session-Memory
StorageRedis是是中中基于 Redis 存储（ Key-Value）。远程 Redis 节点存储 Session 数据，支持应用多节点部署： Session-Redis-KeyValue
StorageRedisHashTable是是低低基于 Redis 存储（ HashTable）。远程 Redis 节点存储 Session 数据，支持应用多节点部署： Session-Redis-HashTable

四种方式各有优劣，详细介绍请查看对应章节。

Session 的初始化​

以常见的HTTP请求为例。 ghttp.Request 中的 Session 对象采用了" 懒初始化( LazyInitialization)"设计方式，默认在 Request 中有一个 Session 属性对象，但是并未初始化（一个空对象），只有在使用 Session 属性对象的方法时才会真正执行初始化。这样的设计既保障了未使用 Session 特性的请求执行性能，也保证了组件使用的易用性。

Session 的销毁/注销​

用户 Session 不再使用，例如用户注销登录状态，需要从存储中硬删除，那么可以调用 RemoveAll 方法。

相关文档​