StpUtil (sa-token-core 1.33.0 API)

java.lang.Object
- cn.dev33.satoken.stp.StpUtil

public class StpUtil
extends java.lang.Object

Sa-Token 权限认证工具类

作者:: kong

字段概要

字段
限定符和类型字段和说明

static StpLogic stpLogic
底层的 StpLogic 对象

static java.lang.String TYPE
账号类型标识

字段
限定符和类型	字段和说明
`static StpLogic`	`stpLogic` 底层的 StpLogic 对象
`static java.lang.String`	`TYPE` 账号类型标识

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`checkActivityTimeout()` 检查当前token 是否已经[临时过期]，如果已经过期则抛出异常
`static void`	`checkDisable(java.lang.Object loginId)` 校验：指定账号是否已被封禁，如果被封禁则抛出异常
`static void`	`checkDisable(java.lang.Object loginId, java.lang.String... services)` 校验：指定账号指定服务是否已被封禁，如果被封禁则抛出异常
`static void`	`checkDisableLevel(java.lang.Object loginId, int level)` 校验：指定账号是否已被封禁到指定等级（如果已经达到，则抛出异常）
`static void`	`checkDisableLevel(java.lang.Object loginId, java.lang.String service, int level)` 校验：指定账号的指定服务，是否已被封禁到指定等级（如果已经达到，则抛出异常）
`static void`	`checkLogin()` 检验当前会话是否已经登录，如未登录，则抛出异常
`static void`	`checkPermission(java.lang.String permission)` 校验：当前账号是否含有指定权限, 如果验证未通过，则抛出异常: NotPermissionException
`static void`	`checkPermissionAnd(java.lang.String... permissionArray)` 校验：当前账号是否含有指定权限 [指定多个，必须全部验证通过]
`static void`	`checkPermissionOr(java.lang.String... permissionArray)` 校验：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
`static void`	`checkRole(java.lang.String role)` 校验：当前账号是否含有指定角色标识, 如果验证未通过，则抛出异常: NotRoleException
`static void`	`checkRoleAnd(java.lang.String... roleArray)` 校验：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
`static void`	`checkRoleOr(java.lang.String... roleArray)` 校验：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
`static void`	`checkSafe()` 检查当前会话是否已通过二级认证，如未通过则抛出异常
`static void`	`checkSafe(java.lang.String service)` 检查当前会话是否已通过二级认证，如未通过则抛出异常
`static void`	`closeSafe()` 在当前会话结束二级认证
`static void`	`closeSafe(java.lang.String service)` 在当前会话结束二级认证
`static java.lang.String`	`createLoginSession(java.lang.Object id)` 创建指定账号id的登录会话
`static java.lang.String`	`createLoginSession(java.lang.Object id, SaLoginModel loginModel)` 创建指定账号id的登录会话
`static void`	`disable(java.lang.Object loginId, long time)` 封禁：指定账号此方法不会直接将此账号id踢下线，如需封禁后立即掉线，请追加调用 StpUtil.logout(id)
`static void`	`disable(java.lang.Object loginId, java.lang.String service, long time)` 封禁：指定账号的指定服务此方法不会直接将此账号id踢下线，如需封禁后立即掉线，请追加调用 StpUtil.logout(id)
`static void`	`disableLevel(java.lang.Object loginId, int level, long time)` 封禁：指定账号，并指定封禁等级
`static void`	`disableLevel(java.lang.Object loginId, java.lang.String service, int level, long time)` 封禁：指定账号的指定服务，并指定封禁等级
`static void`	`endSwitch()` 结束临时切换身份
`static SaSession`	`getAnonTokenSession()` 获取当前匿名 Token-Session （可在未登录情况下使用的Token-Session）
`static int`	`getDisableLevel(java.lang.Object loginId)` 获取：指定账号被封禁的等级，如果未被封禁则返回-2
`static int`	`getDisableLevel(java.lang.Object loginId, java.lang.String service)` 获取：指定账号的指定服务被封禁的等级，如果未被封禁则返回-2
`static long`	`getDisableTime(java.lang.Object loginId)` 获取：指定账号剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
`static long`	`getDisableTime(java.lang.Object loginId, java.lang.String service)` 获取：指定账号指定服务剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
`static java.lang.Object`	`getExtra(java.lang.String key)` 获取当前 Token 的扩展信息（此函数只在jwt模式下生效）
`static java.lang.Object`	`getExtra(java.lang.String tokenValue, java.lang.String key)` 获取指定 Token 的扩展信息（此函数只在jwt模式下生效）
`static java.lang.String`	`getLoginDevice()` 返回当前会话的登录设备类型
`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`	`getLoginType()` 获取当前 StpLogic 的账号类型
`static java.util.List<java.lang.String>`	`getPermissionList()` 获取：当前账号的权限码集合
`static java.util.List<java.lang.String>`	`getPermissionList(java.lang.Object loginId)` 获取：指定账号的权限码集合
`static java.util.List<java.lang.String>`	`getRoleList()` 获取：当前账号的角色集合
`static java.util.List<java.lang.String>`	`getRoleList(java.lang.Object loginId)` 获取：指定账号的角色集合
`static long`	`getSafeTime()` 获取当前会话的二级认证剩余有效时间 (单位: 秒, 返回-2代表尚未通过二级认证)
`static long`	`getSafeTime(java.lang.String service)` 获取当前会话的二级认证剩余有效时间 (单位: 秒, 返回-2代表尚未通过二级认证)
`static SaSession`	`getSession()` 获取当前会话的Session，如果Session尚未创建，则新建并返回
`static SaSession`	`getSession(boolean isCreate)` 获取当前会话的Session, 如果Session尚未创建，isCreate=是否新建并返回
`static SaSession`	`getSessionByLoginId(java.lang.Object loginId)` 获取指定账号id的Session，如果Session尚未创建，则新建并返回
`static SaSession`	`getSessionByLoginId(java.lang.Object loginId, boolean isCreate)` 获取指定账号id的Session, 如果Session尚未创建，isCreate=是否新建并返回
`static SaSession`	`getSessionBySessionId(java.lang.String sessionId)` 获取指定key的Session, 如果Session尚未创建，则返回null
`static long`	`getSessionTimeout()` 获取当前登录者的 User-Session 剩余有效时间 (单位: 秒)
`static StpLogic`	`getStpLogic()` 获取 StpLogic 对象
`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)` 获取指定账号id的tokenValue 在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
`static java.lang.String`	`getTokenValueByLoginId(java.lang.Object loginId, java.lang.String device)` 获取指定账号id指定设备类型端的tokenValue 在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
`static java.util.List<java.lang.String>`	`getTokenValueListByLoginId(java.lang.Object loginId)` 获取指定账号id的tokenValue集合
`static java.util.List<java.lang.String>`	`getTokenValueListByLoginId(java.lang.Object loginId, java.lang.String device)` 获取指定账号id指定设备类型端的tokenValue 集合
`static java.lang.String`	`getTokenValueNotCut()` 获取当前TokenValue (不裁剪前缀)
`static boolean`	`hasPermission(java.lang.Object loginId, java.lang.String permission)` 判断：指定账号id是否含有指定权限, 返回true或false
`static boolean`	`hasPermission(java.lang.String permission)` 判断：当前账号是否含有指定权限, 返回true或false
`static boolean`	`hasPermissionAnd(java.lang.String... permissionArray)` 判断：当前账号是否含有指定权限, [指定多个，必须全部具有]
`static boolean`	`hasPermissionOr(java.lang.String... permissionArray)` 判断：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
`static boolean`	`hasRole(java.lang.Object loginId, java.lang.String role)` 判断：指定账号是否含有指定角色标识, 返回true或false
`static boolean`	`hasRole(java.lang.String role)` 判断：当前账号是否拥有指定角色, 返回true或false
`static boolean`	`hasRoleAnd(java.lang.String... roleArray)` 判断：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
`static boolean`	`hasRoleOr(java.lang.String... roleArray)` 判断：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
`static boolean`	`isDisable(java.lang.Object loginId)` 判断：指定账号是否已被封禁 (true=已被封禁, false=未被封禁)
`static boolean`	`isDisable(java.lang.Object loginId, java.lang.String service)` 判断：指定账号的指定服务是否已被封禁 (true=已被封禁, false=未被封禁)
`static boolean`	`isDisableLevel(java.lang.Object loginId, int level)` 判断：指定账号是否已被封禁到指定等级
`static boolean`	`isDisableLevel(java.lang.Object loginId, java.lang.String service, int level)` 判断：指定账号的指定服务，是否已被封禁到指定等级
`static boolean`	`isLogin()` 当前会话是否已经登录
`static boolean`	`isSafe()` 当前会话是否处于二级认证时间内
`static boolean`	`isSafe(java.lang.String service)` 当前会话是否处于二级认证时间内
`static boolean`	`isSafe(java.lang.String tokenValue, java.lang.String service)` 指定 Token 是否处于二级认证时间内
`static boolean`	`isSwitch()` 当前是否正处于[身份临时切换]中
`static void`	`kickout(java.lang.Object loginId)` 踢人下线，根据账号id 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
`static void`	`kickout(java.lang.Object loginId, java.lang.String device)` 踢人下线，根据账号id 和设备类型当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
`static void`	`kickoutByTokenValue(java.lang.String tokenValue)` 踢人下线，根据指定 Token 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
`static void`	`login(java.lang.Object id)` 会话登录
`static void`	`login(java.lang.Object id, boolean isLastingCookie)` 会话登录，并指定是否 [记住我]
`static void`	`login(java.lang.Object id, long timeout)` 会话登录，并指定此次登录token的有效期, 单位:秒
`static void`	`login(java.lang.Object id, SaLoginModel loginModel)` 会话登录，并指定所有登录参数Model
`static void`	`login(java.lang.Object id, java.lang.String device)` 会话登录，并指定登录设备类型
`static void`	`logout()` 会话注销
`static void`	`logout(java.lang.Object loginId)` 会话注销，根据账号id
`static void`	`logout(java.lang.Object loginId, java.lang.String device)` 会话注销，根据账号id 和设备类型
`static void`	`logoutByTokenValue(java.lang.String tokenValue)` 会话注销，根据指定 Token
`static void`	`openSafe(long safeTime)` 在当前会话开启二级认证
`static void`	`openSafe(java.lang.String service, long safeTime)` 在当前会话开启二级认证
`static void`	`renewTimeout(long timeout)` 对当前 Token 的 timeout 值进行续期
`static void`	`renewTimeout(java.lang.String tokenValue, long timeout)` 对指定 Token 的 timeout 值进行续期
`static void`	`replaced(java.lang.Object loginId, java.lang.String device)` 顶人下线，根据账号id 和设备类型当对方再次访问系统时，会抛出NotLoginException异常，场景值=-4
`static java.util.List<java.lang.String>`	`searchSessionId(java.lang.String keyword, int start, int size, boolean sortType)` 根据条件查询SessionId
`static java.util.List<java.lang.String>`	`searchTokenSessionId(java.lang.String keyword, int start, int size, boolean sortType)` 根据条件查询Token专属Session的Id
`static java.util.List<java.lang.String>`	`searchTokenValue(java.lang.String keyword, int start, int size, boolean sortType)` 根据条件查询Token
`static void`	`setStpLogic(StpLogic newStpLogic)` 重置 StpLogic 对象 1、更改此账户的 StpLogic 对象 2、put 到全局 StpLogic 集合中 3、发送日志
`static void`	`setTokenValue(java.lang.String tokenValue)` 在当前会话写入当前TokenValue
`static void`	`setTokenValue(java.lang.String tokenValue, int cookieTimeout)` 在当前会话写入当前TokenValue
`static void`	`setTokenValue(java.lang.String tokenValue, SaLoginModel loginModel)` 在当前会话写入当前TokenValue
`static void`	`switchTo(java.lang.Object loginId)` 临时切换身份为指定账号id
`static void`	`switchTo(java.lang.Object loginId, SaFunction function)` 在一个代码段里方法内，临时切换身份为指定账号id
`static void`	`untieDisable(java.lang.Object loginId)` 解封：指定账号
`static void`	`untieDisable(java.lang.Object loginId, java.lang.String... services)` 解封：指定账号、指定服务
`static void`	`updateLastActivityToNow()` 续签当前token：(将 [最后操作时间] 更新为当前时间戳) 请注意: 即使token已经 [临时过期] 也可续签成功，如果此场景下需要提示续签失败，可在此之前调用 checkActivityTimeout() 强制检查是否过期即可

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - TYPE
```
public static final java.lang.String TYPE
```
    账号类型标识
    
    另请参阅:
    
    常量字段值
  - stpLogic
