KeyHandler (spring-boot-starter-fast-redis 1.2.2 API)

java.lang.Object
- wiki.xsx.core.handler.KeyHandler

```
public class KeyHandler
extends Object
```
键助手

从以下版本开始:

1.8

作者:

xsx

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Long`	`count()` 当前数据库中键的数量 DBSIZE
`byte[]`	`dump(String key)` 获取序列化字符串 DUMP key
`byte[]`	`dumpAsObj(String key)` 获取序列化对象 DUMP key
`Boolean`	`expire(String key, long timeout, TimeUnit timeUnit)` 设置字符串过期时间 EXPIRE key seconds
`Boolean`	`expireAsObj(String key, long timeout, TimeUnit timeUnit)` 设置对象过期时间 EXPIRE key seconds
`Boolean`	`expireAt(String key, Date date)` 设置字符串过期时间 EXPIREAT key timestamp
`Boolean`	`expireAtAsObj(String key, Date date)` 设置对象过期时间 EXPIREAT key timestamp
`Long`	`getExpire(String key, TimeUnit timeUnit)` 获取字符串过期时间 TTL key
`Long`	`getExpireAsObj(String key, TimeUnit timeUnit)` 获取对象过期时间 TTL key
`static KeyHandler`	`getInstance(org.springframework.data.redis.core.RedisTemplate<String,Object> redisTemplate, org.springframework.data.redis.core.StringRedisTemplate stringRedisTemplate)` 获取实例
`org.springframework.data.redis.core.RedisTemplate`	`getRedisTemplate()` 获取spring redis模板
`org.springframework.data.redis.core.StringRedisTemplate`	`getStringRedisTemplate()` 获取spring string redis模板
`org.springframework.data.redis.connection.DataType`	`getType(String key)` 获取字符串存储数据类型 TYPE key
`org.springframework.data.redis.connection.DataType`	`getTypeAsObj(String key)` 获取对象存储数据类型 TYPE key
`Boolean`	`hasKey(String key)` 是否存在key(字符串) EXISTS key [key ...]
`Boolean`	`hasKeyAsObj(String key)` 是否存在key(对象) EXISTS key [key ...]
`Set<String>`	`keys(String pattern)` 字符串的键集合 EXISTS key [key ...]
`Set<String>`	`keysAsObj(String pattern)` 对象的键集合 EXISTS key [key ...]
`Long`	`keysCount(String... keys)` 字符串的键存在的数量 EXISTS key [key ...]
`Long`	`keysCountAsObj(String... keys)` 对象的键存在的数量 EXISTS key [key ...]
`Boolean`	`move(int dbIndex, String key)` 移动字符串到指定数据库 MOVE key db
`Boolean`	`moveAsObj(int dbIndex, String key)` 移动对象到指定数据库 MOVE key db
`Boolean`	`persist(String key)` 持久化字符串 PERSIST key
`Boolean`	`persistAsObj(String key)` 持久化对象 PERSIST key
`String`	`randomKey()` 获取字符串随机key RANDOMKEY
`String`	`randomKeyAsObj()` 获取对象随机key RANDOMKEY
`Long`	`remove(String... keys)` 移除字符串key DEL key [key ...]
`Long`	`removeAsObj(String... keys)` 移除对象key DEL key [key ...]
`void`	`rename(String oldKey, String newKey)` 重命名字符串key RENAME key newkey
`void`	`renameAsObj(String oldKey, String newKey)` 重命名对象key RENAME key newkey
`Boolean`	`renameAsObjIfAbsent(String oldKey, String newKey)` 重命名对象key如果存在 RENAMENX key newkey
`Boolean`	`renameIfAbsent(String oldKey, String newKey)` 重命名字符串key如果存在 RENAMENX key newkey
`void`	`restore(String key, byte[] value, Long timeout, TimeUnit unit, boolean replace)` 序列化存储字符串 RESTORE key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]
`void`	`restoreAsObj(String key, byte[] value, Long timeout, TimeUnit unit, boolean replace)` 序列化存储对象 RESTORE key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]
`Long`	`touch(String... keys)` 字符串最后访问时间更新 TOUCH key [key ...]
`Long`	`touchAsObj(String... keys)` 对象最后访问时间更新 TOUCH key [key ...]
`Long`	`unlink(String... keys)` 移除存在的字符串key UNLINK key [key ...]
`Long`	`unlinkAsObj(String... keys)` 移除存在的对象key UNLINK key [key ...]

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

- 方法详细资料
  - getInstance
```
public static KeyHandler getInstance(org.springframework.data.redis.core.RedisTemplate<String,Object> redisTemplate,
                                     org.springframework.data.redis.core.StringRedisTemplate stringRedisTemplate)
