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

java.lang.Object
- cn.dev33.satoken.session.SaSession

所有已实现的接口:

java.io.Serializable
```
public class SaSession
extends java.lang.Object
implements java.io.Serializable
```
Session Model

作者:

kong

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`PERMISSION_LIST` 在 Session 上存储权限时建议使用的key
`static java.lang.String`	`ROLE_LIST` 在 Session 上存储角色时建议使用的key

构造器概要

构造器
构造器和说明

SaSession()
构建一个Session对象

SaSession(java.lang.String id)
构建一个Session对象

构造器
构造器和说明
`SaSession()` 构建一个Session对象
`SaSession(java.lang.String id)` 构建一个Session对象

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addTokenSign(java.lang.String tokenValue, java.lang.String device)` 添加一个token签名
`void`	`addTokenSign(TokenSign tokenSign)` 添加一个token签名
`java.util.Set<java.lang.String>`	`attributeKeys()` 已过时。
`void`	`clear()` 清空所有值
`void`	`clearAttribute()` 已过时。
`boolean`	`containsAttribute(java.lang.String key)` 已过时。
`SaSession`	`delete(java.lang.String key)` 删值
`java.lang.Object`	`get(java.lang.String key)` 取值
`<T> T`	`get(java.lang.String key, SaRetFunction fun)` 取值 (如果值为null，则执行fun函数获取值)
`<T> T`	`get(java.lang.String key, T defaultValue)` 取值 (指定默认值)
`java.lang.Object`	`getAttribute(java.lang.String key)` 已过时。
`java.lang.Object`	`getAttribute(java.lang.String key, java.lang.Object defaultValue)` 已过时。
`long`	`getCreateTime()` 返回当前会话创建时间
`java.util.Map<java.lang.String,java.lang.Object>`	`getDataMap()` 获取数据挂载集合（如果更新map里的值，请调用session.update()方法避免产生脏数据）
`double`	`getDouble(java.lang.String key)` 取值 (转double类型)
`float`	`getFloat(java.lang.String key)` 取值 (转float类型)
`java.lang.String`	`getId()` 获取此Session的id
`int`	`getInt(java.lang.String key)` 取值 (转int类型)
`long`	`getLong(java.lang.String key)` 取值 (转long类型)
`<T> T`	`getModel(java.lang.String key, java.lang.Class<T> cs)` 取值 (指定转换类型)
`<T> T`	`getModel(java.lang.String key, java.lang.Class<T> cs, java.lang.Object defaultValue)` 取值 (指定转换类型, 并指定值为Null时返回的默认值)
`java.lang.String`	`getString(java.lang.String key)` 取值 (转String类型)
`long`	`getTimeout()` 获取此Session的剩余存活时间 (单位: 秒)
`TokenSign`	`getTokenSign(java.lang.String tokenValue)` 查找一个token签名
`java.util.List<TokenSign>`	`getTokenSignList()` 此Session绑定的token签名列表
`protected <T> T`	`getValueByDefaultValue(java.lang.Object value, T defaultValue)` 根据默认值来获取值
`boolean`	`has(java.lang.String key)` 是否含有某个key
`java.util.Set<java.lang.String>`	`keys()` 返回当前Session的所有key
`void`	`logout()` 注销Session (从持久库删除)
`void`	`logoutByTokenSignCountToZero()` 当Session上的tokenSign数量为零时，注销会话
`void`	`refreshDataMap(java.util.Map<java.lang.String,java.lang.Object> dataMap)` 写入数据集合 (不改变底层对象，只将此dataMap所有数据进行替换)
`void`	`removeAttribute(java.lang.String key)` 已过时。
`void`	`removeTokenSign(java.lang.String tokenValue)` 移除一个token签名
`SaSession`	`set(java.lang.String key, java.lang.Object value)` 写值
`void`	`setAttribute(java.lang.String key, java.lang.Object value)` 已过时。
`SaSession`	`setCreateTime(long createTime)` 写入此Session的创建时间
`SaSession`	`setDefaultValue(java.lang.String key, java.lang.Object value)` 写值(只有在此key原本无值的时候才会写入)
`SaSession`	`setId(java.lang.String id)` 写入此Session的id
`java.util.List<TokenSign>`	`tokenSignListCopy()` 返回token签名列表的拷贝副本
`java.util.List<TokenSign>`	`tokenSignListCopyByDevice(java.lang.String device)` 返回token签名列表的拷贝副本，根据 device 筛选
`protected long`	`trans(long value)` value为 -1 时返回 Long.MAX_VALUE，否则原样返回
`void`	`update()` 更新Session（从持久库更新刷新一下）
`void`	`updateMaxTimeout(long maxTimeout)` 修改此Session的最大剩余存活时间 (只有在Session的过期时间高于指定的maxTimeout时才会进行修改)
`void`	`updateMinTimeout(long minTimeout)` 修改此Session的最小剩余存活时间 (只有在Session的过期时间低于指定的minTimeout时才会进行修改)
`void`	`updateTimeout(long timeout)` 修改此Session的剩余存活时间
`boolean`	`valueIsNull(java.lang.Object value)` 判断一个值是否为null

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

- 字段详细资料
  - ROLE_LIST
```
public static final java.lang.String ROLE_LIST
```
    在 Session 上存储角色时建议使用的key
    
    另请参阅:
    
    常量字段值
  - PERMISSION_LIST
```
public static final java.lang.String PERMISSION_LIST
```
    在 Session 上存储权限时建议使用的key
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - SaSession
```
public SaSession()
```
    构建一个Session对象
  - SaSession
```
public SaSession(java.lang.String id)
```
    构建一个Session对象
    
    参数:
    
    id - Session的id
- 方法详细资料
  - getId
```
public java.lang.String getId()
```
    获取此Session的id
    
    返回:
    
    此会话的id
  - setId
```
public SaSession setId(java.lang.String id)
```
    写入此Session的id
    
    参数:
    
    id - SessionId
    
    返回:
    
    对象自身
  - getCreateTime
```
public long getCreateTime()
```
    返回当前会话创建时间
    
    返回:
    
    时间戳
  - setCreateTime
```
public SaSession setCreateTime(long createTime)
```
    写入此Session的创建时间
    
    参数:
    
    createTime - 时间戳
    
    返回:
    
    对象自身
  - getTokenSignList
```
public java.util.List<TokenSign> getTokenSignList()
```
    此Session绑定的token签名列表
    
    返回:
    
    token签名列表
  - tokenSignListCopy
```
public java.util.List<TokenSign> tokenSignListCopy()
```
    返回token签名列表的拷贝副本
    
    返回:
    
    token签名列表
  - tokenSignListCopyByDevice
```
public java.util.List<TokenSign> tokenSignListCopyByDevice(java.lang.String device)
```
    返回token签名列表的拷贝副本，根据 device 筛选
    
    参数:
    
    device - 设备类型，填 null 代表不限设备类型
    
    返回:
    
    token签名列表
  - getTokenSign
```
public TokenSign getTokenSign(java.lang.String tokenValue)
```
    查找一个token签名
    
    参数:
    
    tokenValue - token值
    
    返回:
    
    查找到的tokenSign
  - addTokenSign
```
public void addTokenSign(TokenSign tokenSign)
```
    添加一个token签名
    
    参数:
    
    tokenSign - token签名
  - addTokenSign
```
public void addTokenSign(java.lang.String tokenValue,
                         java.lang.String device)