```
public static StpLogic stpLogic
```
    底层的 StpLogic 对象
- 方法详细资料
  - getLoginType
```
public static java.lang.String getLoginType()
```
    获取当前 StpLogic 的账号类型
    
    返回:
    
    See Note
  - setStpLogic
```
public static void setStpLogic(StpLogic newStpLogic)
```
    重置 StpLogic 对象
    1、更改此账户的 StpLogic 对象
    2、put 到全局 StpLogic 集合中
    3、发送日志
    
    参数:
    
    newStpLogic - /
  - getStpLogic
```
public static StpLogic getStpLogic()
```
    获取 StpLogic 对象
    
    返回:
    
    /
  - getTokenName
```
public static java.lang.String getTokenName()
```
    返回token名称
    
    返回:
    
    此StpLogic的token名称
  - setTokenValue
```
public static void setTokenValue(java.lang.String tokenValue)
```
    在当前会话写入当前TokenValue
    
    参数:
    
    tokenValue - token值
  - setTokenValue
```
public static void setTokenValue(java.lang.String tokenValue,
                                 int cookieTimeout)
```
    在当前会话写入当前TokenValue
    
    参数:
    
    tokenValue - token值
    
    cookieTimeout - Cookie存活时间(秒)
  - setTokenValue
```
public static void setTokenValue(java.lang.String tokenValue,
                                 SaLoginModel loginModel)
```
    在当前会话写入当前TokenValue
    
    参数:
    
    tokenValue - token值
    
    loginModel - 登录参数
  - getTokenValue
