cn.dev33.satoken.stp

类 StpUtil

java.lang.Object

cn.dev33.satoken.stp.StpUtil

public class StpUtil
extends java.lang.Object

一个默认的实现

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static StpLogic	stpLogic 底层的 StpLogic 对象

构造器概要

构造器

构造器和说明
StpUtil()

方法概要

限定符和类型	方法和说明
static void	checkActivityTimeout() 检查当前token 是否已经[临时过期]，如果已经过期则抛出异常
static void	checkLogin() 检验当前会话是否已经登录，如未登录，则抛出异常
static void	checkPermission(java.lang.String permissionCode) 当前账号是否含有指定权限， 没有就抛出异常
static void	checkPermissionAnd(java.lang.String... permissionCodeArray) 当前账号是否含有指定权限, [指定多个，必须全都有]
static void	checkPermissionOr(java.lang.String... permissionCodeArray) 当前账号是否含有指定权限, [指定多个，有一个就可以通过]
static void	checkRole(java.lang.String role) 当前账号是否含有指定角色标识，没有就抛出异常
static void	checkRoleAnd(java.lang.String... roleArray) 当前账号是否含有指定角色标识, [指定多个，必须全都有]
static void	checkRoleOr(java.lang.String... roleArray) 当前账号是否含有指定角色标识, [指定多个，有一个就可以通过]
static java.lang.String	getLoginDevice() 返回当前token的登录设备
static java.lang.Object	getLoginId() 获取当前会话账号id, 如果未登录，则抛出异常
static <T> T	getLoginId(T defaultValue) 获取当前会话登录id, 如果未登录，则返回默认值
static int	getLoginIdAsInt() 获取当前会话登录id, 并转换为int
static long	getLoginIdAsLong() 获取当前会话登录id, 并转换为long
static java.lang.String	getLoginIdAsString() 获取当前会话登录id, 并转换为String
static java.lang.Object	getLoginIdByToken(java.lang.String tokenValue) 获取指定token对应的登录id，如果未登录，则返回 null
static java.lang.Object	getLoginIdDefaultNull() 获取当前会话登录id, 如果未登录，则返回null
static java.lang.String	getLoginKey() 获取当前StpLogin的loginKey
static SaSession	getSession() 获取当前会话的session，如果session尚未创建，则新建并返回
static SaSession	getSession(boolean isCreate) 获取当前会话的session, 如果session尚未创建，isCreate=是否新建并返回
static SaSession	getSessionByLoginId(java.lang.Object loginId) 获取指定loginId的session，如果session尚未创建，则新建并返回
static SaSession	getSessionByLoginId(java.lang.Object loginId, boolean isCreate) 获取指定loginId的session, 如果session尚未创建，isCreate=是否新建并返回
static SaSession	getSessionBySessionId(java.lang.String sessionId) 获取指定key的session, 如果session尚未创建，则返回null
static long	getSessionTimeout() 获取当前登录者的Session剩余有效时间 (单位: 秒)
static long	getTokenActivityTimeout() 获取当前token[临时过期]剩余有效时间 (单位: 秒)
static SaTokenInfo	getTokenInfo() 获取当前会话的token信息
static java.lang.String	getTokenName() 返回token名称
static SaSession	getTokenSession() 获取当前token的专属-session，如果session尚未创建，则新建并返回
static SaSession	getTokenSessionByToken(java.lang.String tokenValue) 获取指定token的专属session，如果session尚未创建，则新建并返回
static long	getTokenSessionTimeout() 获取当前token的专属Session剩余有效时间 (单位: 秒)
static long	getTokenTimeout() 获取当前登录者的token剩余有效时间 (单位: 秒)
static java.lang.String	getTokenValue() 获取当前tokenValue
static java.lang.String	getTokenValueByLoginId(java.lang.Object loginId) 获取指定loginId的tokenValue 在配置为允许并发登录时，此方法只会返回队列的最后一个token， 如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
static java.lang.String	getTokenValueByLoginId(java.lang.Object loginId, java.lang.String device) 获取指定loginId指定设备端的tokenValue 在配置为允许并发登录时，此方法只会返回队列的最后一个token， 如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
static java.util.List<java.lang.String>	getTokenValueListByLoginId(java.lang.Object loginId) 获取指定loginId的tokenValue集合
static java.util.List<java.lang.String>	getTokenValueListByLoginId(java.lang.Object loginId, java.lang.String device) 获取指定loginId指定设备端的tokenValue集合
static boolean	hasPermission(java.lang.Object loginId, java.lang.String permissionCode) 指定账号id是否含有指定权限
static boolean	hasPermission(java.lang.String permissionCode) 当前账号id是否含有指定权限
static boolean	hasRole(java.lang.Object loginId, java.lang.String role) 指定账号id是否含有角色标识
static boolean	hasRole(java.lang.String role) 当前账号id是否含有指定角色标识
static boolean	isLogin() 获取当前会话是否已经登录
static void	logout() 当前会话注销登录
static void	logoutByLoginId(java.lang.Object loginId) 指定loginId的会话注销登录（踢人下线） 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2
static void	logoutByLoginId(java.lang.Object loginId, java.lang.String device) 指定loginId指定设备的会话注销登录（踢人下线） 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2
static void	logoutByTokenValue(java.lang.String tokenValue) 指定token的会话注销登录
static java.util.List<java.lang.String>	searchSessionId(java.lang.String keyword, int start, int size) 根据条件查询SessionId
static java.util.List<java.lang.String>	searchTokenSessionId(java.lang.String keyword, int start, int size) 根据条件查询token专属Session的Id
static java.util.List<java.lang.String>	searchTokenValue(java.lang.String keyword, int start, int size) 根据条件查询token
static void	setLoginId(java.lang.Object loginId) 在当前会话上登录id
static void	setLoginId(java.lang.Object loginId, java.lang.String device) 在当前会话上登录id
static void	updateLastActivityToNow() 续签当前token：(将 [最后操作时间] 更新为当前时间戳) 请注意: 即时token已经 [临时过期] 也可续签成功， 如果此场景下需要提示续签失败，可在此之前调用 checkActivityTimeout() 强制检查是否过期即可

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

