Sa-TokenSa-Token
主题
首页文档博客
视频
乐之者java(登录认证/权限管理/apiKey等)抓蛙师(23集)朱老师的小课堂(7集)王清江唷 SSO篇(29集)fox说技术(7集)架构驿站(11集)王清江唷(99集)筑梦信仰-joy(20集)达达-Java(26集)晒太阳的盐(22集)[ + 课程提交 ]
案例
Gitee - Awesome-Sa-TokenGitHub - Awesome-Sa-TokenAtomGit - Awesome-Sa-Token
加群需求提交赞助🔥 SSO/OAuth2 商业版
安全推荐
开发者安全 ChecklistAPI 安全 Checklist腾讯代码安全指南Web 安全学习笔记OWASP Cheat Sheet SeriesPayloadsAllTheThings
相关资源
更新日志常见报错推荐公众号在线考试在线提问问卷调查
  • 开始

    • 框架介绍
    • 在 SpringBoot 环境集成
    • 在 WebFlux 环境集成
    • 在 Solon 环境集成
    • 其它环境集成示例
    • 源码运行指南
    • Sa-Token 集成示例大全下载
  • 基础

    • 登录认证
    • 权限认证
    • 踢人下线
    • 注解鉴权
    • 路由拦截鉴权
    • Session会话
    • 框架配置
  • 深入

    • 集成 Redis
    • 前后端分离
    • 自定义 Token 风格
    • Token 提交前缀
    • 同端互斥登录
    • 记住我模式
    • 登录参数 & 注销参数
    • 二级认证
    • 模拟他人 & 身份切换
    • 账号封禁
    • 密码加密
    • 会话查询
    • Http Basic/Digest 认证
    • 全局侦听器
    • 全局过滤器
    • 多账号认证
  • 单点登录

    • 单点登录简述
    • 搭建统一认证中心:SSO-Server
    • SSO-Server 认证中心开放 API 接口
    • SSO模式一 共享Cookie同步会话
    • SSO模式二 URL重定向传播会话
    • SSO模式三 Http请求获取会话
    • 配置域名校验
    • 定制化登录页面
    • 自定义API路由
    • 平台中心跳转模式
    • 匿名 client 接入
    • 单点注销
    • 前后端分离下的整合方案
    • 消息推送机制
    • 用户数据同步 / 迁移
    • NoSdk、ReSdk 模式与非 java 项目
    • SSO 代码 API 参考
    • 常见问题总结
    • Sa-Pro:单点登录商业版
  • OAuth2.0

    • OAuth2.0简述
    • OAuth2-Server搭建
    • OAuth2-Server端开放 API 接口
    • 自定义数据加载器
    • 配置 client 域名校验
    • 自定义 Scope 权限及处理器
    • 为 Scope 划分等级
    • 自定义 grant_type
    • 定制化登录页面与授权页面
    • 自定义 API 路由
    • OAuth2-Server端前后台分离
    • OpenId 与 UnionId
    • 开启 OIDC 协议
    • 使用注解校验 Access-Token
    • OAuth2-与登录会话实现数据互通
    • OAuth2 代码 API 参考
    • 常见问题总结
    • Sa-Max:统一认证商业版
  • 微服务

    • 分布式Session会话
    • 网关统一鉴权
    • 内部服务外网隔离
    • 依赖引入说明
  • 插件

    • AOP注解鉴权
    • 临时 Token 认证
    • Quick-Login快速登录插件
    • Alone独立Redis插件
    • Alone独立Redisson插件
    • 缓存层扩展
    • JSON 序列化扩展
    • 序列化插件扩展包
    • HTTP 请求扩展
    • 和 Thymeleaf 集成
    • 和 Freemarker 集成
    • 注解鉴权 SpEL 表达式
    • 和 jwt 集成
    • 和 Dubbo 集成
    • 和 gRPC 集成
    • API 接口参数签名
    • API Key 接口调用秘钥
    • Sa-Token 插件开发指南
    • 自定义 SaTokenContext 指南
  • API手册

    • StpUtil-鉴权工具类
    • SaSession-会话对象
    • SaTokenDao-数据持久接口
    • SaStrategy-全局策略
    • 全局类、方法
  • 框架设计

    • 仓库目录
    • 数据结构
  • 其它

    • 更新日志
    • 框架生态
    • 框架博客
    • 推荐公众号
    • 加入讨论群
    • Sa-Token 内容合作群
    • 赞助 Sa-Token
    • 需求提交
    • 问卷调查
  • 附录

    • 常见问题排查
    • 框架名词解释
    • Sa-Token功能结构图
    • 全局 Log 输出
    • 异步 & Mock 上下文
    • 未登录场景值详解
    • Token有效期详解
    • Session模型详解
    • 数据读写三大作用域
    • TokenInfo参数详解
    • 异常细分状态码
    • 自定义注解
    • 防火墙
    • 参考:把权限放在缓存里
    • 参考:把路由拦截鉴权动态化
    • 解决反向代理 uri 丢失的问题
    • 解决跨域问题
    • 技术选型:SSO 与 OAuth2 对比
    • 集成 MongoDB 参考一
    • 集成 MongoDB 参考二
    • 从 Shiro、SpringSecurity、JWT 迁移
    • issue 提问模板
    • 为Sa-Token贡献代码
    • Sa-Token开源大事记
    • 团队成员
    • Sa-Token框架掌握度--在线考试







----- 到底线了 -----

×

一个项目搞定:同域、跨域、共享Redis、跨Redis、前后端一体、前后端分离、纯 js、vue2、vue3、非 Sa-Token 项目、非 java 项目等架构下的 SSO 认证需求。