```
public static java.lang.String getTokenValue()
```
    获取当前TokenValue
    
    返回:
    
    当前tokenValue
  - getTokenValueNotCut
```
public static java.lang.String getTokenValueNotCut()
```
    获取当前TokenValue (不裁剪前缀)
    
    返回:
    
    /
  - getTokenInfo
```
public static SaTokenInfo getTokenInfo()
```
    获取当前会话的Token信息
    
    返回:
    
    token信息
  - login
```
public static void login(java.lang.Object id)
```
    会话登录
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
  - login
```
public static void login(java.lang.Object id,
                         java.lang.String device)
```
    会话登录，并指定登录设备类型
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
    
    device - 设备类型
  - login
```
public static void login(java.lang.Object id,
                         boolean isLastingCookie)
```
    会话登录，并指定是否 [记住我]
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
    
    isLastingCookie - 是否为持久Cookie
  - login
```
public static void login(java.lang.Object id,
                         long timeout)
```
    会话登录，并指定此次登录token的有效期, 单位:秒
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
    
    timeout - 此次登录token的有效期, 单位:秒（如未指定，自动取全局配置的timeout值）
  - login
```
public static void login(java.lang.Object id,
                         SaLoginModel loginModel)
```
    会话登录，并指定所有登录参数Model
    
    参数:
    
    id - 登录id，建议的类型：（long | int | String）
    
    loginModel - 此次登录的参数Model
  - createLoginSession
