StpLogic (sa-token-core 1.30.0.RC API)

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

```
public class StpLogic
extends java.lang.Object
```
Sa-Token 权限认证，逻辑实现类

作者:

kong

字段概要

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

java.lang.String loginType
账号类型，多账号体系时以此值区分，比如：login、user、admin

字段
限定符和类型	字段和说明
`java.lang.String`	`loginType` 账号类型，多账号体系时以此值区分，比如：login、user、admin

构造器概要

构造器
构造器和说明

StpLogic(java.lang.String loginType)
初始化StpLogic, 并指定账号类型

构造器
构造器和说明
`StpLogic(java.lang.String loginType)` 初始化StpLogic, 并指定账号类型

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`checkActivityTimeout()` 检查当前token 是否已经[临时过期]，如果已经过期则抛出异常
`void`	`checkActivityTimeout(java.lang.String tokenValue)` 检查指定token 是否已经[临时过期]，如果已经过期则抛出异常
`void`	`checkByAnnotation(SaCheckLogin at)` 根据注解(@SaCheckLogin)鉴权
`void`	`checkByAnnotation(SaCheckPermission at)` 根据注解(@SaCheckPermission)鉴权
`void`	`checkByAnnotation(SaCheckRole at)` 根据注解(@SaCheckRole)鉴权
`void`	`checkByAnnotation(SaCheckSafe at)` 根据注解(@SaCheckSafe)鉴权
`void`	`checkLogin()` 检验当前会话是否已经登录，如未登录，则抛出异常
`void`	`checkPermission(java.lang.String permission)` 校验：当前账号是否含有指定权限, 如果验证未通过，则抛出异常: NotPermissionException
`void`	`checkPermissionAnd(java.lang.String... permissionArray)` 校验：当前账号是否含有指定权限 [指定多个，必须全部验证通过]
`void`	`checkPermissionOr(java.lang.String... permissionArray)` 校验：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
`void`	`checkRole(java.lang.String role)` 校验：当前账号是否含有指定角色标识, 如果验证未通过，则抛出异常: NotRoleException
`void`	`checkRoleAnd(java.lang.String... roleArray)` 校验：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
`void`	`checkRoleOr(java.lang.String... roleArray)` 校验：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
`void`	`checkSafe()` 检查当前会话是否已通过二级认证，如未通过则抛出异常
`protected void`	`clearLastActivity(java.lang.String tokenValue)` 清除指定token的 [最后操作时间]
`void`	`closeSafe()` 在当前会话结束二级认证
`java.lang.String`	`createLoginSession(java.lang.Object id)` 创建指定账号id的登录会话
`java.lang.String`	`createLoginSession(java.lang.Object id, SaLoginModel loginModel)` 创建指定账号id的登录会话
`java.lang.String`	`createTokenValue(java.lang.Object loginId, java.lang.String device, long timeout)` 已过时。
`java.lang.String`	`createTokenValue(java.lang.Object loginId, java.lang.String device, long timeout, java.util.Map<java.lang.String,java.lang.Object> extraData)` 创建一个TokenValue
`void`	`deleteTokenSession(java.lang.String tokenValue)` 删除Token-Session
`void`	`deleteTokenToIdMapping(java.lang.String tokenValue)` 删除 Token-Id 映射
`void`	`disable(java.lang.Object loginId, long disableTime)` 封禁指定账号此方法不会直接将此账号id踢下线，而是在对方再次登录时抛出`DisableLoginException`异常
`void`	`endSwitch()` 结束临时切换身份
`SaTokenConfig`	`getConfig()` 返回全局配置对象
`boolean`	`getConfigOfIsShare()` 返回全局配置对象的isShare属性
`long`	`getDisableTime(java.lang.Object loginId)` 获取指定账号剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
`java.lang.Object`	`getExtra(java.lang.String key)` 获取Token扩展信息（只在jwt模式下有效）
`java.lang.String`	`getLoginDevice()` 返回当前会话的登录设备类型
`java.lang.Object`	`getLoginId()` 获取当前会话账号id, 如果未登录，则抛出异常
`<T> T`	`getLoginId(T defaultValue)` 获取当前会话账号id, 如果未登录，则返回默认值
`int`	`getLoginIdAsInt()` 获取当前会话账号id, 并转换为int类型
`long`	`getLoginIdAsLong()` 获取当前会话账号id, 并转换为long类型
`java.lang.String`	`getLoginIdAsString()` 获取当前会话账号id, 并转换为String类型
`java.lang.Object`	`getLoginIdByToken(java.lang.String tokenValue)` 获取指定Token对应的账号id，如果未登录，则返回 null
`java.lang.Object`	`getLoginIdDefaultNull()` 获取当前会话账号id, 如果未登录，则返回null
`java.lang.String`	`getLoginIdNotHandle(java.lang.String tokenValue)` 获取指定Token对应的账号id (不做任何特殊处理)
`java.lang.String`	`getLoginType()` 获取当前 StpLogic 的账号类型
`java.util.List<java.lang.String>`	`getPermissionList()` 获取：当前账号的权限码集合
`java.util.List<java.lang.String>`	`getPermissionList(java.lang.Object loginId)` 获取：指定账号的权限码集合
`java.util.List<java.lang.String>`	`getRoleList()` 获取：当前账号的角色集合
`java.util.List<java.lang.String>`	`getRoleList(java.lang.Object loginId)` 获取：指定账号的角色集合
`long`	`getSafeTime()` 获取当前会话的二级认证剩余有效时间 (单位: 秒, 返回-2代表尚未通过二级认证)
`SaTokenDao`	`getSaTokenDao()` 返回持久化对象
`SaSession`	`getSession()` 获取当前User-Session，如果Session尚未创建，则新建并返回
`SaSession`	`getSession(boolean isCreate)` 获取当前User-Session, 如果Session尚未创建，isCreate=是否新建并返回
`SaSession`	`getSessionByLoginId(java.lang.Object loginId)` 获取指定账号id的User-Session，如果Session尚未创建，则新建并返回
`SaSession`	`getSessionByLoginId(java.lang.Object loginId, boolean isCreate)` 获取指定账号id的User-Session, 如果Session尚未创建，isCreate=是否新建并返回
`SaSession`	`getSessionBySessionId(java.lang.String sessionId)` 获取指定key的Session, 如果Session尚未创建，则返回null
`SaSession`	`getSessionBySessionId(java.lang.String sessionId, boolean isCreate)` 获取指定key的Session, 如果Session尚未创建，isCreate=是否新建并返回
`long`	`getSessionTimeout()` 获取当前登录者的 User-Session 剩余有效时间 (单位: 秒)
`long`	`getSessionTimeoutByLoginId(java.lang.Object loginId)` 获取指定 loginId 的 User-Session 剩余有效时间 (单位: 秒)
`java.lang.Object`	`getSwitchLoginId()` 返回[身份临时切换]的loginId
`long`	`getTokenActivityTimeout()` 获取当前 token [临时过期] 剩余有效时间 (单位: 秒)
`long`	`getTokenActivityTimeoutByToken(java.lang.String tokenValue)` 获取指定 token [临时过期] 剩余有效时间 (单位: 秒)
`SaTokenInfo`	`getTokenInfo()` 获取当前会话的Token信息
`java.lang.String`	`getTokenName()` 返回token名称
`SaSession`	`getTokenSession()` 获取当前Token-Session，如果Session尚未创建，则新建并返回
`SaSession`	`getTokenSession(boolean isCreate)` 获取当前Token-Session，如果Session尚未创建，isCreate代表是否新建并返回
`SaSession`	`getTokenSessionByToken(java.lang.String tokenValue)` 获取指定Token-Session，如果Session尚未创建，则新建并返回
`SaSession`	`getTokenSessionByToken(java.lang.String tokenValue, boolean isCreate)` 获取指定Token-Session，如果Session尚未创建，isCreate代表是否新建并返回
`long`	`getTokenSessionTimeout()` 获取当前 Token-Session 剩余有效时间 (单位: 秒)
`long`	`getTokenSessionTimeoutByTokenValue(java.lang.String tokenValue)` 获取指定 Token-Session 剩余有效时间 (单位: 秒)
`long`	`getTokenTimeout()` 获取当前登录者的 token 剩余有效时间 (单位: 秒)
`long`	`getTokenTimeoutByLoginId(java.lang.Object loginId)` 获取指定 loginId 的 token 剩余有效时间 (单位: 秒)
`java.lang.String`	`getTokenValue()` 获取当前TokenValue
`java.lang.String`	`getTokenValueByLoginId(java.lang.Object loginId)` 获取指定账号id的tokenValue 在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
`java.lang.String`	`getTokenValueByLoginId(java.lang.Object loginId, java.lang.String device)` 获取指定账号id指定设备类型端的tokenValue 在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
`java.util.List<java.lang.String>`	`getTokenValueListByLoginId(java.lang.Object loginId)` 获取指定账号id的tokenValue集合
`java.util.List<java.lang.String>`	`getTokenValueListByLoginId(java.lang.Object loginId, java.lang.String device)` 获取指定账号id指定设备类型端的tokenValue 集合
`java.lang.String`	`getTokenValueNotCut()` 获取当前TokenValue (不裁剪前缀)
`boolean`	`hasElement(java.util.List<java.lang.String> list, java.lang.String element)` 判断：集合中是否包含指定元素（模糊匹配）
`boolean`	`hasPermission(java.lang.Object loginId, java.lang.String permission)` 判断：指定账号id是否含有指定权限, 返回true或false
`boolean`	`hasPermission(java.lang.String permission)` 判断：当前账号是否含有指定权限, 返回true或false
`boolean`	`hasPermissionAnd(java.lang.String... permissionArray)` 判断：当前账号是否含有指定权限, [指定多个，必须全部具有]
`boolean`	`hasPermissionOr(java.lang.String... permissionArray)` 判断：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
`boolean`	`hasRole(java.lang.Object loginId, java.lang.String role)` 判断：指定账号是否含有指定角色标识, 返回true或false
`boolean`	`hasRole(java.lang.String role)` 判断：当前账号是否拥有指定角色, 返回true或false
`boolean`	`hasRoleAnd(java.lang.String... roleArray)` 判断：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
`boolean`	`hasRoleOr(java.lang.String... roleArray)` 判断：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
`boolean`	`isDisable(java.lang.Object loginId)` 指定账号是否已被封禁 (true=已被封禁, false=未被封禁)
`boolean`	`isLogin()` 当前会话是否已经登录
`boolean`	`isOpenActivityCheck()` 返回全局配置是否开启了Token 活跃校验
`boolean`	`isSafe()` 当前会话是否处于二级认证时间内
`boolean`	`isSwitch()` 当前是否正处于[身份临时切换]中
`boolean`	`isValidLoginId(java.lang.Object loginId)` 判断一个 loginId 是否是有效的
`void`	`kickout(java.lang.Object loginId)` 踢人下线，根据账号id 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
`void`	`kickout(java.lang.Object loginId, java.lang.String device)` 踢人下线，根据账号id 和设备类型当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
`void`	`kickoutByTokenValue(java.lang.String tokenValue)` 踢人下线，根据指定 Token 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
`void`	`login(java.lang.Object id)` 会话登录
`void`	`login(java.lang.Object id, boolean isLastingCookie)` 会话登录，并指定是否 [记住我]
`void`	`login(java.lang.Object id, SaLoginModel loginModel)` 会话登录，并指定所有登录参数Model
`void`	`login(java.lang.Object id, java.lang.String device)` 会话登录，并指定登录设备类型
`void`	`logout()` 会话注销
`void`	`logout(java.lang.Object loginId)` 会话注销，根据账号id
`void`	`logout(java.lang.Object loginId, java.lang.String device)` 会话注销，根据账号id 和设备类型
`void`	`logoutByLoginId(java.lang.Object loginId)` 已过时。
`void`	`logoutByLoginId(java.lang.Object loginId, java.lang.String device)` 已过时。
`void`	`logoutByMaxLoginCount(java.lang.Object loginId, SaSession session, java.lang.String device, int maxLoginCount)` 会话注销，根据账号id 和设备类型和最大同时在线数量
`void`	`logoutByTokenValue(java.lang.String tokenValue)` 会话注销，根据指定 Token
`void`	`openSafe(long safeTime)` 在当前会话开启二级认证
`void`	`renewTimeout(long timeout)` 对当前 Token 的 timeout 值进行续期
`void`	`renewTimeout(java.lang.String tokenValue, long timeout)` 对指定 Token 的 timeout 值进行续期
`void`	`replaced(java.lang.Object loginId, java.lang.String device)` 顶人下线，根据账号id 和设备类型当对方再次访问系统时，会抛出NotLoginException异常，场景值=-4
`void`	`saveTokenToIdMapping(java.lang.String tokenValue, java.lang.Object loginId, long timeout)` 存储 Token-Id 映射
`java.util.List<java.lang.String>`	`searchSessionId(java.lang.String keyword, int start, int size)` 根据条件查询SessionId
`java.util.List<java.lang.String>`	`searchTokenSessionId(java.lang.String keyword, int start, int size)` 根据条件查询Token专属Session的Id
`java.util.List<java.lang.String>`	`searchTokenValue(java.lang.String keyword, int start, int size)` 根据条件查询Token
`protected void`	`setLastActivityToNow(java.lang.String tokenValue)` 写入指定token的 [最后操作时间] 为当前时间戳
`StpLogic`	`setLoginType(java.lang.String loginType)` 设置当前账号类型
`void`	`setTokenValue(java.lang.String tokenValue)` 在当前会话写入当前TokenValue
`void`	`setTokenValue(java.lang.String tokenValue, int cookieTimeout)` 在当前会话写入当前TokenValue
`void`	`setTokenValueToCookie(java.lang.String tokenValue, int cookieTimeout)` 将 Token 保存到 [Cookie] 里
`void`	`setTokenValueToStorage(java.lang.String tokenValue)` 将 Token 保存到 [Storage] 里
`java.lang.String`	`splicingKeyDisable(java.lang.Object loginId)` 拼接key：账号封禁
`java.lang.String`	`splicingKeyJustCreatedSave()` 如果token为本次请求新创建的，则以此字符串为key存储在当前request中
`java.lang.String`	`splicingKeyLastActivityTime(java.lang.String tokenValue)` 拼接key：指定token的最后操作时间持久化
`java.lang.String`	`splicingKeySession(java.lang.Object loginId)` 拼接key： Session 持久化
`java.lang.String`	`splicingKeySwitch()` 在进行身份切换时，使用的存储key
`java.lang.String`	`splicingKeyTokenName()` 拼接key：客户端 tokenName
`java.lang.String`	`splicingKeyTokenSession(java.lang.String tokenValue)` 拼接key： tokenValue的Token-Session
`java.lang.String`	`splicingKeyTokenValue(java.lang.String tokenValue)` 拼接key： tokenValue 持久化 token-id
`void`	`switchTo(java.lang.Object loginId)` 临时切换身份为指定账号id
`void`	`switchTo(java.lang.Object loginId, SaFunction function)` 在一个代码段里方法内，临时切换身份为指定账号id
`void`	`untieDisable(java.lang.Object loginId)` 解封指定账号
`void`	`updateLastActivityToNow()` 续签当前token：(将 [最后操作时间] 更新为当前时间戳) 请注意: 即使token已经 [临时过期] 也可续签成功，如果此场景下需要提示续签失败，可在此之前调用 checkActivityTimeout() 强制检查是否过期即可
`void`	`updateLastActivityToNow(java.lang.String tokenValue)` 续签指定token：(将 [最后操作时间] 更新为当前时间戳)
`void`	`updateTokenToIdMapping(java.lang.String tokenValue, java.lang.Object loginId)` 更改 Token 指向的账号Id 值

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

