StpLogic (sa-token-core 1.7.0 API)

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

```
public class StpLogic
extends java.lang.Object
```
sa-token 权限验证，逻辑实现类
(stp = sa-token-permission 的缩写 )

作者:

kong

字段概要

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

java.lang.String loginKey
持久化的key前缀，多账号认证体系时以此值区分，比如：login、user、admin

字段
限定符和类型	字段和说明
`java.lang.String`	`loginKey` 持久化的key前缀，多账号认证体系时以此值区分，比如：login、user、admin

构造器概要

构造器
构造器和说明

StpLogic(java.lang.String loginKey)
初始化StpLogic, 并制定loginKey

构造器
构造器和说明
`StpLogic(java.lang.String loginKey)` 初始化StpLogic, 并制定loginKey

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`checkActivityTimeout()` 检查当前token 是否已经[临时过期]，如果已经过期则抛出异常
`void`	`checkActivityTimeout(java.lang.String tokenValue)` 检查指定token 是否已经[临时过期]，如果已经过期则抛出异常
`void`	`checkLogin()` 检验当前会话是否已经登录，如未登录，则抛出异常
`void`	`checkPermission(java.lang.Object pcode)` 当前账号是否含有指定权限，没有就抛出异常
`void`	`checkPermissionAnd(java.lang.Object... pcodeArray)` 当前账号是否含有指定权限，【指定多个，必须全都有】
`void`	`checkPermissionOr(java.lang.Object... pcodeArray)` 当前账号是否含有指定权限，【指定多个，有一个就可以了】
`protected void`	`clearLastActivity(java.lang.String tokenValue)` 清除指定token的 [最后操作时间]
`java.lang.String`	`getKeyLastActivityTime(java.lang.String tokenValue)` 获取key：指定token的最后操作时间持久化
`java.lang.String`	`getKeyLoginId(java.lang.Object loginId)` 获取key： id 持久化
`java.lang.String`	`getKeySession(java.lang.Object loginId)` 获取key： session 持久化
`java.lang.String`	`getKeyTokenName()` 获取key：客户端 tokenName
`java.lang.String`	`getKeyTokenValue(java.lang.String tokenValue)` 获取key： tokenValue 持久化
`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`	`getLoginKey()` 获取当前StpLogin的loginKey
`SaSession`	`getSession()` 获取当前会话的session
`SaSession`	`getSession(boolean isCreate)` 获取当前会话的session, 如果session尚未创建，isCreate=是否新建并返回
`SaSession`	`getSessionByLoginId(java.lang.Object loginId)` 获取指定loginId的session
`SaSession`	`getSessionByLoginId(java.lang.Object loginId, boolean isCreate)` 获取指定loginId的session, 如果没有，isCreate=是否新建并返回
`protected SaSession`	`getSessionBySessionId(java.lang.String sessionId, boolean isCreate)` 获取指定key的session, 如果session尚未创建，isCreate=是否新建并返回
`long`	`getSessionTimeout()` 获取当前登录者的Session剩余有效时间 (单位: 秒)
`long`	`getSessionTimeoutByLoginId(java.lang.Object loginId)` 获取指定loginId的Session剩余有效时间 (单位: 秒)
`long`	`getTokenActivityTimeout()` 获取当前token[临时过期]剩余有效时间 (单位: 秒)
`long`	`getTokenActivityTimeoutByToken(java.lang.String tokenValue)` 获取指定token[临时过期]剩余有效时间 (单位: 秒)
`SaTokenInfo`	`getTokenInfo()` 获取当前会话的token信息
`java.lang.String`	`getTokenName()` 返回token名称
`long`	`getTokenTimeout()` 获取当前登录者的token剩余有效时间 (单位: 秒)
`long`	`getTokenTimeoutByLoginId(java.lang.Object loginId)` 获取指定loginId的token剩余有效时间 (单位: 秒)
`java.lang.String`	`getTokenValue()` 获取当前tokenValue
`java.lang.String`	`getTokenValueByLoginId(java.lang.Object loginId)` 获取指定loginId的tokenValue
`boolean`	`hasPermission(java.lang.Object pcode)` 当前会话是否含有指定权限
`boolean`	`hasPermission(java.lang.Object loginId, java.lang.Object pcode)` 指定loginId是否含有指定权限
`boolean`	`isLogin()` 获取当前会话是否已经登录
`void`	`kickoutByLoginId(java.lang.Object loginId)` 指定loginId的会话注销登录（踢人下线）
`void`	`logout()` 当前会话注销登录
`void`	`logoutByLoginId(java.lang.Object loginId)` 指定loginId的会话注销登录（正常注销下线）
`java.lang.String`	`randomTokenValue(java.lang.Object loginId)` 随机生成一个tokenValue
`protected void`	`setLastActivityToNow(java.lang.String tokenValue)` 写入指定token的 [最后操作时间] 为当前时间戳
`void`	`setLoginId(java.lang.Object loginId)` 在当前会话上登录id
`void`	`updateLastActivityToNow()` 续签当前token：(将 [最后操作时间] 更新为当前时间戳) 请注意: 即时token已经 [临时过期] 也可续签成功，如果此场景下需要提示续签失败，可在此之前调用 checkActivityTimeout() 强制检查是否过期即可
`void`	`updateLastActivityToNow(java.lang.String tokenValue)` 续签指定token：(将 [最后操作时间] 更新为当前时间戳)

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

