Package cn.dev33.satoken.dao

Interface SaTokenDao

All Known Subinterfaces:
SaTokenDaoByObjectFollowString, SaTokenDaoBySessionFollowObject, SaTokenDaoByStringFollowObject
All Known Implementing Classes:
SaTokenDaoDefaultImpl
public interface SaTokenDao
Sa-Token 持久层接口

此接口的不同实现类可将数据存储至不同位置，如：内存Map、Redis 等等。 如果你要自定义数据存储策略，也需通过实现此接口来完成。

Since:
1.10.0
Author:
click33

  • Field Details

    • NEVER_EXPIRE

      static final long NEVER_EXPIRE
      常量，表示一个 key 永不过期 （在一个 key 被标注为永远不过期时返回此值）
      See Also:

    • NOT_VALUE_EXPIRE

      static final long NOT_VALUE_EXPIRE
      常量，表示系统中不存在这个缓存（在对不存在的 key 获取剩余存活时间时返回此值）
      See Also:

  • Method Details

    • get

      String get(String key)
      获取 value，如无返空
      Parameters:
      key - 键名称
      Returns:
      value

    • set

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

    • update

      void update(String key, String value)
      更新 value （过期时间不变）
      Parameters:
      key - 键名称
      value - 值

    • delete

      void delete(String key)
      删除 value
      Parameters:
      key - 键名称

    • getTimeout

      long getTimeout(String key)
      获取 value 的剩余存活时间（单位: 秒）
      Parameters:
      key - 指定 key
      Returns:
      这个 key 的剩余存活时间

    • updateTimeout

      void updateTimeout(String key, long timeout)
      修改 value 的剩余存活时间（单位: 秒）
      Parameters:
      key - 指定 key
      timeout - 过期时间（单位: 秒）

    • getObject

      Object getObject(String key)
      获取 Object，如无返空
      Parameters:
      key - 键名称
      Returns:
      object

    • getObject

      <T> T getObject(String key, Class<T> classType)
      获取 Object (指定反序列化类型)，如无返空
      Parameters:
      key - 键名称
      Returns:
      object

    • setObject

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

    • updateObject

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

    • deleteObject

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

    • getObjectTimeout

      long getObjectTimeout(String key)
      获取 Object 的剩余存活时间 （单位: 秒）
      Parameters:
      key - 指定 key
      Returns:
      这个 key 的剩余存活时间

    • updateObjectTimeout

      void updateObjectTimeout(String key, long timeout)
      修改 Object 的剩余存活时间（单位: 秒）
      Parameters:
      key - 指定 key
      timeout - 剩余存活时间

    • getSession

      SaSession getSession(String sessionId)
      获取 SaSession，如无返空
      Parameters:
      sessionId - sessionId
      Returns:
      SaSession

    • setSession

      void setSession(SaSession session, long timeout)
      写入 SaSession，并设定存活时间（单位: 秒）
      Parameters:
      session - 要保存的 SaSession 对象
      timeout - 过期时间（单位: 秒）

    • updateSession

      void updateSession(SaSession session)
      更新 SaSession
      Parameters:
      session - 要更新的 SaSession 对象

    • deleteSession

      void deleteSession(String sessionId)
      删除 SaSession
      Parameters:
      sessionId - sessionId

    • getSessionTimeout

      long getSessionTimeout(String sessionId)
      获取 SaSession 剩余存活时间（单位: 秒）
      Parameters:
      sessionId - 指定 SaSession
      Returns:
      这个 SaSession 的剩余存活时间

    • updateSessionTimeout

      void updateSessionTimeout(String sessionId, long timeout)
      修改 SaSession 剩余存活时间（单位: 秒）
      Parameters:
      sessionId - 指定 SaSession
      timeout - 剩余存活时间

    • searchData

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

    • init

      default void init()
      当此 SaTokenDao 实例被装载时触发

    • destroy

      default void destroy()
      当此 SaTokenDao 实例被卸载时触发