session

Documentation

Overview

Package session SESSION 管理

Index

• func DelValue[T any](ctx *web.Context) error
• func GetValue[T any](ctx *web.Context) (*T, error)
• func New[T any](store Store[T], lifetime int, name, path, domain string, secure, httpOnly bool) web.Middleware
• func SetValue[T any](ctx *web.Context, val *T) error
• type Store
  • func NewCacheStore[T any](c web.Cache, ttl time.Duration) Store[T]

Functions

func DelValue

func DelValue[T any](ctx *web.Context) error

DelValue 删除 session 中保存的值

func GetValue

func GetValue[T any](ctx *web.Context) (*T, error)

GetValue 获取当前对话关联的信息

func New

func New[T any](store Store[T], lifetime int, name, path, domain string, secure, httpOnly bool) web.Middleware

New 声明 Session 中间件

lifetime 为 session 的有效时间，单位为秒；其它参数为 cookie 的相关设置。

func SetValue

func SetValue[T any](ctx *web.Context, val *T) error

SetValue 更新 session 保存的值

Types

type Store

type Store[T any] interface {
	// Delete 删除指定 id 的 session
	Delete(id string) error

	// Get 查找指定 id 的 session
	//
	// 如果不存在，则返回零值，并将该零值保存到当前对象。
	Get(id string) (*T, error)

	// Set 更新指定 id 的 session
	Set(id string, v *T) error
}

Store session 的存储接口

func NewCacheStore

func NewCacheStore[T any](c web.Cache, ttl time.Duration) Store[T]

NewCacheStore 以 web.Cache 作为 session 的存储系统