- 字段详细资料
  - loginType
```
public java.lang.String loginType
```
    账号类型，多账号体系时以此值区分，比如：login、user、admin
- 构造器详细资料
  - StpLogic
```
public StpLogic(java.lang.String loginType)
```
    初始化StpLogic, 并指定账号类型
    
    参数:
    
    loginType - 账号体系标识
- 方法详细资料
  - getLoginType
```
public java.lang.String getLoginType()
```
    获取当前 StpLogic 的账号类型
    
    返回:
    
    See Note
  - setLoginType
```
public StpLogic setLoginType(java.lang.String loginType)
```
    设置当前账号类型
    
    参数:
    
    loginType - loginType
    
    返回:
    
    对象自身
  - getTokenName
```
public java.lang.String getTokenName()
```
    返回token名称
    
    返回:
    
    此StpLogic的token名称
  - createTokenValue
```
public java.lang.String createTokenValue(java.lang.Object loginId,
                                         java.lang.String device,
                                         long timeout,
                                         java.util.Map<java.lang.String,java.lang.Object> extraData)
```
    创建一个TokenValue
    
    参数:
    
    loginId - loginId
    
    device - 设备类型
    
    timeout - 过期时间
    
    extraData - 扩展信息
    
    返回:
    
    生成的tokenValue
  - setTokenValue
