官方文档
https://github.com/gin-contrib/sessions
session概述
一般PC 端网站开发都会谈到Session，服务端开启Session机制，客户端在第一次访问服务端时，服务端会生成sessionId通过cookie 机制回传到客户端保存，之后每次客户端访问服务端时都会通过cookie机制带sessionId到服务端，服务端通过解析SessionID找到请求的Session会话信息；
Session信息都是保存在服务器中的，类似：SessionID : session信息；至于session信息具体内容是什么，这个要根据具体的业务逻辑来确定，但是普遍是用户信息；
服务端保存Session的方式很多：文件，缓存，数据库等，所以衍生出来的session的载体也有很多：redis，文件，mysql，memcached 等等；其中每一种载体都有着自己的优劣，根据不同的业务场景可以选取合适的载体；
gin 中的session
gin中Session的实现主要依赖于Gin-session中间件实现，通过注入不同的 store 从而实现不同的载体保存Session信息 ：
简单例子
创建一个新的store并将中间件注入到gin的路由器中。需要使用的时候在HandlerFunc内部用 sessions.Default(c)即可获取到session
// 创建载体方式对象（cookie-based）
store := cookie.NewStore([]byte("secret"))
// 路由引用
r.Use(sessions.Sessions("sessionId", store))
r.GET("/hello", func(c *gin.Context) {
// 获取session信息
session := sessions.Default(c)
if session.Get("hello") != "world" {
session.Set("hello", "world")
session.Save()
}
....
})
redis存储session
配置文件
[redis]
Host = 1.1.1.1:3679
Password = xxxxx
DB = 10
MaxIdle = 10
maxActive = 100
IdleTimeout = 60
[app]
; 主域名 用来设置cookie
SessionCookieDomain = .test.com
; session 有效时间 单位 天
SessionExpTime = 3
SessionCookieName = test_session
SessionRedisPrefix = test_session:
redis连接池初始化
package redis
import (
"encoding/json"
"github.com/gomodule/redigo/redis"
"time"
"user-center/pkg/setting"
)
var RedisPool *redis.Pool
func Setup() {
RedisPool = &redis.Pool{
MaxIdle: setting.RedisSetting.MaxIdle,
MaxActive: setting.RedisSetting.MaxActive,
IdleTimeout: setting.RedisSetting.IdleTimeout,
Dial: func() (redis.Conn, error) {
c, err := redis.Dial("tcp", setting.RedisSetting.Host)
if err != nil {
return nil, err
}
if setting.RedisSetting.Password != "" {
if _, err = c.Do("AUTH", setting.RedisSetting.Password); err != nil {
c.Close()
return nil, err
}
}
if _, err = c.Do("SELECT", setting.RedisSetting.DB); err != nil {
c.Close()
return nil, err
}
return c, err
},
TestOnBorrow: func(c redis.Conn, t time.Time) error {
_, err := c.Do("PING")
return err
},
}
}
redis初始化载体
package session
import (
"encoding/gob"
"github.com/gin-contrib/sessions"
sessionRedis "github.com/gin-contrib/sessions/redis"
"go.uber.org/zap"
"net/http"
"os"
"time"
"user-center/pkg/logger"
"user-center/pkg/redis"
"user-center/pkg/setting"
)
type Store interface {
sessions.Store
}
type SessionUserInfo struct {
ID uint `json:"id"`
Username string `json:"username"`
PhoneNumber string `json:"phone_number"`
}
var SessionStore Store
func Setup() {
// gob 注册被序列化的类型
// 需要注册进来后面跨路由才可以获取到这个数据
gob.Register(SessionUserInfo{})
SessionStore, _ = sessionRedis.NewStoreWithPool(redis.RedisPool, []byte{})
// 配置session
SessionStore.Options(sessions.Options{
MaxAge: 60 * 60 * 24 * setting.AppSetting.SessionExpTime,
HttpOnly: true,
Secure: false,
Path: "/",
Domain: setting.AppSetting.SessionCookieDomain,
SameSite: http.SameSiteLaxMode,
})
err, store := sessionRedis.GetRedisStore(SessionStore)
if err != nil {
logger.Logger.Error("SessionStore SetKeyPrefix Error: ", zap.Error(err))
os.Exit(1)
}
store.SetMaxLength(4096 * 2)
store.SetKeyPrefix(setting.AppSetting.SessionRedisPrefix)
}
router添加session中间件
c InitRouter() *gin.Engine {
// 设置运行模式
gin.SetMode(setting.ServerSetting.RunMode)
// 生成引擎
r := gin.New()
// 配置 session cookie 名称并使用session中间件
r.Use(sessions.Sessions(setting.AppSetting.SessionCookieName, session.SessionStore))
}
写入session
// 设置session 账户信息,一般登录成功后设置session信息
sessionUserInfo := &session.SessionUserInfo{
ID: obj.ID,
Username: obj.Username,
DisplayName: obj.DisplayName,
PhoneNumber: obj.PhoneNumber,
UpdatedAt: obj.UpdatedAt,
LastLoginAt: obj.LastLoginAt,
}
s := sessions.Default(c)
s.Set("userInfo", sessionUserInfo)
err := s.Save()
fmt.Println(err.Error())
获取session信息
s := sessions.Default(c)
sessionUserInfo := s.Get("userInfo").(session.SessionUserInfo)
清除session信息
s := sessions.Default(c)
// 清除session信息
s.Options(sessions.Options{
MaxAge: -1,
HttpOnly: true,
Secure: false,
Path: "/",
Domain: setting.AppSetting.SessionCookieDomain,
SameSite: http.SameSiteLaxMode,
})
s.Clear()
err := s.Save()
fmt.Println(err.Error())
redis里的session
image.png