- 字段详细资料
  - loginKey
```
public java.lang.String loginKey
```
    持久化的key前缀，多账号认证体系时以此值区分，比如：login、user、admin
- 构造器详细资料
  - StpLogic
```
public StpLogic(java.lang.String loginKey)
```
    初始化StpLogic, 并制定loginKey
    
    参数:
    
    loginKey - 账号标识
- 方法详细资料
  - getTokenName
```
public java.lang.String getTokenName()
```
    返回token名称
    
    返回:
    
    此StpLogic的token名称
  - randomTokenValue
```
public java.lang.String randomTokenValue(java.lang.Object loginId)
```
    随机生成一个tokenValue
    
    参数:
    
    loginId - loginId
    
    返回:
    
    生成的tokenValue
  - getTokenValue
```
public java.lang.String getTokenValue()
```
    获取当前tokenValue
    
    返回:
    
    当前tokenValue
  - getTokenValueByLoginId
```
public java.lang.String getTokenValueByLoginId(java.lang.Object loginId)
```
    获取指定loginId的tokenValue
    
    参数:
    
    loginId - .
    
    返回:
    
    .
  - getLoginKey
```
public java.lang.String getLoginKey()
```
    获取当前StpLogin的loginKey
    
    返回:
    
    当前StpLogin的loginKey
  - getTokenInfo
```
public SaTokenInfo getTokenInfo()
```
    获取当前会话的token信息
    
    返回:
    
    token信息
  - setLoginId
```
public void setLoginId(java.lang.Object loginId)
```
    在当前会话上登录id
    
    参数:
    
    loginId - 登录id ，建议的类型：（long | int | String）
  - logout
```
public void logout()
```
    当前会话注销登录
  - logoutByLoginId
```
public void logoutByLoginId(java.lang.Object loginId)
```
    指定loginId的会话注销登录（正常注销下线）
    
    参数:
    
    loginId - 账号id
  - kickoutByLoginId
```
public void kickoutByLoginId(java.lang.Object loginId)
```
    指定loginId的会话注销登录（踢人下线）
    
    参数:
    
    loginId - 账号id
  - isLogin
```
public boolean isLogin()
```
    获取当前会话是否已经登录
    
    返回:
    
    是否已登录
  - checkLogin
```
public void checkLogin()
```
    检验当前会话是否已经登录，如未登录，则抛出异常
  - getLoginId
```
public java.lang.Object getLoginId()
```
    获取当前会话登录id, 如果未登录，则抛出异常
    
    返回:
    
    .
  - getLoginId
```
public <T> T getLoginId(T defaultValue)
```
    获取当前会话登录id, 如果未登录，则返回默认值
    
    类型参数:
    
    T - 返回类型
    
    参数:
    
    defaultValue - 默认值
    
    返回:
    
    登录id
  - getLoginIdDefaultNull
```
public java.lang.Object getLoginIdDefaultNull()
```
    获取当前会话登录id, 如果未登录，则返回null
    
    返回:
    
    .
  - 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
  - getSessionBySessionId
```
protected SaSession getSessionBySessionId(java.lang.String sessionId,
                                          boolean isCreate)
```
    获取指定key的session, 如果session尚未创建，isCreate=是否新建并返回
    
    参数:
    
    sessionId - .
    
    isCreate - .
    
    返回:
    
    .
  - getSessionByLoginId
```
public SaSession getSessionByLoginId(java.lang.Object loginId,
                                     boolean isCreate)
```
    获取指定loginId的session, 如果没有，isCreate=是否新建并返回
    
    参数:
    
    loginId - 登录id
    
    isCreate - 是否新建
    
    返回:
    
    SaSession
  - getSessionByLoginId
```
public SaSession getSessionByLoginId(java.lang.Object loginId)
```
    获取指定loginId的session
    
    参数:
    
    loginId - .
    
    返回:
    
    .
  - getSession