```
public static java.lang.String createLoginSession(java.lang.Object id)
```
    创建指定账号id的登录会话
    
    参数:
    
    id - 登录id，建议的类型：（long | int | String）
    
    返回:
    
    返回会话令牌
  - createLoginSession
```
public static java.lang.String createLoginSession(java.lang.Object id,
                                                  SaLoginModel loginModel)
```
    创建指定账号id的登录会话
    
    参数:
    
    id - 登录id，建议的类型：（long | int | String）
    
    loginModel - 此次登录的参数Model
    
    返回:
    
    返回会话令牌
  - logout
```
public static void logout()
```
    会话注销
  - logout
```
public static void logout(java.lang.Object loginId)
```
    会话注销，根据账号id
    
    参数:
    
    loginId - 账号id
  - logout
```
public static void logout(java.lang.Object loginId,
                          java.lang.String device)
```
    会话注销，根据账号id 和设备类型
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表注销所有设备类型)
  - logoutByTokenValue
```
public static void logoutByTokenValue(java.lang.String tokenValue)
```
    会话注销，根据指定 Token
    
    参数:
    
    tokenValue - 指定token
  - kickout
```
public static void kickout(java.lang.Object loginId)
```
    踢人下线，根据账号id
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
    
    参数:
    
    loginId - 账号id
  - kickout
```
public static void kickout(java.lang.Object loginId,
                           java.lang.String device)
```
    踢人下线，根据账号id 和设备类型
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表踢出所有设备类型)
  - kickoutByTokenValue
```
public static void kickoutByTokenValue(java.lang.String tokenValue)
```
    踢人下线，根据指定 Token
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
    
    参数:
    
    tokenValue - 指定token
  - replaced
```
public static void replaced(java.lang.Object loginId,
                            java.lang.String device)
```
    顶人下线，根据账号id 和设备类型
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-4
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表顶替所有设备类型)
  - 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
  - getExtra
```
public static java.lang.Object getExtra(java.lang.String key)
```
    获取当前 Token 的扩展信息（此函数只在jwt模式下生效）
    
    参数:
    
    key - 键值
    
    返回:
    
    对应的扩展数据
  - getExtra
