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

使用SaSession的程序包

程序包	说明
cn.dev33.satoken.dao
cn.dev33.satoken.session
cn.dev33.satoken.stp

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

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

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

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

修饰符和类型	方法	说明
default void	SaTokenDao.setSession(SaSession session, long timeout)	写入 SaSession，并设定存活时间（单位: 秒）
default void	SaTokenDao.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.set(String key, Object value)	写值
SaSession	SaSession.setByNull(String key, Object value)	写值 (只有在此 key 原本无值的情况下才会写入)
SaSession	SaSession.setCreateTime(long createTime)	写入：此 SaSession 的创建时间（13位时间戳）
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 的 类型

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=是否新建并返回
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, 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.logoutByMaxLoginCount(Object loginId, SaSession session, String device, int maxLoginCount)	如果指定账号 id、设备类型的登录客户端已经超过了指定数量，则按照登录时间顺序，把最开始登录的给注销掉

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

修饰符和类型	方法	说明
SaSession	StpLogic.getSessionBySessionId(String sessionId, boolean isCreate, Consumer<SaSession> appendOperation)	获取指定 key 的 SaSession, 如果该 SaSession 尚未创建，isCreate = 是否立即新建并返回