```
    添加一个token签名
    
    参数:
    
    tokenValue - token值
    
    device - 设备类型
  - removeTokenSign
```
public void removeTokenSign(java.lang.String tokenValue)
```
    移除一个token签名
    
    参数:
    
    tokenValue - token名称
  - update
```
public void update()
```
    更新Session（从持久库更新刷新一下）
  - logout
```
public void logout()
```
    注销Session (从持久库删除)
  - logoutByTokenSignCountToZero
```
public void logoutByTokenSignCountToZero()
```
    当Session上的tokenSign数量为零时，注销会话
  - getTimeout
```
public long getTimeout()
```
    获取此Session的剩余存活时间 (单位: 秒)
    
    返回:
    
    此Session的剩余存活时间 (单位: 秒)
  - updateTimeout
```
public void updateTimeout(long timeout)
```
    修改此Session的剩余存活时间
    
    参数:
    
    timeout - 过期时间 (单位: 秒)
  - updateMinTimeout
```
public void updateMinTimeout(long minTimeout)
```
    修改此Session的最小剩余存活时间 (只有在Session的过期时间低于指定的minTimeout时才会进行修改)
    
    参数:
    
    minTimeout - 过期时间 (单位: 秒)
  - updateMaxTimeout
```
public void updateMaxTimeout(long maxTimeout)
```
    修改此Session的最大剩余存活时间 (只有在Session的过期时间高于指定的maxTimeout时才会进行修改)
    
    参数:
    
    maxTimeout - 过期时间 (单位: 秒)
  - trans
```
protected long trans(long value)
```
    value为 -1 时返回 Long.MAX_VALUE，否则原样返回
    
    参数:
    
    value - /
    
    返回:
    
    /
  - get
```
public java.lang.Object get(java.lang.String key)
```
    取值
    
    参数:
    
    key - key
    
    返回:
    
    值
  - get
```
public <T> T get(java.lang.String key,
                 T defaultValue)