```
public static java.lang.Object getExtra(java.lang.String tokenValue,
                                        java.lang.String key)
```
    获取指定 Token 的扩展信息（此函数只在jwt模式下生效）
    
    参数:
    
    tokenValue - 指定的 Token 值
    
    key - 键值
    
    返回:
    
    对应的扩展数据
  - getSessionByLoginId
```
public static SaSession getSessionByLoginId(java.lang.Object loginId,
                                            boolean isCreate)
```
    获取指定账号id的Session, 如果Session尚未创建，isCreate=是否新建并返回
    
    参数:
    
    loginId - 账号id
    
    isCreate - 是否新建
    
    返回:
    
    Session对象
  - 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)
```
    获取指定账号id的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对象
  - getAnonTokenSession
```
public static SaSession getAnonTokenSession()
```
    获取当前匿名 Token-Session （可在未登录情况下使用的Token-Session）
    
    返回:
    
    Token-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()
```
    获取当前登录者的 User-Session 剩余有效时间 (单位: 秒)
    
    返回:
    
    token剩余有效时间
  - getTokenSessionTimeout
```
public static long getTokenSessionTimeout()
```
    获取当前 Token-Session 剩余有效时间 (单位: 秒)
    
    返回:
    
    token剩余有效时间
  - getTokenActivityTimeout
```
public static long getTokenActivityTimeout()
```
    获取当前 token [临时过期] 剩余有效时间 (单位: 秒)
    
    返回:
    
    token [临时过期] 剩余有效时间
  - renewTimeout
```
public static void renewTimeout(long timeout)
```
    对当前 Token 的 timeout 值进行续期
    
    参数:
    
    timeout - 要修改成为的有效时间 (单位: 秒)
  - renewTimeout
```
public static void renewTimeout(java.lang.String tokenValue,
                                long timeout)
```
    对指定 Token 的 timeout 值进行续期
    
    参数:
    
    tokenValue - 指定token
    
    timeout - 要修改成为的有效时间 (单位: 秒)
  - getRoleList
```
public static java.util.List<java.lang.String> getRoleList()
```
    获取：当前账号的角色集合
    
    返回:
    
    /
  - getRoleList
```
public static java.util.List<java.lang.String> getRoleList(java.lang.Object loginId)
```
    获取：指定账号的角色集合
    
    参数:
    
    loginId - 指定账号id
    
    返回:
    
    /
  - hasRole
```
public static boolean hasRole(java.lang.String role)
```
    判断：当前账号是否拥有指定角色, 返回true或false
    
    参数:
    
    role - 角色标识
    
    返回:
    
    是否含有指定角色标识
  - hasRole
```
public static boolean hasRole(java.lang.Object loginId,
                              java.lang.String role)
```
    判断：指定账号是否含有指定角色标识, 返回true或false
    
    参数:
    
    loginId - 账号id
    
    role - 角色标识
    
    返回:
    
    是否含有指定角色标识
  - hasRoleAnd
```
public static boolean hasRoleAnd(java.lang.String... roleArray)
```
    判断：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
    
    参数:
    
    roleArray - 角色标识数组
    
    返回:
    
    true或false
  - hasRoleOr
```
public static boolean hasRoleOr(java.lang.String... roleArray)
```
    判断：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
    
    参数:
    
    roleArray - 角色标识数组
    
    返回:
    
    true或false
  - checkRole
```
public static void checkRole(java.lang.String role)
```
    校验：当前账号是否含有指定角色标识, 如果验证未通过，则抛出异常: NotRoleException
    
    参数:
    
    role - 角色标识
  - checkRoleAnd
```
public static void checkRoleAnd(java.lang.String... roleArray)
```
    校验：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
    
    参数:
    
    roleArray - 角色标识数组
  - checkRoleOr
```
public static void checkRoleOr(java.lang.String... roleArray)
```
    校验：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
    
    参数:
    
    roleArray - 角色标识数组
  - getPermissionList
```
public static java.util.List<java.lang.String> getPermissionList()
```
    获取：当前账号的权限码集合
    
    返回:
    
    /
  - getPermissionList
```
public static java.util.List<java.lang.String> getPermissionList(java.lang.Object loginId)
```
    获取：指定账号的权限码集合
    
    参数:
    
    loginId - 指定账号id
    
    返回:
    
    /
  - hasPermission
```
public static boolean hasPermission(java.lang.String permission)
```
    判断：当前账号是否含有指定权限, 返回true或false
    
    参数:
    
    permission - 权限码
    
    返回:
    
    是否含有指定权限
  - hasPermission