stpLogic

public static StpLogic stpLogic

底层的 StpLogic 对象

构造器详细资料

StpUtil

public StpUtil()

方法详细资料

getTokenName

public static java.lang.String getTokenName()

返回token名称

返回:

此StpLogic的token名称

getTokenValue

public static java.lang.String getTokenValue()

获取当前tokenValue

返回:

当前tokenValue

getLoginKey

public static java.lang.String getLoginKey()

获取当前StpLogin的loginKey

返回:

当前StpLogin的loginKey

getTokenInfo

public static SaTokenInfo getTokenInfo()

获取当前会话的token信息

返回:

token信息

setLoginId

public static void setLoginId(java.lang.Object loginId)

在当前会话上登录id

参数:

loginId - 登录id，建议的类型：（long | int | String）

setLoginId

public static void setLoginId(java.lang.Object loginId,
                              java.lang.String device)

在当前会话上登录id

参数:

loginId - 登录id，建议的类型：（long | int | String）

device - 设备标识

logout

public static void logout()

当前会话注销登录

logoutByTokenValue

public static void logoutByTokenValue(java.lang.String tokenValue)

指定token的会话注销登录

参数:

tokenValue - 指定token

logoutByLoginId

public static void logoutByLoginId(java.lang.Object loginId)

指定loginId的会话注销登录（踢人下线）

当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2

参数:

loginId - 账号id

logoutByLoginId

public static void logoutByLoginId(java.lang.Object loginId,
                                   java.lang.String device)

指定loginId指定设备的会话注销登录（踢人下线）

当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2

参数:

loginId - 账号id

device - 设备标识

isLogin

public static boolean isLogin()

