类的使用
cn.dev33.satoken.session.SaSession

使用SaSession的程序包

程序包	说明
cn.dev33.satoken.apikey
cn.dev33.satoken.dao
cn.dev33.satoken.dao.auto
cn.dev33.satoken.session
cn.dev33.satoken.session.raw
cn.dev33.satoken.stp
cn.dev33.satoken.strategy
cn.dev33.satoken.temp

cn.dev33.satoken.apikey中SaSession的使用

参数类型为SaSession的cn.dev33.satoken.apikey中的方法

修饰符和类型	方法	说明
void	SaApiKeyTemplate.adjustIndex(Object loginId, SaSession session)	调整指定 SaSession 的 TTL 值，以保证最小化内存占用
static void	SaApiKeyUtil.adjustIndex(Object loginId, SaSession session)	调整指定 SaSession 的 TTL 值，以保证最小化内存占用

cn.dev33.satoken.dao中SaSession的使用

返回SaSession的cn.dev33.satoken.dao中的方法

修饰符和类型	方法	说明
SaSession	SaTokenDao.getSession(String sessionId)	获取 SaSession，如无返空

参数类型为SaSession的cn.dev33.satoken.dao中的方法

修饰符和类型	方法	说明
void	SaTokenDao.setSession(SaSession session, long timeout)	写入 SaSession，并设定存活时间（单位: 秒）
void	SaTokenDao.updateSession(SaSession session)	更新 SaSession

cn.dev33.satoken.dao.auto中SaSession的使用

返回SaSession的cn.dev33.satoken.dao.auto中的方法

修饰符和类型	方法	说明
default SaSession	SaTokenDaoBySessionFollowObject.getSession(String sessionId)	获取 SaSession，如无返空

参数类型为SaSession的cn.dev33.satoken.dao.auto中的方法

修饰符和类型	方法	说明
default void	SaTokenDaoBySessionFollowObject.setSession(SaSession session, long timeout)	写入 SaSession，并设定存活时间（单位: 秒）
default void	SaTokenDaoBySessionFollowObject.updateSession(SaSession session)	更新 SaSession

cn.dev33.satoken.session中SaSession的使用

返回SaSession的cn.dev33.satoken.session中的方法

修饰符和类型	方法	说明
SaSession	SaSession.delete(String key)	删值
static SaSession	SaSessionCustomUtil.getSessionById(String sessionId)	获取指定 key 的 SaSession, 如果此 SaSession 尚未在 DB 创建，则新建并返回
static SaSession	SaSessionCustomUtil.getSessionById(String sessionId, boolean isCreate)	获取指定 key 的 SaSession 对象, 如果此 SaSession 尚未在 DB 创建，isCreate 参数代表是否则新建并返回
SaSession	SaSession.refreshDataMap(Map<String,Object> dataMap)	写入数据集合 (不改变底层对象引用，只将此 dataMap 所有数据进行替换)
SaSession	SaSession.set(String key, Object value)	写值
SaSession	SaSession.setByNull(String key, Object value)	写值 (只有在此 key 原本无值的情况下才会写入)
SaSession	SaSession.setCreateTime(long createTime)	写入：此 SaSession 的创建时间（13位时间戳）
SaSession	SaSession.setDataMap(Map<String,Object> dataMap)	设置数据挂载集合 (改变底层对象引用，将 dataMap 整个对象替换)
SaSession	SaSession.setId(String id)	写入：此 SaSession 的 id
SaSession	SaSession.setLoginId(Object loginId)	设置：所属 loginId （当此 SaSession 属于 Account-Session 时，此值有效）
SaSession	SaSession.setLoginType(String loginType)	设置：所属 loginType
SaSession	SaSession.setToken(String token)	设置：所属 Token （当此 SaSession 属于 Token-Session 时，此值有效）
SaSession	SaSession.setType(String type)	设置：此 SaSession 的 类型

类型变量类型为SaSession的cn.dev33.satoken.session中的方法参数

修饰符和类型	方法	说明
void	SaSession.forEachTerminalList(SaTwoParamFunction<SaSession,SaTerminalInfo> function)	遍历 terminalList 列表，执行特定函数