```
public static boolean hasPermission(java.lang.Object loginId,
                                    java.lang.String permission)
```
    判断：指定账号id是否含有指定权限, 返回true或false
    
    参数:
    
    loginId - 账号id
    
    permission - 权限码
    
    返回:
    
    是否含有指定权限
  - hasPermissionAnd
```
public static boolean hasPermissionAnd(java.lang.String... permissionArray)
```
    判断：当前账号是否含有指定权限, [指定多个，必须全部具有]
    
    参数:
    
    permissionArray - 权限码数组
    
    返回:
    
    true 或 false
  - hasPermissionOr
```
public static boolean hasPermissionOr(java.lang.String... permissionArray)
```
    判断：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
    
    参数:
    
    permissionArray - 权限码数组
    
    返回:
    
    true 或 false
  - checkPermission
```
public static void checkPermission(java.lang.String permission)
```
    校验：当前账号是否含有指定权限, 如果验证未通过，则抛出异常: NotPermissionException
    
    参数:
    
    permission - 权限码
  - checkPermissionAnd
```
public static void checkPermissionAnd(java.lang.String... permissionArray)
```
    校验：当前账号是否含有指定权限 [指定多个，必须全部验证通过]
    
    参数:
    
    permissionArray - 权限码数组
  - checkPermissionOr
```
public static void checkPermissionOr(java.lang.String... permissionArray)
```
    校验：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
    
    参数:
    
    permissionArray - 权限码数组
  - getTokenValueByLoginId
```
public static java.lang.String getTokenValueByLoginId(java.lang.Object loginId)
```
    获取指定账号id的tokenValue
    在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    token值
  - getTokenValueByLoginId
```
public static java.lang.String getTokenValueByLoginId(java.lang.Object loginId,
                                                      java.lang.String device)
```
    获取指定账号id指定设备类型端的tokenValue
    在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型
    
    返回:
    
    token值
  - getTokenValueListByLoginId
```
public static java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId)
```
    获取指定账号id的tokenValue集合
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    此loginId的所有相关token
  - getTokenValueListByLoginId
```
public static java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId,
                                                                          java.lang.String device)
```
    获取指定账号id指定设备类型端的tokenValue 集合
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型
    
    返回:
    
    此loginId的所有相关token
  - getLoginDevice
```
public static java.lang.String getLoginDevice()
```
    返回当前会话的登录设备类型
    
    返回:
    
    当前令牌的登录设备类型
  - searchTokenValue
```
public static java.util.List<java.lang.String> searchTokenValue(java.lang.String keyword,
                                                                int start,
                                                                int size,
                                                                boolean sortType)
```
    根据条件查询Token
    
    参数:
    
    keyword - 关键字
    
    start - 开始处索引
    
    size - 获取数量 (-1代表一直获取到末尾)
    
    sortType - 排序类型（true=正序，false=反序）
    
    返回:
    
    token集合
  - searchSessionId
```
public static java.util.List<java.lang.String> searchSessionId(java.lang.String keyword,
                                                               int start,
                                                               int size,
                                                               boolean sortType)
```
    根据条件查询SessionId
    
    参数:
    
    keyword - 关键字
    
    start - 开始处索引
    
    size - 获取数量 (-1代表一直获取到末尾)
    
    sortType - 排序类型（true=正序，false=反序）
    
    返回:
    
    sessionId集合
  - searchTokenSessionId
```
public static java.util.List<java.lang.String> searchTokenSessionId(java.lang.String keyword,
                                                                    int start,
                                                                    int size,
                                                                    boolean sortType)
```
    根据条件查询Token专属Session的Id
    
    参数:
    
    keyword - 关键字
    
    start - 开始处索引
    
    size - 获取数量 (-1代表一直获取到末尾)
    
    sortType - 排序类型（true=正序，false=反序）
    
    返回:
    
    sessionId集合
  - disable
```
public static void disable(java.lang.Object loginId,
                           long time)
```
    封禁：指定账号
    此方法不会直接将此账号id踢下线，如需封禁后立即掉线，请追加调用 StpUtil.logout(id)
    
    参数:
    
    loginId - 指定账号id
    
    time - 封禁时间, 单位: 秒（-1=永久封禁）
  - isDisable
```
public static boolean isDisable(java.lang.Object loginId)
```
    判断：指定账号是否已被封禁 (true=已被封禁, false=未被封禁)
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    /
  - checkDisable