获取当前会话是否已经登录

返回:

是否已登录

checkLogin

public static void checkLogin()

检验当前会话是否已经登录，如未登录，则抛出异常

getLoginId

public static java.lang.Object getLoginId()

获取当前会话账号id, 如果未登录，则抛出异常

返回:

账号id

getLoginId

public static <T> T getLoginId(T defaultValue)

获取当前会话登录id, 如果未登录，则返回默认值

类型参数:

T - 返回类型

参数:

defaultValue - 默认值

返回:

登录id

getLoginIdDefaultNull

public static java.lang.Object getLoginIdDefaultNull()

获取当前会话登录id, 如果未登录，则返回null

返回:

账号id

getLoginIdAsString

public static java.lang.String getLoginIdAsString()

获取当前会话登录id, 并转换为String

返回:

账号id

getLoginIdAsInt

public static int getLoginIdAsInt()

获取当前会话登录id, 并转换为int

返回:

账号id

getLoginIdAsLong

public static long getLoginIdAsLong()

获取当前会话登录id, 并转换为long

返回:

账号id

getLoginIdByToken

public static java.lang.Object getLoginIdByToken(java.lang.String tokenValue)

获取指定token对应的登录id，如果未登录，则返回 null

参数:

tokenValue - token

返回:

登录id

getSessionByLoginId

public static SaSession getSessionByLoginId(java.lang.Object loginId,
                                            boolean isCreate)

获取指定loginId的session, 如果session尚未创建，isCreate=是否新建并返回

参数:

loginId - 账号id

isCreate - 是否新建

返回:

SaSession

getSessionBySessionId

public static SaSession getSessionBySessionId(java.lang.String sessionId)

获取指定key的session, 如果session尚未创建，则返回null

参数:

sessionId - sessionId

返回:

session对象

getSessionByLoginId

public static SaSession getSessionByLoginId(java.lang.Object loginId)

获取指定loginId的session，如果session尚未创建，则新建并返回

参数:

loginId - 账号id

返回:

session会话

getSession

public static SaSession getSession(boolean isCreate)

获取当前会话的session, 如果session尚未创建，isCreate=是否新建并返回

参数:

isCreate - 是否新建

返回:

当前会话的session

getSession

public static SaSession getSession()

获取当前会话的session，如果session尚未创建，则新建并返回

返回:

当前会话的session

getTokenSessionByToken

public static SaSession getTokenSessionByToken(java.lang.String tokenValue)

获取指定token的专属session，如果session尚未创建，则新建并返回

参数:

tokenValue - token值

返回:

session会话

getTokenSession

public static SaSession getTokenSession()

获取当前token的专属-session，如果session尚未创建，则新建并返回

返回:

session会话

checkActivityTimeout

public static void checkActivityTimeout()

检查当前token 是否已经[临时过期]，如果已经过期则抛出异常

updateLastActivityToNow

public static void updateLastActivityToNow()

续签当前token：(将 [最后操作时间] 更新为当前时间戳)

请注意: 即时token已经 [临时过期] 也可续签成功， 如果此场景下需要提示续签失败，可在此之前调用 checkActivityTimeout() 强制检查是否过期即可

getTokenTimeout

public static long getTokenTimeout()

获取当前登录者的token剩余有效时间 (单位: 秒)

返回:

token剩余有效时间

getSessionTimeout

public static long getSessionTimeout()

获取当前登录者的Session剩余有效时间 (单位: 秒)

返回:

token剩余有效时间

getTokenSessionTimeout

public static long getTokenSessionTimeout()

获取当前token的专属Session剩余有效时间 (单位: 秒)

返回:

token剩余有效时间

getTokenActivityTimeout

public static long getTokenActivityTimeout()

获取当前token[临时过期]剩余有效时间 (单位: 秒)

返回:

token[临时过期]剩余有效时间

hasRole

public static boolean hasRole(java.lang.Object loginId,
                              java.lang.String role)

