程序包 cn.dev33.satoken.dao

接口 SaTokenDao

所有已知实现类:
SaTokenDaoDefaultImpl
public interface SaTokenDao
Sa-Token持久层接口
作者:
kong

  • 字段详细资料

    • NEVER_EXPIRE

      static final long NEVER_EXPIRE
      常量，表示一个key永不过期 (在一个key被标注为永远不过期时返回此值)
      另请参阅:

    • NOT_VALUE_EXPIRE

      static final long NOT_VALUE_EXPIRE
      常量，表示系统中不存在这个缓存 (在对不存在的key获取剩余存活时间时返回此值)
      另请参阅:

  • 方法详细资料

    • get

      String get(String key)
      获取Value，如无返空
      参数:
      key - 键名称
      返回:
      value

    • set

      void set(String key, String value, long timeout)
      写入Value，并设定存活时间 (单位: 秒)
      参数:
      key - 键名称
      value - 值
      timeout - 过期时间(值大于0时限时存储，值=-1时永久存储，值=0或小于-2时不存储)

    • update

      void update(String key, String value)
      更新Value (过期时间不变)
      参数:
      key - 键名称
      value - 值

    • delete

      void delete(String key)
      删除Value
      参数:
      key - 键名称

    • getTimeout

      long getTimeout(String key)
      获取Value的剩余存活时间 (单位: 秒)
      参数:
      key - 指定key
      返回:
      这个key的剩余存活时间

    • updateTimeout

      void updateTimeout(String key, long timeout)
      修改Value的剩余存活时间 (单位: 秒)
      参数:
      key - 指定key
      timeout - 过期时间

    • getObject

      Object getObject(String key)
      获取Object，如无返空
      参数:
      key - 键名称
      返回:
      object

    • setObject

      void setObject(String key, Object object, long timeout)
      写入Object，并设定存活时间 (单位: 秒)
      参数:
      key - 键名称
      object - 值
      timeout - 存活时间 (值大于0时限时存储，值=-1时永久存储，值=0或小于-2时不存储)

    • updateObject

      void updateObject(String key, Object object)
      更新Object (过期时间不变)
      参数:
      key - 键名称
      object - 值

    • deleteObject

      void deleteObject(String key)
      删除Object
      参数:
      key - 键名称

    • getObjectTimeout

      long getObjectTimeout(String key)
      获取Object的剩余存活时间 (单位: 秒)
      参数:
      key - 指定key
      返回:
      这个key的剩余存活时间

    • updateObjectTimeout

      void updateObjectTimeout(String key, long timeout)
      修改Object的剩余存活时间 (单位: 秒)
      参数:
      key - 指定key
      timeout - 过期时间

    • getSession

      default SaSession getSession(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(String sessionId)
      删除Session
      参数:
      sessionId - sessionId

    • getSessionTimeout

      default long getSessionTimeout(String sessionId)
      获取Session剩余存活时间 (单位: 秒)
      参数:
      sessionId - 指定Session
      返回:
      这个Session的剩余存活时间

    • updateSessionTimeout

      default void updateSessionTimeout(String sessionId, long timeout)
      修改Session剩余存活时间 (单位: 秒)
      参数:
      sessionId - 指定Session
      timeout - 过期时间

    • searchData

      List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType)
      搜索数据
      参数:
      prefix - 前缀
      keyword - 关键字
      start - 开始处索引
      size - 获取数量 (-1代表从start处一直取到末尾)
      sortType - 排序类型（true=正序，false=反序）
      返回:
      查询到的数据集合