```
public static void checkDisable(java.lang.Object loginId)
```
    校验：指定账号是否已被封禁，如果被封禁则抛出异常
    
    参数:
    
    loginId - 账号id
  - getDisableTime
```
public static long getDisableTime(java.lang.Object loginId)
```
    获取：指定账号剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    /
  - untieDisable
```
public static void untieDisable(java.lang.Object loginId)
```
    解封：指定账号
    
    参数:
    
    loginId - 账号id
  - disable
```
public static void disable(java.lang.Object loginId,
                           java.lang.String service,
                           long time)
```
    封禁：指定账号的指定服务
    此方法不会直接将此账号id踢下线，如需封禁后立即掉线，请追加调用 StpUtil.logout(id)
    
    参数:
    
    loginId - 指定账号id
    
    service - 指定服务
    
    time - 封禁时间, 单位: 秒（-1=永久封禁）
  - isDisable
```
public static boolean isDisable(java.lang.Object loginId,
                                java.lang.String service)
```
    判断：指定账号的指定服务是否已被封禁 (true=已被封禁, false=未被封禁)
    
    参数:
    
    loginId - 账号id
    
    service - 指定服务
    
    返回:
    
    /
  - checkDisable
```
public static void checkDisable(java.lang.Object loginId,
                                java.lang.String... services)
```
    校验：指定账号指定服务是否已被封禁，如果被封禁则抛出异常
    
    参数:
    
    loginId - 账号id
    
    services - 指定服务，可以指定多个
  - getDisableTime
```
public static long getDisableTime(java.lang.Object loginId,
                                  java.lang.String service)
```
    获取：指定账号指定服务剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
    
    参数:
    
    loginId - 账号id
    
    service - 指定服务
    
    返回:
    
    see note
  - untieDisable
```
public static void untieDisable(java.lang.Object loginId,
                                java.lang.String... services)
```
    解封：指定账号、指定服务
    
    参数:
    
    loginId - 账号id
    
    services - 指定服务，可以指定多个
  - disableLevel
```
public static void disableLevel(java.lang.Object loginId,
                                int level,
                                long time)
```
    封禁：指定账号，并指定封禁等级
    
    参数:
    
    loginId - 指定账号id
    
    level - 指定封禁等级
    
    time - 封禁时间, 单位: 秒（-1=永久封禁）
  - disableLevel
```
public static void disableLevel(java.lang.Object loginId,
                                java.lang.String service,
                                int level,
                                long time)
```
    封禁：指定账号的指定服务，并指定封禁等级
    
    参数:
    
    loginId - 指定账号id
    
    service - 指定封禁服务
    
    level - 指定封禁等级
    
    time - 封禁时间, 单位: 秒（-1=永久封禁）
  - isDisableLevel
```
public static boolean isDisableLevel(java.lang.Object loginId,
                                     int level)
```
    判断：指定账号是否已被封禁到指定等级
    
    参数:
    
    loginId - 指定账号id
    
    level - 指定封禁等级
    
    返回:
    
    /
  - isDisableLevel
```
public static boolean isDisableLevel(java.lang.Object loginId,
                                     java.lang.String service,
                                     int level)
```
    判断：指定账号的指定服务，是否已被封禁到指定等级
    
    参数:
    
    loginId - 指定账号id
    
    service - 指定封禁服务
    
    level - 指定封禁等级
    
    返回:
    
    /
  - checkDisableLevel
```
public static void checkDisableLevel(java.lang.Object loginId,
                                     int level)
```
    校验：指定账号是否已被封禁到指定等级（如果已经达到，则抛出异常）
    
    参数:
    
    loginId - 指定账号id
    
    level - 封禁等级（只有封禁等级 ≥ 此值才会抛出异常）
  - checkDisableLevel
```
public static void checkDisableLevel(java.lang.Object loginId,
                                     java.lang.String service,
                                     int level)
```
    校验：指定账号的指定服务，是否已被封禁到指定等级（如果已经达到，则抛出异常）
    
    参数:
    
    loginId - 指定账号id
    
    service - 指定封禁服务
    
    level - 封禁等级（只有封禁等级 ≥ 此值才会抛出异常）
  - getDisableLevel
```
public static int getDisableLevel(java.lang.Object loginId)
```
    获取：指定账号被封禁的等级，如果未被封禁则返回-2
    
    参数:
    
    loginId - 指定账号id
    
    返回:
    
    /
  - getDisableLevel
