RedisUtils.KeyOps (commons-redis-spring-boot-starter 1.0.0 API)

java.lang.Object
- cn.fscode.commons.redis.utils.RedisUtils.KeyOps

封闭类:: RedisUtils

public static class RedisUtils.KeyOps
extends Object

key相关操作

作者:: shenguangyang

构造器概要

构造器
构造器和说明

KeyOps()

构造器
构造器和说明
`KeyOps()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static long`	`delete(Collection<String> keys)` 根据keys, 批量删除key-value 注: 若redis中，不存在对应的key, 那么计数不会加1, 即: redis中存在的key-value里，有名为a1、a2的key，删除时，传的集合是a1、a2、a3，那么返回结果为2。
`static boolean`	`delete(String key)` 根据key, 删除redis中的对应key-value 注: 若删除失败, 则返回false。
`static byte[]`	`dump(String key)` 将key对应的value值进行序列化，并返回序列化后的value值。
`static boolean`	`expire(String key, long timeout, TimeUnit unit)` 给指定的key对应的key-value设置: 多久过时注:过时后，redis会自动删除对应的key-value。
`static boolean`	`expireAt(String key, Date date)` 给指定的key对应的key-value设置: 什么时候过时注:过时后，redis会自动删除对应的key-value。
`static long`	`getExpire(String key)` 获取key对应的key-value的过期时间注: 若key-value永不过期，那么返回的为-1。
`static long`	`getExpire(String key, TimeUnit unit)` 获取key对应的key-value的过期时间注: 若key-value永不过期，那么返回的为-1。
`static boolean`	`hasKey(String key)` redis中是否存在,指定key的key-value
`static Set<String>`	`keys(String pattern)` 找到所有匹配pattern的key,并返回该key的结合.
`static boolean`	`move(String key, int dbIndex)` 将当前数据库中的key对应的key-value,移动到对应位置的数据库中。
`static boolean`	`persist(String key)` 移除key对应的key-value的过期时间, 使该key-value一直存在注: 若key对应的key-value，本身就是一直存在(无过期时间的)，那么persist方法会返回false; 若没有key对应的key-value存在，本那么persist方法会返回false;
`static Object`	`randomKey()` 从redis的所有key中，随机获取一个key 注: 若redis中不存在任何key-value, 那么这里返回null
`static void`	`rename(String oldKey, String newKey)` 重命名对应的oldKey为新的newKey 注: 若oldKey不存在，则会抛出异常.
`static boolean`	`renameIfAbsent(String oldKey, String newKey)` 当redis中不存在newKey时, 重命名对应的oldKey为新的newKey。
`static void`	`restore(String key, byte[] value, long timeToLive, TimeUnit unit)` 将给定的value值，反序列化到redis中, 形成新的key-value。
`static void`	`restore(String key, byte[] value, long timeout, TimeUnit unit, boolean replace)` 将给定的value值，反序列化到redis中, 形成新的key-value。
`static org.springframework.data.redis.connection.DataType`	`type(String key)` 获取key对应的value的数据类型注: 若redis中不存在该key对应的key-value，那么这里返回NONE。

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

- 构造器详细资料
  - KeyOps
```
public KeyOps()
```
- 方法详细资料
  - delete
```
public static boolean delete(String key)
```
    根据key, 删除redis中的对应key-value 注: 若删除失败, 则返回false。若redis中，不存在该key, 那么返回的也是false。所以，不能因为返回了false,就认为redis中一定还存在该key对应的key-value。
    
    参数:
    
    key - 要删除的key
    
    返回:
    
    删除是否成功
  - delete
```
public static long delete(Collection<String> keys)
```
    根据keys, 批量删除key-value 注: 若redis中，不存在对应的key, 那么计数不会加1, 即: redis中存在的key-value里，有名为a1、a2的key，删除时，传的集合是a1、a2、a3，那么返回结果为2。
    
    参数:
    
    keys - 要删除的key集合
    
    返回:
    
    删除了的key-value个数
  - dump
```
public static byte[] dump(String key)
```
    将key对应的value值进行序列化，并返回序列化后的value值。注: 若不存在对应的key, 则返回null。注: dump时，并不会删除redis中的对应key-value。注: dump功能与restore相反。
    
    参数:
    
    key - 要序列化的value的key
    
    返回:
    
    序列化后的value值
  - restore
```
public static void restore(String key,
                           byte[] value,
                           long timeToLive,
                           TimeUnit unit)
```
    将给定的value值，反序列化到redis中, 形成新的key-value。
    
    参数:
    
    key - value对应的key
    
    value - 要反序列的value值。注: 这个值可以由 dump(String) 获得
    
    timeToLive - 反序列化后的key-value的存活时长
    
    unit - timeToLive的单位
    
    抛出:
    
    org.springframework.data.redis.RedisSystemException - 如果redis中已存在同样的key时，抛出此异常
  - restore
```
public static void restore(String key,
                           byte[] value,
                           long timeout,
                           TimeUnit unit,
                           boolean replace)
```
    将给定的value值，反序列化到redis中, 形成新的key-value。
    
    参数:
    
    key - value对应的key
    
    value - 要反序列的value值。注: 这个值可以由 dump(String) 获得
    
    timeout - 反序列化后的key-value的存活时长
    
    unit - timeout的单位
    
    replace - 若redis中已经存在了相同的key, 是否替代原来的key-value
    
    抛出:
    
    org.springframework.data.redis.RedisSystemException - 如果redis中已存在同样的key, 且replace为false时，抛出此异常
  - hasKey
