cn.dev33.satoken.dao

接口 SaTokenDao

所有已知实现类:

SaTokenDaoDefaultImpl

public interface SaTokenDao

Sa-Token持久层接口

作者:

kong

字段概要

字段

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

方法概要

限定符和类型	方法和说明
void	delete(java.lang.String key) 删除Value
void	deleteObject(java.lang.String key) 删除Object
default void	deleteSession(java.lang.String sessionId) 删除Session
java.lang.String	get(java.lang.String key) 获取Value，如无返空
java.lang.Object	getObject(java.lang.String key) 获取Object，如无返空
long	getObjectTimeout(java.lang.String key) 获取Object的剩余存活时间 (单位: 秒)
default SaSession	getSession(java.lang.String sessionId) 获取Session，如无返空
default long	getSessionTimeout(java.lang.String sessionId) 获取Session剩余存活时间 (单位: 秒)
long	getTimeout(java.lang.String key) 获取Value的剩余存活时间 (单位: 秒)
java.util.List<java.lang.String>	searchData(java.lang.String prefix, java.lang.String keyword, int start, int size) 搜索数据
void	set(java.lang.String key, java.lang.String value, long timeout) 写入Value，并设定存活时间 (单位: 秒)
void	setObject(java.lang.String key, java.lang.Object object, long timeout) 写入Object，并设定存活时间 (单位: 秒)
default void	setSession(SaSession session, long timeout) 写入Session，并设定存活时间 (单位: 秒)
void	update(java.lang.String key, java.lang.String value) 更新Value (过期时间不变)
void	updateObject(java.lang.String key, java.lang.Object object) 更新Object (过期时间不变)
void	updateObjectTimeout(java.lang.String key, long timeout) 修改Object的剩余存活时间 (单位: 秒)
default void	updateSession(SaSession session) 更新Session
default void	updateSessionTimeout(java.lang.String sessionId, long timeout) 修改Session剩余存活时间 (单位: 秒)
void	updateTimeout(java.lang.String key, long timeout) 修改Value的剩余存活时间 (单位: 秒)

字段详细资料

NEVER_EXPIRE

static final long NEVER_EXPIRE

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

另请参阅:

常量字段值

NOT_VALUE_EXPIRE

static final long NOT_VALUE_EXPIRE

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

另请参阅:

常量字段值

方法详细资料

get

java.lang.String get(java.lang.String key)

获取Value，如无返空

参数:

key - 键名称

返回:

value

set

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

写入Value，并设定存活时间 (单位: 秒)

参数:

key - 键名称

value - 值

timeout - 过期时间(值大于0时限时存储，值=-1时永久存储，值=0或小于-2时不存储)

update

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

更新Value (过期时间不变)

参数:

key - 键名称

value - 值

delete

void delete(java.lang.String key)

删除Value

参数:

key - 键名称

getTimeout

long getTimeout(java.lang.String key)

获取Value的剩余存活时间 (单位: 秒)

参数:

key - 指定key

返回:

这个key的剩余存活时间

updateTimeout

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

修改Value的剩余存活时间 (单位: 秒)

参数:

key - 指定key

timeout - 过期时间

getObject

java.lang.Object getObject(java.lang.String key)

获取Object，如无返空

参数:

key - 键名称

返回:

object

setObject

void setObject(java.lang.String key,
               java.lang.Object object,
               long timeout)

写入Object，并设定存活时间 (单位: 秒)

参数:

key - 键名称

object - 值

timeout - 存活时间 (值大于0时限时存储，值=-1时永久存储，值=0或小于-2时不存储)

updateObject

void updateObject(java.lang.String key,
                  java.lang.Object object)

更新Object (过期时间不变)

参数:

key - 键名称

object - 值

deleteObject

void deleteObject(java.lang.String key)

删除Object

参数:

key - 键名称

getObjectTimeout

long getObjectTimeout(java.lang.String key)

获取Object的剩余存活时间 (单位: 秒)

参数:

key - 指定key

返回:

这个key的剩余存活时间

updateObjectTimeout

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

修改Object的剩余存活时间 (单位: 秒)

参数:

key - 指定key

timeout - 过期时间

getSession

default SaSession getSession(java.lang.String sessionId)

获取Session，如无返空

参数:

sessionId - sessionId

返回:

SaSession

setSession

default void setSession(SaSession session,
                        long timeout)

写入Session，并设定存活时间 (单位: 秒)

参数:

session - 要保存的Session对象

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

updateSession

default void updateSession(SaSession session)

更新Session

参数:

session - 要更新的session对象

deleteSession

default void deleteSession(java.lang.String sessionId)

删除Session

参数:

sessionId - sessionId

getSessionTimeout

default long getSessionTimeout(java.lang.String sessionId)

获取Session剩余存活时间 (单位: 秒)

参数:

sessionId - 指定Session

返回:

这个Session的剩余存活时间

updateSessionTimeout

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

修改Session剩余存活时间 (单位: 秒)

参数:

sessionId - 指定Session

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 - 获取数量

返回:

查询到的数据集合