```
    取值 (指定默认值)
    
    类型参数:
    
    T - 默认值的类型
    
    参数:
    
    key - key
    
    defaultValue - 取不到值时返回的默认值
    
    返回:
    
    值
  - get
```
public <T> T get(java.lang.String key,
                 SaRetFunction fun)
```
    取值 (如果值为null，则执行fun函数获取值)
    
    类型参数:
    
    T - 返回值的类型
    
    参数:
    
    key - key
    
    fun - 值为null时执行的函数
    
    返回:
    
    值
  - getString
```
public java.lang.String getString(java.lang.String key)
```
    取值 (转String类型)
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getInt
```
public int getInt(java.lang.String key)
```
    取值 (转int类型)
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getLong
```
public long getLong(java.lang.String key)
```
    取值 (转long类型)
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getDouble
```
public double getDouble(java.lang.String key)
```
    取值 (转double类型)
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getFloat
```
public float getFloat(java.lang.String key)
```
    取值 (转float类型)
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getModel
```
public <T> T getModel(java.lang.String key,
                      java.lang.Class<T> cs)
```
    取值 (指定转换类型)
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    key - key
    
    cs - 指定转换类型
    
    返回:
    
    值
  - getModel
```
public <T> T getModel(java.lang.String key,
                      java.lang.Class<T> cs,
                      java.lang.Object defaultValue)
```
    取值 (指定转换类型, 并指定值为Null时返回的默认值)
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    key - key
    
    cs - 指定转换类型
    
    defaultValue - 值为Null时返回的默认值
    
    返回:
    
    值
  - keys
```
public java.util.Set<java.lang.String> keys()
```
    返回当前Session的所有key
    
    返回:
    
    所有值的key列表
  - set
```
public SaSession set(java.lang.String key,
                     java.lang.Object value)
```
    写值
    
    参数:
    
    key - 名称
    
    value - 值
    
    返回:
    
    对象自身
  - setDefaultValue
```
public SaSession setDefaultValue(java.lang.String key,
                                 java.lang.Object value)