```
public static boolean hasKey(String key)
```
    redis中是否存在,指定key的key-value
    
    参数:
    
    key - 指定的key
    
    返回:
    
    是否存在对应的key-value
  - expire
```
public static boolean expire(String key,
                             long timeout,
                             TimeUnit unit)
```
    给指定的key对应的key-value设置: 多久过时注:过时后，redis会自动删除对应的key-value。注:若key不存在，那么也会返回false。
    
    参数:
    
    key - 指定的key
    
    timeout - 过时时间
    
    unit - timeout的单位
    
    返回:
    
    操作是否成功
  - expireAt
```
public static boolean expireAt(String key,
                               Date date)
```
    给指定的key对应的key-value设置: 什么时候过时注:过时后，redis会自动删除对应的key-value。注:若key不存在，那么也会返回false。
    
    参数:
    
    key - 指定的key
    
    date - 啥时候过时
    
    返回:
    
    操作是否成功
  - keys
```
public static Set<String> keys(String pattern)
```
    找到所有匹配pattern的key,并返回该key的结合. 提示:若redis中键值对较多，此方法耗时相对较长，慎用！慎用！慎用！
    
    参数:
    
    pattern - 匹配模板。注: 常用的通配符有: ? 有且只有一个; * >=0哥;
    
    返回:
    
    匹配pattern的key的集合。可能为null。
  - move
```
public static boolean move(String key,
                           int dbIndex)
```
    将当前数据库中的key对应的key-value,移动到对应位置的数据库中。注:单机版的redis,默认将存储分为16个db, index为0 到 15。注:同一个db下，key唯一；但是在不同db中，key可以相同。注:若目标db下，已存在相同的key, 那么move会失败，返回false。
    
    参数:
    
    key - 定位要移动的key-value的key
    
    dbIndex - 要移动到哪个db
    
    返回:
    
    移动是否成功。注: 若目标db下，已存在相同的key, 那么move会失败，返回false。
  - persist
```
public static boolean persist(String key)
```
    移除key对应的key-value的过期时间, 使该key-value一直存在注: 若key对应的key-value，本身就是一直存在(无过期时间的)，那么persist方法会返回false; 若没有key对应的key-value存在，本那么persist方法会返回false;
    
    参数:
    
    key - 定位key-value的key
    
    返回:
    
    操作是否成功
  - getExpire
```
public static long getExpire(String key)
```
    获取key对应的key-value的过期时间注: 若key-value永不过期，那么返回的为-1。注: 若不存在key对应的key-value，那么返回的为-2 注:若存在零碎时间不足1 SECONDS,则(大体上)四舍五入到SECONDS级别。
    
    参数:
    
    key - 定位key-value的key
    
    返回:
    
    过期时间(单位s)
  - getExpire
```
public static long getExpire(String key,
                             TimeUnit unit)
```
    获取key对应的key-value的过期时间注: 若key-value永不过期，那么返回的为-1。注: 若不存在key对应的key-value，那么返回的为-2 注:若存在零碎时间不足1 unit,则(大体上)四舍五入到unit别。
    
    参数:
    
    key - 定位key-value的key
    
    返回:
    
    过期时间(单位unit)
  - randomKey
```
public static Object randomKey()
```
    从redis的所有key中，随机获取一个key 注: 若redis中不存在任何key-value, 那么这里返回null
    
    返回:
    
    随机获取到的一个key
  - rename
```
public static void rename(String oldKey,
                          String newKey)
```
    重命名对应的oldKey为新的newKey 注: 若oldKey不存在，则会抛出异常. 注: 若redis中已存在与newKey一样的key, 那么原key-value会被丢弃，只留下新的key，以及原来的value 示例说明: 假设redis中已有 (keyAlpha, valueAlpha) 和 (keyBeta, valueBeat), 在使用rename(keyAlpha, keyBeta)替换后, redis中只会剩下(keyBeta, valueAlpha)
    
    参数:
    
    oldKey - 旧的key
    
    newKey - 新的key
    
    抛出:
    
    org.springframework.data.redis.RedisSystemException - 若oldKey不存在时，抛出此异常
  - renameIfAbsent
```
public static boolean renameIfAbsent(String oldKey,
                                     String newKey)
```
    当redis中不存在newKey时, 重命名对应的oldKey为新的newKey。否者不进行重命名操作。注: 若oldKey不存在，则会抛出异常.
    
    参数:
    
    oldKey - 旧的key
    
    newKey - 新的key
    
    抛出:
    
    org.springframework.data.redis.RedisSystemException - 若oldKey不存在时，抛出此异常
  - type
```
public static org.springframework.data.redis.connection.DataType type(String key)
```
    获取key对应的value的数据类型注: 若redis中不存在该key对应的key-value，那么这里返回NONE。
    
    参数:
    
    key - 用于定位的key
    
    返回:
    
    key对应的value的数据类型

类 RedisUtils.KeyOps

构造器概要

方法概要

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

构造器详细资料

KeyOps

方法详细资料

delete

delete

dump

restore

restore

hasKey

expire

expireAt

keys

move

persist

getExpire

getExpire

randomKey

rename

renameIfAbsent

type