cn.dev33.satoken.session.raw中SaSession的使用

返回SaSession的cn.dev33.satoken.session.raw中的方法

修饰符和类型	方法	说明
SaSession	SaRawSessionDelegator.getSessionById(Object valueId)	获取指定 SaSession, 如果此 SaSession 尚未在 DB 创建，则新建并返回
SaSession	SaRawSessionDelegator.getSessionById(Object valueId, boolean isCreate)	获取指定 SaSession 对象, 如果此 SaSession 尚未在 Cache 创建，isCreate 参数代表是否则新建并返回
static SaSession	SaRawSessionUtil.getSessionById(String type, Object valueId)	获取指定 SaSession, 如果此 SaSession 尚未在 DB 创建，则新建并返回
static SaSession	SaRawSessionUtil.getSessionById(String type, Object valueId, boolean isCreate)	获取指定 SaSession 对象, 如果此 SaSession 尚未在 Cache 创建，isCreate 参数代表是否则新建并返回

cn.dev33.satoken.stp中SaSession的使用

返回SaSession的cn.dev33.satoken.stp中的方法

修饰符和类型	方法	说明
SaSession	StpLogic.getAnonTokenSession()	获取当前匿名 Token-Session （可在未登录情况下使用的Token-Session）
SaSession	StpLogic.getAnonTokenSession(boolean isCreate)	获取当前匿名 Token-Session （可在未登录情况下使用的 Token-Session）
static SaSession	StpUtil.getAnonTokenSession()	获取当前匿名 Token-Session （可在未登录情况下使用的Token-Session）
SaSession	StpLogic.getSession()	获取当前已登录账号的 Account-Session，如果该 SaSession 尚未创建，则新建并返回
SaSession	StpLogic.getSession(boolean isCreate)	获取当前已登录账号的 Account-Session, 如果该 SaSession 尚未创建，isCreate=是否新建并返回
static SaSession	StpUtil.getSession()	获取当前已登录账号的 Account-Session，如果该 SaSession 尚未创建，则新建并返回
static SaSession	StpUtil.getSession(boolean isCreate)	获取当前已登录账号的 Account-Session, 如果该 SaSession 尚未创建，isCreate=是否新建并返回
SaSession	StpLogic.getSessionByLoginId(Object loginId)	获取指定账号 id 的 Account-Session，如果该 SaSession 尚未创建，则新建并返回
SaSession	StpLogic.getSessionByLoginId(Object loginId, boolean isCreate)	获取指定账号 id 的 Account-Session, 如果该 SaSession 尚未创建，isCreate=是否新建并返回
SaSession	StpLogic.getSessionByLoginId(Object loginId, boolean isCreate, Long timeout)	获取指定账号 id 的 Account-Session, 如果该 SaSession 尚未创建，isCreate=是否新建并返回
static SaSession	StpUtil.getSessionByLoginId(Object loginId)	获取指定账号 id 的 Account-Session，如果该 SaSession 尚未创建，则新建并返回
static SaSession	StpUtil.getSessionByLoginId(Object loginId, boolean isCreate)	获取指定账号 id 的 Account-Session, 如果该 SaSession 尚未创建，isCreate=是否新建并返回
SaSession	StpLogic.getSessionBySessionId(String sessionId)	获取指定 key 的 SaSession, 如果该 SaSession 尚未创建，则返回 null
SaSession	StpLogic.getSessionBySessionId(String sessionId, boolean isCreate, Long timeout, Consumer<SaSession> appendOperation)	获取指定 key 的 SaSession, 如果该 SaSession 尚未创建，isCreate = 是否立即新建并返回
static SaSession	StpUtil.getSessionBySessionId(String sessionId)	获取指定 key 的 SaSession, 如果该 SaSession 尚未创建，则返回 null
SaSession	StpLogic.getTokenSession()	获取当前 token 的 Token-Session，如果该 SaSession 尚未创建，则新建并返回
SaSession	StpLogic.getTokenSession(boolean isCreate)	获取当前 token 的 Token-Session，如果该 SaSession 尚未创建，isCreate代表是否新建并返回
static SaSession	StpUtil.getTokenSession()	获取当前 token 的 Token-Session，如果该 SaSession 尚未创建，则新建并返回
SaSession	StpLogic.getTokenSessionByToken(String tokenValue)	获取指定 token 的 Token-Session，如果该 SaSession 尚未创建，则新建并返回
SaSession	StpLogic.getTokenSessionByToken(String tokenValue, boolean isCreate)	获取指定 token 的 Token-Session，如果该 SaSession 尚未创建，isCreate代表是否新建并返回
static SaSession	StpUtil.getTokenSessionByToken(String tokenValue)	获取指定 token 的 Token-Session，如果该 SaSession 尚未创建，则新建并返回