```
    写值(只有在此key原本无值的时候才会写入)
    
    参数:
    
    key - 名称
    
    value - 值
    
    返回:
    
    对象自身
  - has
```
public boolean has(java.lang.String key)
```
    是否含有某个key
    
    参数:
    
    key - has
    
    返回:
    
    是否含有
  - delete
```
public SaSession delete(java.lang.String key)
```
    删值
    
    参数:
    
    key - 要删除的key
    
    返回:
    
    对象自身
  - clear
```
public void clear()
```
    清空所有值
  - getDataMap
```
public java.util.Map<java.lang.String,java.lang.Object> getDataMap()
```
    获取数据挂载集合（如果更新map里的值，请调用session.update()方法避免产生脏数据）
    
    返回:
    
    返回底层储存值的map对象
  - refreshDataMap
```
public void refreshDataMap(java.util.Map<java.lang.String,java.lang.Object> dataMap)
```
    写入数据集合 (不改变底层对象，只将此dataMap所有数据进行替换)
    
    参数:
    
    dataMap - 数据集合
  - valueIsNull
```
public boolean valueIsNull(java.lang.Object value)
```
    判断一个值是否为null
    
    参数:
    
    value - 指定值
    
    返回:
    
    此value是否为null
  - getValueByDefaultValue
```
protected <T> T getValueByDefaultValue(java.lang.Object value,
                                       T defaultValue)
```
    根据默认值来获取值
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    value - 值
    
    defaultValue - 默认值
    
    返回:
    
    转换后的值
  - setAttribute
```
@Deprecated
public void setAttribute(java.lang.String key,
                                      java.lang.Object value)
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.set(key)
    写入一个值
    
    参数:
    
    key - 名称
    
    value - 值
  - getAttribute
```
@Deprecated
public java.lang.Object getAttribute(java.lang.String key)
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.get(key)
    取出一个值
    
    参数:
    
    key - 名称
    
    返回:
    
    值
  - getAttribute
```
@Deprecated
public java.lang.Object getAttribute(java.lang.String key,
                                                  java.lang.Object defaultValue)
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.get(key, defaultValue)
    取值，并指定取不到值时的默认值
    
    参数:
    
    key - 名称
    
    defaultValue - 取不到值的时候返回的默认值
    
    返回:
    
    value
  - removeAttribute
```
@Deprecated
public void removeAttribute(java.lang.String key)
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.delete(key)
    移除一个值
    
    参数:
    
    key - 要移除的值的名字
  - clearAttribute
```
@Deprecated
public void clearAttribute()
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.clear()
    清空所有值
  - containsAttribute
```
@Deprecated
public boolean containsAttribute(java.lang.String key)
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.has(key)
    是否含有指定key
    
    参数:
    
    key - 是否含有指定值
    
    返回:
    
    是否含有
  - attributeKeys
```
@Deprecated
public java.util.Set<java.lang.String> attributeKeys()
```
    已过时。
    
    此函数设计已过时，未来版本可能移除此类，请及时更换为: session.keys()
    返回当前session会话所有key
    
    返回:
    
    所有值的key列表

类 SaSession

字段概要

构造器概要

方法概要

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

字段详细资料

ROLE_LIST

PERMISSION_LIST

构造器详细资料

SaSession

SaSession

方法详细资料

getId

setId

getCreateTime

setCreateTime

getTokenSignList

tokenSignListCopy

tokenSignListCopyByDevice

getTokenSign

addTokenSign

addTokenSign

removeTokenSign

update

logout

logoutByTokenSignCountToZero

getTimeout

updateTimeout

updateMinTimeout

updateMaxTimeout

trans

get

get

get

getString

getInt

getLong

getDouble

getFloat

getModel

getModel

keys

set

setDefaultValue

has

delete

clear

getDataMap

refreshDataMap

valueIsNull

getValueByDefaultValue

setAttribute

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.set(key)

getAttribute

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.get(key)

getAttribute

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.get(key, defaultValue)

removeAttribute

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.delete(key)

clearAttribute

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.clear()

containsAttribute

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.has(key)

attributeKeys

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.keys()