一次购买,永久授权。全源码交付,不含密 Jar。提供售后技术支持。

SaSession-会话对象 ​

SaSession-会话对象,专业数据缓存组件。


1、常量 ​

java
SaSession.USER= "USER";   // 在 Session 上存储用户对象时建议使用的key 
SaSession.ROLE_LIST = "ROLE_LIST";   // 在 Session 上存储角色时建议使用的key 
SaSession.PERMISSION_LIST = "PERMISSION_LIST";   // 在 Session 上存储权限时建议使用的key
1
2
3

2、构建相关 ​

java
session.getId();   // 获取此 Session 的 id 
session.setId(id);   // 写入此 Session 的 id
session.getCreateTime();   // 返回当前会话创建时间(时间戳)
session.setCreateTime(createTime);   // 写入此 Session 的创建时间(时间戳)
session.getType();   // 获取此 Session 的类型
session.setType(type);   // 写入此 Session 的类型
session.getLoginType();   // 获取此 Session 的账号类型
session.setLoginType(loginType);   // 写入此 Session 的账号类型
session.getLoginId();   // 获取此 Session 的账号 id
session.setLoginId(loginId);   // 写入此 Session 的账号 id
session.getToken();   // 获取此 Session 的 token 值
session.setToken(token);   // 写入此 Session 的 token 值
1
2
3
4
5
6
7
8
9
10
11
12

3、SaTerminalInfo 相关 ​

java
session.setTerminalList(terminalList);   // 写入登录终端信息列表
session.getTerminalList();   // 获取登录终端信息列表
session.terminalListCopy();   // 获取 登录终端信息列表 (拷贝副本)
session.getTerminalListByDeviceType(deviceType);   // 获取 登录终端信息列表 (拷贝副本),根据 deviceType 筛选
session.getTokenValueListByDeviceType(deviceType);   // 获取指定设备类型的 token 值列表
session.getTerminal(tokenValue);   // 查找一个终端信息,根据 tokenValue
session.addTerminal(terminal);   // 添加一个终端信息
session.removeTerminal(tokenValue);   // 移除一个终端信息
session.forEachTerminalList((session, terminal) -> {});   // 遍历登录终端信息列表
session.getHistoryTerminalCount();   // 获取历史终端数量
session.setHistoryTerminalCount(count);   // 设置历史终端数量
session.isTrustDeviceId("xxxxxxxxxxxxxxxxxxxxxxxx");   // 判断指定设备 id 是否为可信任设备
1
2
3
4
5
6
7
8
9
10
11
12

4、一些操作 ​

java
session.update();   // 更新Session(从持久库更新刷新一下)
session.logout();   // 注销Session (从持久库删除)
session.logoutByTerminalCountToZero();   // 当 Session 上的 SaTerminalInfo 数量为零时,注销会话 
session.timeout();   // 获取此Session的剩余存活时间 (单位: 秒)
session.updateTimeout(timeout);   // 修改此Session的剩余存活时间
session.updateMinTimeout(minTimeout);   // 修改此Session的最小剩余存活时间 (只有在 Session 的过期时间低于指定的 minTimeout 时才会进行修改)
session.updateMaxTimeout(maxTimeout);   // 修改此Session的最大剩余存活时间 (只有在 Session 的过期时间高于指定的 maxTimeout 时才会进行修改)
1
2
3
4
5
6
7

5、存取值 ​

java
session.get(key);   // 取值
session.get(key, defaultValue);   // 取值 (指定默认值)
session.get(key, () -> {});   // 取值 (如果值为 null,则执行 fun 函数获取值,并把函数返回值写入缓存) 
session.getString(key);   // 取值 (转String类型)
session.getInt(key);   // 取值 (转int类型)
session.getLong(key);   // 取值 (转long类型)
session.getDouble(key);   // 取值 (转double类型)
session.getFloat(key);   // 取值 (转float类型)
session.getModel(key, clazz);   // 取值 (指定转换类型)
session.getModel(key, clazz, defaultValue);   // 取值 (指定转换类型, 并指定值为Null时返回的默认值)
session.has(key);   // 是否含有某个key
session.set(key, value);   // 写值
session.setByNull(key, value);   // 写值 (只有在此 key 原本无值的情况下才会写入)
session.delete(key);   // 删值 
session.keys();   // 返回当前Session的所有key 
session.clear();   // 清空所有值 
session.getDataMap();   // 获取数据挂载集合(如果更新map里的值,请调用session.update()方法避免产生脏数据 ) 
session.setDataMap(dataMap);   // 写入数据挂载集合
session.refreshDataMap(dataMap);   // 写入数据集合 (不改变底层对象,只将此dataMap所有数据进行替换)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19








发现错误? 您可以在 Gitee 或 GitHub 或 AtomGit 帮助我们完善此页文档! 或 加入讨论群 交流反馈。

我们坚信,即使再复杂的技术,也可以用清晰、干练、易懂的文字描述出它的具体细节,如果你在阅读文档时有难以理解的章节,那一定是我们还没有优化好它, 请向我们 反馈 你的困惑之处,我们将持续优化文档。


鲁ICP备18046274号-5|公安备案鲁公网安备37011202002956号
目录

本页无章节

推荐关闭
Sa-Token 商业版:轻松搭建 SSO 单点登录、OAuth2.0 统一认证、API Key 认证。全源码交付、可二开。
加入 Sa-Token 框架交流群

离线版文档历史所有版本文档Demo 示例大全下载

如果 Sa-Token 帮助到了你,希望你可以向同事、朋友推荐了解本框架,这对我们非常重要,感谢支持!

加油,工程师!