```
public void setTokenValue(java.lang.String tokenValue)
```
    在当前会话写入当前TokenValue
    
    参数:
    
    tokenValue - token值
  - setTokenValue
```
public void setTokenValue(java.lang.String tokenValue,
                          int cookieTimeout)
```
    在当前会话写入当前TokenValue
    
    参数:
    
    tokenValue - token值
    
    cookieTimeout - Cookie存活时间(秒)
  - setTokenValueToStorage
```
public void setTokenValueToStorage(java.lang.String tokenValue)
```
    将 Token 保存到 [Storage] 里
    
    参数:
    
    tokenValue - token值
  - setTokenValueToCookie
```
public void setTokenValueToCookie(java.lang.String tokenValue,
                                  int cookieTimeout)
```
    将 Token 保存到 [Cookie] 里
    
    参数:
    
    tokenValue - token值
    
    cookieTimeout - Cookie存活时间(秒)
  - getTokenValue
```
public java.lang.String getTokenValue()
```
    获取当前TokenValue
    
    返回:
    
    当前tokenValue
  - getTokenValueNotCut
```
public java.lang.String getTokenValueNotCut()
```
    获取当前TokenValue (不裁剪前缀)
    
    返回:
    
    /
  - getTokenInfo
```
public SaTokenInfo getTokenInfo()
```
    获取当前会话的Token信息
    
    返回:
    
    token信息
  - login
