cn.dev33.satoken.dao

接口 SaTokenDao

所有已知实现类:

SaTokenDaoDefaultImpl

public interface SaTokenDao

sa-token持久层的接口

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static java.lang.Long	NEVER_EXPIRE 常量，表示一个key永不过期 (在一个key被标注为永远不过期时返回此值)
static java.lang.Long	NOT_VALUE_EXPIRE 常量，表示系统中不存在这个缓存 (在对不存在的key获取剩余存活时间时返回此值)

方法概要

限定符和类型	方法和说明
void	deleteKey(java.lang.String key) 删除一个指定的key
void	deleteSession(java.lang.String sessionId) 删除一个指定的session
SaSession	getSession(java.lang.String sessionId) 根据指定key的Session，如果没有，则返回空
long	getSessionTimeout(java.lang.String sessionId) 获取指定SaSession的剩余存活时间 (单位: 秒)
long	getTimeout(java.lang.String key) 获取指定key的剩余存活时间 (单位: 秒)
java.lang.String	getValue(java.lang.String key) 根据key获取value，如果没有，则返回空
void	saveSession(SaSession session, long timeout) 将指定Session持久化
java.util.List<java.lang.String>	searchData(java.lang.String prefix, java.lang.String keyword, int start, int size) 搜索数据
void	setValue(java.lang.String key, java.lang.String value, long timeout) 写入指定key-value键值对，并设定过期时间 (单位: 秒)
void	updateSession(SaSession session) 更新指定session
void	updateSessionTimeout(java.lang.String sessionId, long timeout) 修改指定SaSession的剩余存活时间 (单位: 秒)
void	updateTimeout(java.lang.String key, long timeout) 修改指定key的剩余存活时间 (单位: 秒)
void	updateValue(java.lang.String key, java.lang.String value) 修改指定key-value键值对 (过期时间取原来的值)

字段详细资料

NEVER_EXPIRE

static final java.lang.Long NEVER_EXPIRE

常量，表示一个key永不过期 (在一个key被标注为永远不过期时返回此值)

NOT_VALUE_EXPIRE

static final java.lang.Long NOT_VALUE_EXPIRE

常量，表示系统中不存在这个缓存 (在对不存在的key获取剩余存活时间时返回此值)

方法详细资料

getValue

java.lang.String getValue(java.lang.String key)

根据key获取value，如果没有，则返回空

参数:

key - 键名称

返回:

value

setValue

void setValue(java.lang.String key,
              java.lang.String value,
              long timeout)

写入指定key-value键值对，并设定过期时间 (单位: 秒)

参数:

key - 键名称

value - 值

timeout - 过期时间 (单位: 秒)

updateValue

void updateValue(java.lang.String key,
                 java.lang.String value)

修改指定key-value键值对 (过期时间取原来的值)

参数:

key - 键名称

value - 值

deleteKey

void deleteKey(java.lang.String key)

删除一个指定的key

参数:

key - 键名称

getTimeout

long getTimeout(java.lang.String key)

获取指定key的剩余存活时间 (单位: 秒)

参数:

key - 指定key

返回:

这个key的剩余存活时间

updateTimeout

void updateTimeout(java.lang.String key,
                   long timeout)

修改指定key的剩余存活时间 (单位: 秒)

参数:

key - 指定key

timeout - 过期时间

getSession

SaSession getSession(java.lang.String sessionId)

根据指定key的Session，如果没有，则返回空

参数:

sessionId - 键名称

返回:

SaSession

saveSession

void saveSession(SaSession session,
                 long timeout)

将指定Session持久化

参数:

session - 要保存的session对象

timeout - 过期时间 (单位: 秒)

updateSession

void updateSession(SaSession session)

更新指定session

参数:

session - 要更新的session对象

deleteSession

void deleteSession(java.lang.String sessionId)

删除一个指定的session

参数:

sessionId - sessionId

getSessionTimeout

long getSessionTimeout(java.lang.String sessionId)

获取指定SaSession的剩余存活时间 (单位: 秒)

参数:

sessionId - 指定SaSession

返回:

这个SaSession的剩余存活时间 (单位: 秒)

updateSessionTimeout

void updateSessionTimeout(java.lang.String sessionId,
                          long timeout)

修改指定SaSession的剩余存活时间 (单位: 秒)

参数:

sessionId - sessionId

timeout - 过期时间

searchData

java.util.List<java.lang.String> searchData(java.lang.String prefix,
                                            java.lang.String keyword,
                                            int start,
                                            int size)

搜索数据

参数:

prefix - 前缀

keyword - 关键字

start - 开始处索引 (-1代表查询所有)

size - 获取数量

返回:

sessionId集合