序列化表格

程序包 cn.dev33.satoken.config

类 cn.dev33.satoken.config.SaTokenConfig

class SaTokenConfig extends Object implements Serializable

serialVersionUID:

-6541180061782004705L

序列化字段

activeTimeout

long activeTimeout

token 最低活跃频率（单位：秒），如果 token 超过此时间没有访问系统就会被冻结，默认-1 代表不限制，永不冻结 （例如可以设置为 1800 代表 30 分钟内无操作就冻结）

autoRenew

Boolean autoRenew

是否打开自动续签 activeTimeout （如果此值为 true, 框架会在每次直接或间接调用 getLoginId() 时进行一次过期检查与续签操作）

basic

String basic

Http Basic 认证的默认账号和密码

checkSameToken

Boolean checkSameToken

是否校验 Same-Token（部分rpc插件有效）

cookie

SaCookieConfig cookie

Cookie配置对象

currDomain

String currDomain

配置当前项目的网络访问地址

dataRefreshPeriod

int dataRefreshPeriod

默认 SaTokenDao 实现类中，每次清理过期数据间隔的时间（单位: 秒），默认值30秒，设置为 -1 代表不启动定时清理

dynamicActiveTimeout

Boolean dynamicActiveTimeout

是否启用动态 activeTimeout 功能，如不需要请设置为 false，节省缓存请求次数

isColorLog

Boolean isColorLog

是否打印彩色日志

isConcurrent

Boolean isConcurrent

是否允许同一账号多地同时登录 （为 true 时允许一起登录, 为 false 时新登录挤掉旧登录）

isLog

Boolean isLog

是否打印操作日志

isPrint

Boolean isPrint

是否在初始化配置时在控制台打印版本字符画

isReadBody

Boolean isReadBody

是否尝试从请求体里读取 token

isReadCookie

Boolean isReadCookie

是否尝试从 cookie 里读取 token

isReadHeader

Boolean isReadHeader

是否尝试从 header 里读取 token

isShare

Boolean isShare

在多人登录同一账号时，是否共用一个 token （为 true 时所有登录共用一个 token, 为 false 时每次登录新建一个 token）

isWriteHeader

Boolean isWriteHeader

是否在登录后将 token 写入到响应头

jwtSecretKey

String jwtSecretKey

jwt秘钥（只有集成 jwt 相关模块时此参数才会生效）

logLevel

String logLevel

日志等级（trace、debug、info、warn、error、fatal），此值与 logLevelInt 联动

logLevelInt

int logLevelInt

日志等级 int 值（1=trace、2=debug、3=info、4=warn、5=error、6=fatal），此值与 logLevel 联动

maxLoginCount

int maxLoginCount

同一账号最大登录数量，-1代表不限 （只有在 isConcurrent=true, isShare=false 时此配置项才有意义）

maxTryTimes

int maxTryTimes

在每次创建 token 时的最高循环次数，用于保证 token 唯一性（-1=不循环尝试，直接使用）

sameTokenTimeout

long sameTokenTimeout

Same-Token 的有效期 (单位: 秒)

sign

SaSignConfig sign

API 签名配置对象

timeout

long timeout

token 有效期（单位：秒） 默认30天，-1 代表永久有效

tokenName

String tokenName

token 名称 （同时也是： cookie 名称、提交 token 时参数的名称、存储 token 时的 key 前缀）

tokenPrefix

String tokenPrefix

token 前缀, 前端提交 token 时应该填写的固定前缀，格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)

tokenSessionCheckLogin

Boolean tokenSessionCheckLogin

获取 Token-Session 时是否必须登录（如果配置为true，会在每次获取 getTokenSession() 时校验当前是否登录）

tokenStyle

String tokenStyle

token 风格（默认可取值：uuid、simple-uuid、random-32、random-64、random-128、tik）

程序包 cn.dev33.satoken.exception

异常错误 cn.dev33.satoken.exception.ApiDisabledException

class ApiDisabledException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130133L

异常错误 cn.dev33.satoken.exception.BackResultException

class BackResultException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130143L

序列化字段

result

Object result

要输出的结果

异常错误 cn.dev33.satoken.exception.DisableServiceException

class DisableServiceException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130143L

序列化字段

disableTime

long disableTime

封禁剩余时间，单位：秒

level

int level

具体被封禁的等级

limitLevel

int limitLevel

校验时要求低于的等级

loginId

Object loginId

被封禁的账号id

loginType

String loginType

账号类型

service

String service

具体被封禁的服务

异常错误 cn.dev33.satoken.exception.InvalidContextException

class InvalidContextException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

异常错误 cn.dev33.satoken.exception.NotBasicAuthException

class NotBasicAuthException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

异常错误 cn.dev33.satoken.exception.NotImplException

class NotImplException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

异常错误 cn.dev33.satoken.exception.NotLoginException

class NotLoginException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130142L

序列化字段

loginType

String loginType

账号类型

type

String type

异常类型

异常错误 cn.dev33.satoken.exception.NotPermissionException

class NotPermissionException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130141L

序列化字段

loginType

String loginType

账号类型

permission

String permission

权限码

异常错误 cn.dev33.satoken.exception.NotRoleException

class NotRoleException extends SaTokenException implements Serializable

serialVersionUID:

8243974276159004739L

序列化字段

loginType

String loginType

账号类型

role

String role

角色标识

异常错误 cn.dev33.satoken.exception.NotSafeException

class NotSafeException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

序列化字段

loginType

String loginType

账号类型

service

String service

未通过校验的服务

tokenValue

Object tokenValue

未通过校验的 Token 值

异常错误 cn.dev33.satoken.exception.NotWebContextException

class NotWebContextException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

异常错误 cn.dev33.satoken.exception.SaJsonConvertException

class SaJsonConvertException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290134144L

异常错误 cn.dev33.satoken.exception.SameTokenInvalidException

class SameTokenInvalidException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

异常错误 cn.dev33.satoken.exception.SaSignException

class SaSignException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130144L

异常错误 cn.dev33.satoken.exception.SaTokenException

class SaTokenException extends RuntimeException implements Serializable

serialVersionUID:

6806129545290130132L

序列化字段

code

int code

异常细分状态码

异常错误 cn.dev33.satoken.exception.StopMatchException

class StopMatchException extends SaTokenException implements Serializable

serialVersionUID:

6806129545290130143L

程序包 cn.dev33.satoken.session

类 cn.dev33.satoken.session.SaSession

class SaSession extends Object implements Serializable

serialVersionUID:

1L

序列化字段

createTime

long createTime

此 SaSession 的创建时间（13位时间戳）

dataMap

Map<String,Object> dataMap

所有挂载数据

id

String id

此 SaSession 的 id

loginId

Object loginId

所属 loginId （当此 SaSession 属于 Account-Session 时，此值有效）

loginType

String loginType

所属 loginType

token

String token

所属 Token （当此 SaSession 属于 Token-Session 时，此值有效）

tokenSignList

List<TokenSign> tokenSignList

此 Session 绑定的 Token 签名列表

type

String type

此 SaSession 的 类型

类 cn.dev33.satoken.session.TokenSign

class TokenSign extends Object implements Serializable

serialVersionUID:

1406115065849845073L

序列化字段

device

String device

所属设备类型

tag

Object tag

此客户端登录的挂载数据

value

String value

Token 值

程序包 cn.dev33.satoken.util

类 cn.dev33.satoken.util.SaResult

class SaResult extends LinkedHashMap<String,Object> implements Serializable

serialVersionUID:

1L