```
public void login(java.lang.Object id)
```
    会话登录
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
  - login
```
public void login(java.lang.Object id,
                  java.lang.String device)
```
    会话登录，并指定登录设备类型
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
    
    device - 设备类型
  - login
```
public void login(java.lang.Object id,
                  boolean isLastingCookie)
```
    会话登录，并指定是否 [记住我]
    
    参数:
    
    id - 账号id，建议的类型：（long | int | String）
    
    isLastingCookie - 是否为持久Cookie
  - login
```
public void login(java.lang.Object id,
                  SaLoginModel loginModel)
```
    会话登录，并指定所有登录参数Model
    
    参数:
    
    id - 登录id，建议的类型：（long | int | String）
    
    loginModel - 此次登录的参数Model
  - createLoginSession
```
public java.lang.String createLoginSession(java.lang.Object id)
```
    创建指定账号id的登录会话
    
    参数:
    
    id - 登录id，建议的类型：（long | int | String）
    
    返回:
    
    返回会话令牌
  - createLoginSession
```
public java.lang.String createLoginSession(java.lang.Object id,
                                           SaLoginModel loginModel)
```
    创建指定账号id的登录会话
    
    参数:
    
    id - 登录id，建议的类型：（long | int | String）
    
    loginModel - 此次登录的参数Model
    
    返回:
    
    返回会话令牌
  - logout
```
public void logout()
```
    会话注销
  - logout
```
public void logout(java.lang.Object loginId)
```
    会话注销，根据账号id
    
    参数:
    
    loginId - 账号id
  - logout
```
public void logout(java.lang.Object loginId,
                   java.lang.String device)
```
    会话注销，根据账号id 和设备类型
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表注销所有设备类型)
  - logoutByMaxLoginCount
```
public void logoutByMaxLoginCount(java.lang.Object loginId,
                                  SaSession session,
                                  java.lang.String device,
                                  int maxLoginCount)
```
    会话注销，根据账号id 和设备类型和最大同时在线数量
    
    参数:
    
    loginId - 账号id
    
    session - 此账号的 Session 对象，可填写null，框架将自动获取
    
    device - 设备类型 (填null代表注销所有设备类型)
    
    maxLoginCount - 保留最近的几次登录
  - logoutByTokenValue
```
public void logoutByTokenValue(java.lang.String tokenValue)
```
    会话注销，根据指定 Token
    
    参数:
    
    tokenValue - 指定token
  - kickout
```
public void kickout(java.lang.Object loginId)
```
    踢人下线，根据账号id
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
    
    参数:
    
    loginId - 账号id
  - kickout
```
public void kickout(java.lang.Object loginId,
                    java.lang.String device)
```
    踢人下线，根据账号id 和设备类型
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表踢出所有设备类型)
  - kickoutByTokenValue
```
public void kickoutByTokenValue(java.lang.String tokenValue)
```
    踢人下线，根据指定 Token
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5
    
    参数:
    
    tokenValue - 指定token
  - replaced
```
public void replaced(java.lang.Object loginId,
                     java.lang.String device)
```
    顶人下线，根据账号id 和设备类型
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-4
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表顶替所有设备类型)
  - isLogin
```
public boolean isLogin()
```
    当前会话是否已经登录
    
    返回:
    
    是否已登录
  - checkLogin
```
public void checkLogin()
```
    检验当前会话是否已经登录，如未登录，则抛出异常
  - getLoginId
```
public java.lang.Object getLoginId()
```
    获取当前会话账号id, 如果未登录，则抛出异常
    
    返回:
    
    账号id
  - getLoginId
```
public <T> T getLoginId(T defaultValue)
```
    获取当前会话账号id, 如果未登录，则返回默认值
    
    类型参数:
    
    T - 返回类型
    
    参数:
    
    defaultValue - 默认值
    
    返回:
    
    登录id
  - getLoginIdDefaultNull
```
public java.lang.Object getLoginIdDefaultNull()
```
    获取当前会话账号id, 如果未登录，则返回null
    
    返回:
    
    账号id
  - getLoginIdAsString
```
public java.lang.String getLoginIdAsString()
```
    获取当前会话账号id, 并转换为String类型
    
    返回:
    
    账号id
  - getLoginIdAsInt
```
public int getLoginIdAsInt()
```
    获取当前会话账号id, 并转换为int类型
    
    返回:
    
    账号id
  - getLoginIdAsLong
```
public long getLoginIdAsLong()
```
    获取当前会话账号id, 并转换为long类型
    
    返回:
    
    账号id
  - getLoginIdByToken