```
public SaSession getSession(boolean isCreate)
```
    获取当前会话的session, 如果session尚未创建，isCreate=是否新建并返回
    
    参数:
    
    isCreate - 是否新建
    
    返回:
    
    当前会话的session
  - getSession
```
public SaSession getSession()
```
    获取当前会话的session
    
    返回:
    
    当前会话的session
  - 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()
```
    获取当前登录者的Session剩余有效时间 (单位: 秒)
    
    返回:
    
    token剩余有效时间
  - getSessionTimeoutByLoginId
```
public long getSessionTimeoutByLoginId(java.lang.Object loginId)
```
    获取指定loginId的Session剩余有效时间 (单位: 秒)
    
    参数:
    
    loginId - 指定loginId
    
    返回:
    
    token剩余有效时间
  - getTokenActivityTimeout
```
public long getTokenActivityTimeout()
```
    获取当前token[临时过期]剩余有效时间 (单位: 秒)
    
    返回:
    
    token[临时过期]剩余有效时间
  - getTokenActivityTimeoutByToken
```
public long getTokenActivityTimeoutByToken(java.lang.String tokenValue)
```
    获取指定token[临时过期]剩余有效时间 (单位: 秒)
    
    参数:
    
    tokenValue - 指定token
    
    返回:
    
    token[临时过期]剩余有效时间
  - hasPermission
```
public boolean hasPermission(java.lang.Object loginId,
                             java.lang.Object pcode)
```
    指定loginId是否含有指定权限
    
    参数:
    
    loginId - .
    
    pcode - .
    
    返回:
    
    .
  - hasPermission
```
public boolean hasPermission(java.lang.Object pcode)
```
    当前会话是否含有指定权限
    
    参数:
    
    pcode - .
    
    返回:
    
    .
  - checkPermission
```
public void checkPermission(java.lang.Object pcode)
```
    当前账号是否含有指定权限，没有就抛出异常
    
    参数:
    
    pcode - .
  - checkPermissionAnd
```
public void checkPermissionAnd(java.lang.Object... pcodeArray)
```
    当前账号是否含有指定权限，【指定多个，必须全都有】
    
    参数:
    
    pcodeArray - .
  - checkPermissionOr
```
public void checkPermissionOr(java.lang.Object... pcodeArray)
```
    当前账号是否含有指定权限，【指定多个，有一个就可以了】
    
    参数:
    
    pcodeArray - .
  - getKeyTokenName
```
public java.lang.String getKeyTokenName()
```
    获取key：客户端 tokenName
    
    返回:
    
    key
  - getKeyTokenValue
```
public java.lang.String getKeyTokenValue(java.lang.String tokenValue)
```
    获取key： tokenValue 持久化
    
    参数:
    
    tokenValue - .
    
    返回:
    
    key
  - getKeyLoginId
```
public java.lang.String getKeyLoginId(java.lang.Object loginId)
```
    获取key： id 持久化
    
    参数:
    
    loginId - .
    
    返回:
    
    key
  - getKeySession
```
public java.lang.String getKeySession(java.lang.Object loginId)
```
    获取key： session 持久化
    
    参数:
    
    loginId - .
    
    返回:
    
    key
  - getKeyLastActivityTime
```
public java.lang.String getKeyLastActivityTime(java.lang.String tokenValue)
```
    获取key：指定token的最后操作时间持久化
    
    参数:
    
    tokenValue - token
    
    返回:
    
    key

类 StpLogic

字段概要

构造器概要

方法概要

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

字段详细资料

loginKey

构造器详细资料

StpLogic

方法详细资料

getTokenName

randomTokenValue

getTokenValue

getTokenValueByLoginId

getLoginKey

getTokenInfo

setLoginId

logout

logoutByLoginId

kickoutByLoginId

isLogin

checkLogin

getLoginId

getLoginId

getLoginIdDefaultNull

getLoginIdAsString

getLoginIdAsInt

getLoginIdAsLong

getLoginIdByToken

getSessionBySessionId

getSessionByLoginId

getSessionByLoginId

getSession

getSession

setLastActivityToNow

clearLastActivity

checkActivityTimeout

checkActivityTimeout

updateLastActivityToNow

updateLastActivityToNow

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

getTokenTimeout

getTokenTimeoutByLoginId

getSessionTimeout

getSessionTimeoutByLoginId

getTokenActivityTimeout

getTokenActivityTimeoutByToken

hasPermission

hasPermission

checkPermission

checkPermissionAnd

checkPermissionOr

getKeyTokenName

getKeyTokenValue

getKeyLoginId

getKeySession

getKeyLastActivityTime

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