```
public static int getDisableLevel(java.lang.Object loginId,
                                  java.lang.String service)
```
    获取：指定账号的指定服务被封禁的等级，如果未被封禁则返回-2
    
    参数:
    
    loginId - 指定账号id
    
    service - 指定封禁服务
    
    返回:
    
    /
  - switchTo
```
public static void switchTo(java.lang.Object loginId)
```
    临时切换身份为指定账号id
    
    参数:
    
    loginId - 指定loginId
  - endSwitch
```
public static void endSwitch()
```
    结束临时切换身份
  - isSwitch
```
public static boolean isSwitch()
```
    当前是否正处于[身份临时切换]中
    
    返回:
    
    是否正处于[身份临时切换]中
  - switchTo
```
public static void switchTo(java.lang.Object loginId,
                            SaFunction function)
```
    在一个代码段里方法内，临时切换身份为指定账号id
    
    参数:
    
    loginId - 指定账号id
    
    function - 要执行的方法
  - openSafe
```
public static void openSafe(long safeTime)
```
    在当前会话开启二级认证
    
    参数:
    
    safeTime - 维持时间 (单位: 秒)
  - openSafe
```
public static void openSafe(java.lang.String service,
                            long safeTime)
```
    在当前会话开启二级认证
    
    参数:
    
    service - 业务标识
    
    safeTime - 维持时间 (单位: 秒)
  - isSafe
```
public static boolean isSafe()
```
    当前会话是否处于二级认证时间内
    
    返回:
    
    true=二级认证已通过, false=尚未进行二级认证或认证已超时
  - isSafe
```
public static boolean isSafe(java.lang.String service)
```
    当前会话是否处于二级认证时间内
    
    参数:
    
    service - 业务标识
    
    返回:
    
    true=二级认证已通过, false=尚未进行二级认证或认证已超时
  - isSafe
```
public static boolean isSafe(java.lang.String tokenValue,
                             java.lang.String service)
```
    指定 Token 是否处于二级认证时间内
    
    参数:
    
    tokenValue - Token 值
    
    service - 业务标识
    
    返回:
    
    true=二级认证已通过, false=尚未进行二级认证或认证已超时
  - checkSafe
```
public static void checkSafe()
```
    检查当前会话是否已通过二级认证，如未通过则抛出异常
  - checkSafe
```
public static void checkSafe(java.lang.String service)
```
    检查当前会话是否已通过二级认证，如未通过则抛出异常
    
    参数:
    
    service - 业务标识
  - getSafeTime
```
public static long getSafeTime()
```
    获取当前会话的二级认证剩余有效时间 (单位: 秒, 返回-2代表尚未通过二级认证)
    
    返回:
    
    剩余有效时间
  - getSafeTime
```
public static long getSafeTime(java.lang.String service)
```
    获取当前会话的二级认证剩余有效时间 (单位: 秒, 返回-2代表尚未通过二级认证)
    
    参数:
    
    service - 业务标识
    
    返回:
    
    剩余有效时间
  - closeSafe
```
public static void closeSafe()
```
    在当前会话结束二级认证
  - closeSafe
```
public static void closeSafe(java.lang.String service)
```
    在当前会话结束二级认证
    
    参数:
    
    service - 业务标识

类 StpUtil

字段概要

方法概要

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

字段详细资料

TYPE

stpLogic

方法详细资料

getLoginType

setStpLogic

getStpLogic

getTokenName

setTokenValue

setTokenValue

setTokenValue

getTokenValue

getTokenValueNotCut

getTokenInfo

login

login

login

login

login

createLoginSession

createLoginSession

logout

logout

logout

logoutByTokenValue

kickout

kickout

kickoutByTokenValue

replaced

isLogin

checkLogin

getLoginId

getLoginId

getLoginIdDefaultNull

getLoginIdAsString

getLoginIdAsInt

getLoginIdAsLong

getLoginIdByToken

getExtra

getExtra

getSessionByLoginId

getSessionBySessionId

getSessionByLoginId

getSession

getSession

getTokenSessionByToken

getTokenSession

getAnonTokenSession

checkActivityTimeout

updateLastActivityToNow

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

getTokenTimeout

getSessionTimeout

getTokenSessionTimeout

getTokenActivityTimeout

renewTimeout

renewTimeout

getRoleList

getRoleList

hasRole

hasRole

hasRoleAnd

hasRoleOr

checkRole

checkRoleAnd

checkRoleOr

getPermissionList

getPermissionList

hasPermission

hasPermission

hasPermissionAnd

hasPermissionOr

checkPermission

checkPermissionAnd

checkPermissionOr

getTokenValueByLoginId

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