```
public java.lang.Object getLoginIdByToken(java.lang.String tokenValue)
```
    获取指定Token对应的账号id，如果未登录，则返回 null
    
    参数:
    
    tokenValue - token
    
    返回:
    
    账号id
  - getLoginIdNotHandle
```
public java.lang.String getLoginIdNotHandle(java.lang.String tokenValue)
```
    获取指定Token对应的账号id (不做任何特殊处理)
    
    参数:
    
    tokenValue - token值
    
    返回:
    
    账号id
  - getExtra
```
public java.lang.Object getExtra(java.lang.String key)
```
    获取Token扩展信息（只在jwt模式下有效）
    
    参数:
    
    key - 键值
    
    返回:
    
    对应的扩展数据
  - isValidLoginId
```
public boolean isValidLoginId(java.lang.Object loginId)
```
    判断一个 loginId 是否是有效的
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    /
  - deleteTokenToIdMapping
```
public void deleteTokenToIdMapping(java.lang.String tokenValue)
```
    删除 Token-Id 映射
    
    参数:
    
    tokenValue - token值
  - updateTokenToIdMapping
```
public void updateTokenToIdMapping(java.lang.String tokenValue,
                                   java.lang.Object loginId)
```
    更改 Token 指向的账号Id 值
    
    参数:
    
    tokenValue - token值
    
    loginId - 新的账号Id值
  - saveTokenToIdMapping
```
public void saveTokenToIdMapping(java.lang.String tokenValue,
                                 java.lang.Object loginId,
                                 long timeout)
```
    存储 Token-Id 映射
    
    参数:
    
    tokenValue - token值
    
    loginId - 账号id
    
    timeout - 会话有效期 (单位: 秒)
  - getSessionBySessionId
```
public SaSession getSessionBySessionId(java.lang.String sessionId,
                                       boolean isCreate)
```
    获取指定key的Session, 如果Session尚未创建，isCreate=是否新建并返回
    
    参数:
    
    sessionId - SessionId
    
    isCreate - 是否新建
    
    返回:
    
    Session对象
  - getSessionBySessionId
```
public SaSession getSessionBySessionId(java.lang.String sessionId)
```
    获取指定key的Session, 如果Session尚未创建，则返回null
    
    参数:
    
    sessionId - SessionId
    
    返回:
    
    Session对象
  - getSessionByLoginId
```
public SaSession getSessionByLoginId(java.lang.Object loginId,
                                     boolean isCreate)
```
    获取指定账号id的User-Session, 如果Session尚未创建，isCreate=是否新建并返回
    
    参数:
    
    loginId - 账号id
    
    isCreate - 是否新建
    
    返回:
    
    Session对象
  - getSessionByLoginId
```
public SaSession getSessionByLoginId(java.lang.Object loginId)
```
    获取指定账号id的User-Session，如果Session尚未创建，则新建并返回
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    Session对象
  - getSession
```
public SaSession getSession(boolean isCreate)
```
    获取当前User-Session, 如果Session尚未创建，isCreate=是否新建并返回
    
    参数:
    
    isCreate - 是否新建
    
    返回:
    
    Session对象
  - getSession
```
public SaSession getSession()
```
    获取当前User-Session，如果Session尚未创建，则新建并返回
    
    返回:
    
    Session对象
  - getTokenSessionByToken
```
public SaSession getTokenSessionByToken(java.lang.String tokenValue,
                                        boolean isCreate)
```
    获取指定Token-Session，如果Session尚未创建，isCreate代表是否新建并返回
    
    参数:
    
    tokenValue - token值
    
    isCreate - 是否新建
    
    返回:
    
    session对象
  - getTokenSessionByToken
```
public SaSession getTokenSessionByToken(java.lang.String tokenValue)
```
    获取指定Token-Session，如果Session尚未创建，则新建并返回
    
    参数:
    
    tokenValue - Token值
    
    返回:
    
    Session对象
  - getTokenSession
```
public SaSession getTokenSession(boolean isCreate)
```
    获取当前Token-Session，如果Session尚未创建，isCreate代表是否新建并返回
    
    参数:
    
    isCreate - 是否新建
    
    返回:
    
    Session对象
  - getTokenSession
```
public SaSession getTokenSession()
```
    获取当前Token-Session，如果Session尚未创建，则新建并返回
    
    返回:
    
    Session对象
  - deleteTokenSession
```
public void deleteTokenSession(java.lang.String tokenValue)
```
    删除Token-Session
    
    参数:
    
    tokenValue - token值
  - setLastActivityToNow
```
protected void setLastActivityToNow(java.lang.String tokenValue)
```
    写入指定token的 [最后操作时间] 为当前时间戳
    
    参数:
    
    tokenValue - 指定token
  - clearLastActivity
```
protected void clearLastActivity(java.lang.String tokenValue)
```
    清除指定token的 [最后操作时间]
    
    参数:
    
    tokenValue - 指定token
  - checkActivityTimeout
```
public void checkActivityTimeout(java.lang.String tokenValue)
```
    检查指定token 是否已经[临时过期]，如果已经过期则抛出异常
    
    参数:
    
    tokenValue - 指定token
  - checkActivityTimeout
```
public void checkActivityTimeout()
```
    检查当前token 是否已经[临时过期]，如果已经过期则抛出异常
  - updateLastActivityToNow
```
public void updateLastActivityToNow(java.lang.String tokenValue)
```
    续签指定token：(将 [最后操作时间] 更新为当前时间戳)
    
    参数:
    
    tokenValue - 指定token
  - updateLastActivityToNow
```
public void updateLastActivityToNow()
```
    续签当前token：(将 [最后操作时间] 更新为当前时间戳)
    请注意: 即使token已经 [临时过期] 也可续签成功，如果此场景下需要提示续签失败，可在此之前调用 checkActivityTimeout() 强制检查是否过期即可
  - getTokenTimeout