指定账号id是否含有角色标识

参数:

loginId - 账号id

role - 角色标识

返回:

是否含有指定角色标识

hasRole

public static boolean hasRole(java.lang.String role)

当前账号id是否含有指定角色标识

参数:

role - 角色标识

返回:

是否含有指定角色标识

checkRole

public static void checkRole(java.lang.String role)

当前账号是否含有指定角色标识，没有就抛出异常

参数:

role - 角色标识

checkRoleAnd

public static void checkRoleAnd(java.lang.String... roleArray)

当前账号是否含有指定角色标识, [指定多个，必须全都有]

参数:

roleArray - 角色标识数组

checkRoleOr

public static void checkRoleOr(java.lang.String... roleArray)

当前账号是否含有指定角色标识, [指定多个，有一个就可以通过]

参数:

roleArray - 角色标识数组

hasPermission

public static boolean hasPermission(java.lang.Object loginId,
                                    java.lang.String permissionCode)

指定账号id是否含有指定权限

参数:

loginId - 账号id

permissionCode - 权限码

返回:

是否含有指定权限

hasPermission

public static boolean hasPermission(java.lang.String permissionCode)

当前账号id是否含有指定权限

参数:

permissionCode - 权限码

返回:

是否含有指定权限

checkPermission

public static void checkPermission(java.lang.String permissionCode)

当前账号是否含有指定权限， 没有就抛出异常

参数:

permissionCode - 权限码

checkPermissionAnd

public static void checkPermissionAnd(java.lang.String... permissionCodeArray)

当前账号是否含有指定权限, [指定多个，必须全都有]

参数:

permissionCodeArray - 权限码数组

checkPermissionOr

public static void checkPermissionOr(java.lang.String... permissionCodeArray)

当前账号是否含有指定权限, [指定多个，有一个就可以通过]

参数:

permissionCodeArray - 权限码数组

getTokenValueByLoginId

public static java.lang.String getTokenValueByLoginId(java.lang.Object loginId)

获取指定loginId的tokenValue

在配置为允许并发登录时，此方法只会返回队列的最后一个token， 如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId

参数:

loginId - 账号id

返回:

token值

getTokenValueByLoginId

public static java.lang.String getTokenValueByLoginId(java.lang.Object loginId,
                                                      java.lang.String device)

获取指定loginId指定设备端的tokenValue

在配置为允许并发登录时，此方法只会返回队列的最后一个token， 如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId

参数:

loginId - 账号id

device - 设备标识

返回:

token值

getTokenValueListByLoginId

public static java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId)

获取指定loginId的tokenValue集合

参数:

loginId - 账号id

返回:

此loginId的所有相关token

getTokenValueListByLoginId

public static java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId,
                                                                          java.lang.String device)

获取指定loginId指定设备端的tokenValue集合

参数:

loginId - 账号id

device - 设备标识

返回:

此loginId的所有相关token

getLoginDevice

public static java.lang.String getLoginDevice()

返回当前token的登录设备

返回:

当前令牌的登录设备

searchTokenValue

public static java.util.List<java.lang.String> searchTokenValue(java.lang.String keyword,
                                                                int start,
                                                                int size)

根据条件查询token

参数:

keyword - 关键字

start - 开始处索引 (-1代表查询所有)

size - 获取数量

返回:

token集合

searchSessionId

public static java.util.List<java.lang.String> searchSessionId(java.lang.String keyword,
                                                               int start,
                                                               int size)

根据条件查询SessionId

参数:

keyword - 关键字

start - 开始处索引 (-1代表查询所有)

size - 获取数量

返回:

sessionId集合

searchTokenSessionId

public static java.util.List<java.lang.String> searchTokenSessionId(java.lang.String keyword,
                                                                    int start,
                                                                    int size)

根据条件查询token专属Session的Id

参数:

keyword - 关键字

start - 开始处索引 (-1代表查询所有)

size - 获取数量

返回:

sessionId集合