```
    获取实例
    
    参数:
    
    redisTemplate - 对象模板
    
    stringRedisTemplate - 字符串模板
    
    返回:
    
    返回实例
  - hasKeyAsObj
```
public Boolean hasKeyAsObj(String key)
```
    是否存在key(对象)
    EXISTS key [key ...]
    
    参数:
    
    key - 键
    
    返回:
    
    返回布尔值,存在true,不存在false
    
    从以下版本开始:
    
    redis 1.0.0
  - hasKey
```
public Boolean hasKey(String key)
```
    是否存在key(字符串)
    EXISTS key [key ...]
    
    参数:
    
    key - 键
    
    返回:
    
    返回布尔值,存在true,不存在false
    
    从以下版本开始:
    
    redis 1.0.0
  - removeAsObj
```
public Long removeAsObj(String... keys)
```
    移除对象key
    DEL key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回移除数量
    
    从以下版本开始:
    
    redis 1.0.0
  - remove
```
public Long remove(String... keys)
```
    移除字符串key
    DEL key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回移除数量
    
    从以下版本开始:
    
    redis 1.0.0
  - unlinkAsObj
```
public Long unlinkAsObj(String... keys)
```
    移除存在的对象key
    UNLINK key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回移除数量
    
    从以下版本开始:
    
    redis 4.0.0
  - unlink
```
public Long unlink(String... keys)
```
    移除存在的字符串key
    UNLINK key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回移除数量
    
    从以下版本开始:
    
    redis 4.0.0
  - expireAsObj
```
public Boolean expireAsObj(String key,
                           long timeout,
                           TimeUnit timeUnit)
```
    设置对象过期时间
    EXPIRE key seconds
    
    参数:
    
    key - 键
    
    timeout - 过期时间
    
    timeUnit - 时间单位
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.0.0
  - expire
```
public Boolean expire(String key,
                      long timeout,
                      TimeUnit timeUnit)
```
    设置字符串过期时间
    EXPIRE key seconds
    
    参数:
    
    key - 键
    
    timeout - 过期时间
    
    timeUnit - 时间单位
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.0.0
  - expireAtAsObj
```
public Boolean expireAtAsObj(String key,
                             Date date)
```
    设置对象过期时间
    EXPIREAT key timestamp
    
    参数:
    
    key - 键
    
    date - 过期时间
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.2.0
  - expireAt
```
public Boolean expireAt(String key,
                        Date date)
```
    设置字符串过期时间
    EXPIREAT key timestamp
    
    参数:
    
    key - 键
    
    date - 过期时间
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.2.0
  - getExpireAsObj
```
public Long getExpireAsObj(String key,
                           TimeUnit timeUnit)
```
    获取对象过期时间
    TTL key
    
    参数:
    
    key - 键
    
    timeUnit - 时间单位
    
    返回:
    
    返回对象过期时间
    
    从以下版本开始:
    
    redis 1.0.0
  - getExpire
```
public Long getExpire(String key,
                      TimeUnit timeUnit)
```
    获取字符串过期时间
    TTL key
    
    参数:
    
    key - 键
    
    timeUnit - 时间单位
    
    返回:
    
    返回字符串过期时间
    
    从以下版本开始:
    
    redis 1.0.0
  - getTypeAsObj
```
public org.springframework.data.redis.connection.DataType getTypeAsObj(String key)
```
    获取对象存储数据类型
    TYPE key
    
    参数:
    
    key - 键
    
    返回:
    
    返回对象存储数据类型
    
    从以下版本开始:
    
    redis 1.0.0
  - getType
```
public org.springframework.data.redis.connection.DataType getType(String key)
```
    获取字符串存储数据类型
    TYPE key
    
    参数:
    
    key - 键
    
    返回:
    
    返回字符串存储数据类型
    
    从以下版本开始:
    
    redis 1.0.0
  - keysAsObj
```
public Set<String> keysAsObj(String pattern)
```
    对象的键集合
    EXISTS key [key ...]
    
    参数:
    
    pattern - 键规则
    
    返回:
    
    返回对象键的集合
    
    从以下版本开始:
    
    redis 1.0.0
  - keys
```
public Set<String> keys(String pattern)
```
    字符串的键集合
    EXISTS key [key ...]
    
    参数:
    
    pattern - 键规则
    
    返回:
    
    返回字符串键的集合
    
    从以下版本开始:
    
    redis 1.0.0
  - keysCountAsObj
```
public Long keysCountAsObj(String... keys)
```
    对象的键存在的数量
    EXISTS key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回对象键的数量
    
    从以下版本开始:
    
    redis 1.0.0
  - keysCount
```
public Long keysCount(String... keys)
```
    字符串的键存在的数量
    EXISTS key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回字符串键的数量
    
    从以下版本开始:
    
    redis 1.0.0
  - randomKeyAsObj
```
public String randomKeyAsObj()
```
    获取对象随机key
    RANDOMKEY
    
    返回:
    
    返回对象随机的键
    
    从以下版本开始:
    
    redis 1.0.0
  - randomKey
```
public String randomKey()
```
    获取字符串随机key
    RANDOMKEY
    
    返回:
    
    返回字符串随机的键
    
    从以下版本开始:
    
    redis 1.0.0
  - renameAsObj
```
public void renameAsObj(String oldKey,
                        String newKey)