```
public long getTokenTimeout()
```
    获取当前登录者的 token 剩余有效时间 (单位: 秒)
    
    返回:
    
    token剩余有效时间
  - getTokenTimeoutByLoginId
```
public long getTokenTimeoutByLoginId(java.lang.Object loginId)
```
    获取指定 loginId 的 token 剩余有效时间 (单位: 秒)
    
    参数:
    
    loginId - 指定loginId
    
    返回:
    
    token剩余有效时间
  - getSessionTimeout
```
public long getSessionTimeout()
```
    获取当前登录者的 User-Session 剩余有效时间 (单位: 秒)
    
    返回:
    
    token剩余有效时间
  - getSessionTimeoutByLoginId
```
public long getSessionTimeoutByLoginId(java.lang.Object loginId)
```
    获取指定 loginId 的 User-Session 剩余有效时间 (单位: 秒)
    
    参数:
    
    loginId - 指定loginId
    
    返回:
    
    token剩余有效时间
  - getTokenSessionTimeout
```
public long getTokenSessionTimeout()
```
    获取当前 Token-Session 剩余有效时间 (单位: 秒)
    
    返回:
    
    token剩余有效时间
  - getTokenSessionTimeoutByTokenValue
```
public long getTokenSessionTimeoutByTokenValue(java.lang.String tokenValue)
```
    获取指定 Token-Session 剩余有效时间 (单位: 秒)
    
    参数:
    
    tokenValue - 指定token
    
    返回:
    
    token剩余有效时间
  - getTokenActivityTimeout
```
public long getTokenActivityTimeout()
```
    获取当前 token [临时过期] 剩余有效时间 (单位: 秒)
    
    返回:
    
    token [临时过期] 剩余有效时间
  - getTokenActivityTimeoutByToken
```
public long getTokenActivityTimeoutByToken(java.lang.String tokenValue)
```
    获取指定 token [临时过期] 剩余有效时间 (单位: 秒)
    
    参数:
    
    tokenValue - 指定token
    
    返回:
    
    token[临时过期]剩余有效时间
  - renewTimeout
```
public void renewTimeout(long timeout)
```
    对当前 Token 的 timeout 值进行续期
    
    参数:
    
    timeout - 要修改成为的有效时间 (单位: 秒)
  - renewTimeout
```
public void renewTimeout(java.lang.String tokenValue,
                         long timeout)
```
    对指定 Token 的 timeout 值进行续期
    
    参数:
    
    tokenValue - 指定token
    
    timeout - 要修改成为的有效时间 (单位: 秒)
  - getRoleList
```
public java.util.List<java.lang.String> getRoleList()
```
    获取：当前账号的角色集合
    
    返回:
    
    /
  - getRoleList
```
public java.util.List<java.lang.String> getRoleList(java.lang.Object loginId)
```
    获取：指定账号的角色集合
    
    参数:
    
    loginId - 指定账号id
    
    返回:
    
    /
  - hasRole
```
public boolean hasRole(java.lang.String role)
```
    判断：当前账号是否拥有指定角色, 返回true或false
    
    参数:
    
    role - 角色
    
    返回:
    
    /
  - hasRole
```
public boolean hasRole(java.lang.Object loginId,
                       java.lang.String role)
```
    判断：指定账号是否含有指定角色标识, 返回true或false
    
    参数:
    
    loginId - 账号id
    
    role - 角色标识
    
    返回:
    
    是否含有指定角色标识
  - hasRoleAnd
```
public boolean hasRoleAnd(java.lang.String... roleArray)
```
    判断：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
    
    参数:
    
    roleArray - 角色标识数组
    
    返回:
    
    true或false
  - hasRoleOr
```
public boolean hasRoleOr(java.lang.String... roleArray)
```
    判断：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
    
    参数:
    
    roleArray - 角色标识数组
    
    返回:
    
    true或false
  - checkRole
```
public void checkRole(java.lang.String role)
```
    校验：当前账号是否含有指定角色标识, 如果验证未通过，则抛出异常: NotRoleException
    
    参数:
    
    role - 角色标识
  - checkRoleAnd
```
public void checkRoleAnd(java.lang.String... roleArray)
```
    校验：当前账号是否含有指定角色标识 [指定多个，必须全部验证通过]
    
    参数:
    
    roleArray - 角色标识数组
  - checkRoleOr
```
public void checkRoleOr(java.lang.String... roleArray)
```
    校验：当前账号是否含有指定角色标识 [指定多个，只要其一验证通过即可]
    
    参数:
    
    roleArray - 角色标识数组
  - getPermissionList
```
public java.util.List<java.lang.String> getPermissionList()
```
    获取：当前账号的权限码集合
    
    返回:
    
    /
  - getPermissionList
```
public java.util.List<java.lang.String> getPermissionList(java.lang.Object loginId)
```
    获取：指定账号的权限码集合
    
    参数:
    
    loginId - 指定账号id
    
    返回:
    
    /
  - hasPermission
```
public boolean hasPermission(java.lang.String permission)
```
    判断：当前账号是否含有指定权限, 返回true或false
    
    参数:
    
    permission - 权限码
    
    返回:
    
    是否含有指定权限
  - hasPermission
```
public boolean hasPermission(java.lang.Object loginId,
                             java.lang.String permission)
```
    判断：指定账号id是否含有指定权限, 返回true或false
    
    参数:
    
    loginId - 账号id
    
    permission - 权限码
    
    返回:
    
    是否含有指定权限
  - hasPermissionAnd
```
public boolean hasPermissionAnd(java.lang.String... permissionArray)
```
    判断：当前账号是否含有指定权限, [指定多个，必须全部具有]
    
    参数:
    
    permissionArray - 权限码数组
    
    返回:
    
    true 或 false
  - hasPermissionOr