参数类型为SaSession的cn.dev33.satoken.stp中的方法

修饰符和类型	方法	说明
void	StpLogic._removeTerminal(SaSession session, SaTerminalInfo terminal, SaLogoutParameter logoutParameter)	在 Account-Session 上移除 Terminal 信息 (内部方法，仅为减少重复代码，外部调用意义不大)
void	StpLogic.logoutByMaxLoginCount(Object loginId, SaSession session, String deviceType, int maxLoginCount, SaLogoutMode logoutMode)	如果指定账号 id、设备类型的登录客户端已经超过了指定数量，则按照登录时间顺序，把最开始登录的给注销掉
void	StpLogic.removeTerminalByKickout(SaSession session, SaTerminalInfo terminal)	在 Account-Session 上移除 Terminal 信息 (踢人下线方式)
static void	StpUtil.removeTerminalByKickout(SaSession session, SaTerminalInfo terminal)	在 Account-Session 上移除 Terminal 信息 (踢人下线方式)
void	StpLogic.removeTerminalByLogout(SaSession session, SaTerminalInfo terminal)	在 Account-Session 上移除 Terminal 信息 (注销下线方式)
static void	StpUtil.removeTerminalByLogout(SaSession session, SaTerminalInfo terminal)	在 Account-Session 上移除 Terminal 信息 (注销下线方式)
void	StpLogic.removeTerminalByReplaced(SaSession session, SaTerminalInfo terminal)	在 Account-Session 上移除 Terminal 信息 (顶人下线方式)
static void	StpUtil.removeTerminalByReplaced(SaSession session, SaTerminalInfo terminal)	在 Account-Session 上移除 Terminal 信息 (顶人下线方式)

类型变量类型为SaSession的cn.dev33.satoken.stp中的方法参数

修饰符和类型	方法	说明
void	StpLogic.forEachTerminalList(Object loginId, SaTwoParamFunction<SaSession,SaTerminalInfo> function)	获取指定账号 id 已登录设备信息集合，执行特定函数
static void	StpUtil.forEachTerminalList(Object loginId, SaTwoParamFunction<SaSession,SaTerminalInfo> function)	获取指定账号 id 已登录设备信息集合，执行特定函数
SaSession	StpLogic.getSessionBySessionId(String sessionId, boolean isCreate, Long timeout, Consumer<SaSession> appendOperation)	获取指定 key 的 SaSession, 如果该 SaSession 尚未创建，isCreate = 是否立即新建并返回

cn.dev33.satoken.strategy中SaSession的使用

类型参数类型为SaSession的cn.dev33.satoken.strategy中的字段

修饰符和类型	字段	说明
Class<? extends SaSession>	SaStrategy.sessionClassType	反序列化 SaSession 时默认指定的类型

cn.dev33.satoken.temp中SaSession的使用

参数类型为SaSession的cn.dev33.satoken.temp中的方法

修饰符和类型	方法	说明
protected void	SaTempTemplate.addTempTokenIndex(SaSession session, String token, long timeout)	在 SaSession 上添加临时 temp-token 索引
Map<String,Long>	SaTempTemplate.adjustIndex(Object value, SaSession session)	调整索引
protected void	SaTempTemplate.deleteTempTokenIndex(SaSession session, String token)	在 SaSession 上删除临时 temp-token 索引