```
    重命名对象key
    RENAME key newkey
    
    参数:
    
    oldKey - 旧key
    
    newKey - 新key
    
    从以下版本开始:
    
    redis 1.0.0
  - rename
```
public void rename(String oldKey,
                   String newKey)
```
    重命名字符串key
    RENAME key newkey
    
    参数:
    
    oldKey - 旧key
    
    newKey - 新key
    
    从以下版本开始:
    
    redis 1.0.0
  - renameAsObjIfAbsent
```
public Boolean renameAsObjIfAbsent(String oldKey,
                                   String newKey)
```
    重命名对象key如果存在
    RENAMENX key newkey
    
    参数:
    
    oldKey - 旧key
    
    newKey - 新key
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.0.0
  - renameIfAbsent
```
public Boolean renameIfAbsent(String oldKey,
                              String newKey)
```
    重命名字符串key如果存在
    RENAMENX key newkey
    
    参数:
    
    oldKey - 旧key
    
    newKey - 新key
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.0.0
  - persistAsObj
```
public Boolean persistAsObj(String key)
```
    持久化对象
    PERSIST key
    
    参数:
    
    key - 键
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 2.2.0
  - persist
```
public Boolean persist(String key)
```
    持久化字符串
    PERSIST key
    
    参数:
    
    key - 键
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 2.2.0
  - moveAsObj
```
public Boolean moveAsObj(int dbIndex,
                         String key)
```
    移动对象到指定数据库
    MOVE key db
    
    参数:
    
    dbIndex - 数据库索引
    
    key - 键
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.0.0
  - move
```
public Boolean move(int dbIndex,
                    String key)
```
    移动字符串到指定数据库
    MOVE key db
    
    参数:
    
    dbIndex - 数据库索引
    
    key - 键
    
    返回:
    
    返回布尔值,成功true,失败false
    
    从以下版本开始:
    
    redis 1.0.0
  - count
```
public Long count()
```
    当前数据库中键的数量
    DBSIZE
    
    返回:
    
    返回键的数量
    
    从以下版本开始:
    
    redis 1.0.0
  - dumpAsObj
```
public byte[] dumpAsObj(String key)
```
    获取序列化对象
    DUMP key
    
    参数:
    
    key - 键
    
    返回:
    
    返回字节数组
    
    从以下版本开始:
    
    redis 2.6.0
  - dump
```
public byte[] dump(String key)
```
    获取序列化字符串
    DUMP key
    
    参数:
    
    key - 键
    
    返回:
    
    返回字节数组
    
    从以下版本开始:
    
    redis 2.6.0
  - restoreAsObj
```
public void restoreAsObj(String key,
                         byte[] value,
                         Long timeout,
                         TimeUnit unit,
                         boolean replace)
```
    序列化存储对象
    RESTORE key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]
    
    参数:
    
    key - 键
    
    value - 对象字节
    
    timeout - 过期时间
    
    unit - 单位
    
    replace - 是否替换
    
    从以下版本开始:
    
    redis 2.6.0
  - restore
```
public void restore(String key,
                    byte[] value,
                    Long timeout,
                    TimeUnit unit,
                    boolean replace)
```
    序列化存储字符串
    RESTORE key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]
    
    参数:
    
    key - 键
    
    value - 字符串字节
    
    timeout - 过期时间
    
    unit - 单位
    
    replace - 是否替换
    
    从以下版本开始:
    
    redis 2.6.0
  - touchAsObj
```
public Long touchAsObj(String... keys)
```
    对象最后访问时间更新
    TOUCH key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回更新数量
    
    从以下版本开始:
    
    redis 3.2.1
  - touch
```
public Long touch(String... keys)
```
    字符串最后访问时间更新
    TOUCH key [key ...]
    
    参数:
    
    keys - 键
    
    返回:
    
    返回更新数量
    
    从以下版本开始:
    
    redis 3.2.1
  - getRedisTemplate
```
public org.springframework.data.redis.core.RedisTemplate getRedisTemplate()
```
    获取spring redis模板
    
    返回:
    
    返回对象模板
  - getStringRedisTemplate
```
public org.springframework.data.redis.core.StringRedisTemplate getStringRedisTemplate()
```
    获取spring string redis模板
    
    返回:
    
    返回字符串模板

类 KeyHandler

方法概要

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

方法详细资料

getInstance

hasKeyAsObj

hasKey

removeAsObj

remove

unlinkAsObj

unlink

expireAsObj

expire

expireAtAsObj

expireAt

getExpireAsObj

getExpire

getTypeAsObj

getType

keysAsObj

keys

keysCountAsObj

keysCount

randomKeyAsObj

randomKey

renameAsObj

rename

renameAsObjIfAbsent

renameIfAbsent

persistAsObj

persist

moveAsObj

move

count

dumpAsObj

dump

restoreAsObj

restore

touchAsObj

touch

getRedisTemplate

getStringRedisTemplate