```
public boolean hasPermissionOr(java.lang.String... permissionArray)
```
    判断：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
    
    参数:
    
    permissionArray - 权限码数组
    
    返回:
    
    true 或 false
  - checkPermission
```
public void checkPermission(java.lang.String permission)
```
    校验：当前账号是否含有指定权限, 如果验证未通过，则抛出异常: NotPermissionException
    
    参数:
    
    permission - 权限码
  - checkPermissionAnd
```
public void checkPermissionAnd(java.lang.String... permissionArray)
```
    校验：当前账号是否含有指定权限 [指定多个，必须全部验证通过]
    
    参数:
    
    permissionArray - 权限码数组
  - checkPermissionOr
```
public void checkPermissionOr(java.lang.String... permissionArray)
```
    校验：当前账号是否含有指定权限 [指定多个，只要其一验证通过即可]
    
    参数:
    
    permissionArray - 权限码数组
  - getTokenValueByLoginId
```
public java.lang.String getTokenValueByLoginId(java.lang.Object loginId)
```
    获取指定账号id的tokenValue
    在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    token值
  - getTokenValueByLoginId
```
public java.lang.String getTokenValueByLoginId(java.lang.Object loginId,
                                               java.lang.String device)
```
    获取指定账号id指定设备类型端的tokenValue
    在配置为允许并发登录时，此方法只会返回队列的最后一个token，如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型，填null代表不限设备类型
    
    返回:
    
    token值
  - getTokenValueListByLoginId
```
public java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId)
```
    获取指定账号id的tokenValue集合
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    此loginId的所有相关token
  - getTokenValueListByLoginId
```
public java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId,
                                                                   java.lang.String device)
```
    获取指定账号id指定设备类型端的tokenValue 集合
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型，填null代表不限设备类型
    
    返回:
    
    此loginId的所有相关token
  - getLoginDevice
```
public java.lang.String getLoginDevice()
```
    返回当前会话的登录设备类型
    
    返回:
    
    当前令牌的登录设备类型
  - searchTokenValue
```
public java.util.List<java.lang.String> searchTokenValue(java.lang.String keyword,
                                                         int start,
                                                         int size)
```
    根据条件查询Token
    
    参数:
    
    keyword - 关键字
    
    start - 开始处索引 (-1代表查询所有)
    
    size - 获取数量
    
    返回:
    
    token集合
  - searchSessionId
```
public java.util.List<java.lang.String> searchSessionId(java.lang.String keyword,
                                                        int start,
                                                        int size)
```
    根据条件查询SessionId
    
    参数:
    
    keyword - 关键字
    
    start - 开始处索引 (-1代表查询所有)
    
    size - 获取数量
    
    返回:
    
    sessionId集合
  - searchTokenSessionId
```
public java.util.List<java.lang.String> searchTokenSessionId(java.lang.String keyword,
                                                             int start,
                                                             int size)
```
    根据条件查询Token专属Session的Id
    
    参数:
    
    keyword - 关键字
    
    start - 开始处索引 (-1代表查询所有)
    
    size - 获取数量
    
    返回:
    
    sessionId集合
  - checkByAnnotation
```
public void checkByAnnotation(SaCheckLogin at)
```
    根据注解(@SaCheckLogin)鉴权
    
    参数:
    
    at - 注解对象
  - checkByAnnotation
```
public void checkByAnnotation(SaCheckRole at)
```
    根据注解(@SaCheckRole)鉴权
    
    参数:
    
    at - 注解对象
  - checkByAnnotation
```
public void checkByAnnotation(SaCheckPermission at)
```
    根据注解(@SaCheckPermission)鉴权
    
    参数:
    
    at - 注解对象
  - checkByAnnotation
```
public void checkByAnnotation(SaCheckSafe at)
```
    根据注解(@SaCheckSafe)鉴权
    
    参数:
    
    at - 注解对象
  - disable
```
public void disable(java.lang.Object loginId,
                    long disableTime)
```
    封禁指定账号
    此方法不会直接将此账号id踢下线，而是在对方再次登录时抛出`DisableLoginException`异常
    
    参数:
    
    loginId - 指定账号id
    
    disableTime - 封禁时间, 单位: 秒（-1=永久封禁）
  - isDisable
```
public boolean isDisable(java.lang.Object loginId)
```
    指定账号是否已被封禁 (true=已被封禁, false=未被封禁)
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    see note
  - getDisableTime
```
public long getDisableTime(java.lang.Object loginId)
```
    获取指定账号剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    see note
  - untieDisable
```
public void untieDisable(java.lang.Object loginId)
```
    解封指定账号
    
    参数:
    
    loginId - 账号id
  - switchTo
```
public void switchTo(java.lang.Object loginId)
```
    临时切换身份为指定账号id
    
    参数:
    
    loginId - 指定loginId
  - endSwitch
```
public void endSwitch()
```
    结束临时切换身份
  - isSwitch
```
public boolean isSwitch()
```
    当前是否正处于[身份临时切换]中
    
    返回:
    
    是否正处于[身份临时切换]中
  - getSwitchLoginId
```
public java.lang.Object getSwitchLoginId()
```
    返回[身份临时切换]的loginId
    
    返回:
    
    返回[身份临时切换]的loginId
  - switchTo
```
public void switchTo(java.lang.Object loginId,
                     SaFunction function)
```
    在一个代码段里方法内，临时切换身份为指定账号id
    
    参数:
    
    loginId - 指定账号id
    
    function - 要执行的方法
  - openSafe
```
public void openSafe(long safeTime)
```
    在当前会话开启二级认证
    
    参数:
    
    safeTime - 维持时间 (单位: 秒)
  - isSafe
```
public boolean isSafe()
```
    当前会话是否处于二级认证时间内
    
    返回:
    
    true=二级认证已通过, false=尚未进行二级认证或认证已超时
  - checkSafe
```
public void checkSafe()
```
    检查当前会话是否已通过二级认证，如未通过则抛出异常
  - getSafeTime
```
public long getSafeTime()
```
    获取当前会话的二级认证剩余有效时间 (单位: 秒, 返回-2代表尚未通过二级认证)
    
    返回:
    
    剩余有效时间
  - closeSafe
```
public void closeSafe()
```
    在当前会话结束二级认证
  - splicingKeyTokenName
```
public java.lang.String splicingKeyTokenName()
```
    拼接key：客户端 tokenName
    
    返回:
    
    key
  - splicingKeyTokenValue
```
public java.lang.String splicingKeyTokenValue(java.lang.String tokenValue)
```
    拼接key： tokenValue 持久化 token-id
    
    参数:
    
    tokenValue - token值
    
    返回:
    
    key
  - splicingKeySession
```
public java.lang.String splicingKeySession(java.lang.Object loginId)
```
    拼接key： Session 持久化
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    key
  - splicingKeyTokenSession
```
public java.lang.String splicingKeyTokenSession(java.lang.String tokenValue)
```
    拼接key： tokenValue的Token-Session
    
    参数:
    
    tokenValue - token值
    
    返回:
    
    key
  - splicingKeyLastActivityTime
```
public java.lang.String splicingKeyLastActivityTime(java.lang.String tokenValue)
```
    拼接key：指定token的最后操作时间持久化
    
    参数:
    
    tokenValue - token值
    
    返回:
    
    key
  - splicingKeySwitch
```
public java.lang.String splicingKeySwitch()
```
    在进行身份切换时，使用的存储key
    
    返回:
    
    key
  - splicingKeyJustCreatedSave
```
public java.lang.String splicingKeyJustCreatedSave()
```
    如果token为本次请求新创建的，则以此字符串为key存储在当前request中
    
    返回:
    
    key
  - splicingKeyDisable
```
public java.lang.String splicingKeyDisable(java.lang.Object loginId)
```
    拼接key：账号封禁
    
    参数:
    
    loginId - 账号id
    
    返回:
    
    key
  - getConfig
```
public SaTokenConfig getConfig()
```
    返回全局配置对象
    
    返回:
    
    /
  - getConfigOfIsShare
```
public boolean getConfigOfIsShare()
```
    返回全局配置对象的isShare属性
    
    返回:
    
    /
  - isOpenActivityCheck
```
public boolean isOpenActivityCheck()
```
    返回全局配置是否开启了Token 活跃校验
    
    返回:
    
    /
  - getSaTokenDao
```
public SaTokenDao getSaTokenDao()
```
    返回持久化对象
    
    返回:
    
    /
  - hasElement
```
public boolean hasElement(java.util.List<java.lang.String> list,
                          java.lang.String element)
```
    判断：集合中是否包含指定元素（模糊匹配）
    
    参数:
    
    list - 集合
    
    element - 元素
    
    返回:
    
    /
  - logoutByLoginId
```
@Deprecated
public void logoutByLoginId(java.lang.Object loginId)
```
    已过时。
    
    本函数设计已过时，未来版本可能移除此函数，请及时更换为 StpUtil.kickout(id) ，使用方式保持不变
    会话注销，根据账号id （踢人下线）
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2
    
    参数:
    
    loginId - 账号id
  - logoutByLoginId
```
@Deprecated
public void logoutByLoginId(java.lang.Object loginId,
                                         java.lang.String device)
```
    已过时。
    
    本函数设计已过时，未来版本可能移除此函数，请及时更换为 StpUtil.kickout(id) ，使用方式保持不变
    会话注销，根据账号id and 设备类型（踢人下线）
    当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2
    
    参数:
    
    loginId - 账号id
    
    device - 设备类型 (填null代表注销所有设备类型)
  - createTokenValue
```
@Deprecated
public java.lang.String createTokenValue(java.lang.Object loginId,
                                                      java.lang.String device,
                                                      long timeout)
```
    已过时。
    
    创建一个TokenValue
    
    参数:
    
    loginId - loginId
    
    device - 设备类型
    
    timeout - 过期时间
    
    返回:
    
    生成的tokenValue

类 StpLogic

字段概要

构造器概要

方法概要

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

字段详细资料

loginType

构造器详细资料

StpLogic

方法详细资料

getLoginType

setLoginType

getTokenName

createTokenValue

setTokenValue

setTokenValue

setTokenValueToStorage

setTokenValueToCookie

getTokenValue

getTokenValueNotCut

getTokenInfo

login

login

login

login

createLoginSession

createLoginSession

logout

logout

logout

logoutByMaxLoginCount

logoutByTokenValue

kickout

kickout

kickoutByTokenValue

replaced

isLogin

checkLogin

getLoginId

getLoginId

getLoginIdDefaultNull

getLoginIdAsString

getLoginIdAsInt

getLoginIdAsLong

getLoginIdByToken

getLoginIdNotHandle

getExtra

isValidLoginId

deleteTokenToIdMapping

updateTokenToIdMapping

saveTokenToIdMapping

getSessionBySessionId

getSessionBySessionId

getSessionByLoginId

getSessionByLoginId

getSession

getSession

getTokenSessionByToken

getTokenSessionByToken

getTokenSession

getTokenSession

deleteTokenSession

setLastActivityToNow

clearLastActivity

checkActivityTimeout

checkActivityTimeout

updateLastActivityToNow

updateLastActivityToNow

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

getTokenTimeout

getTokenTimeoutByLoginId

getSessionTimeout

getSessionTimeoutByLoginId

getTokenSessionTimeout

getTokenSessionTimeoutByTokenValue

getTokenActivityTimeout

getTokenActivityTimeoutByToken

renewTimeout

renewTimeout

getRoleList

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