RedisUtils (Ziyi Boot AutoConfigure 1.0.0 API)

java.lang.Object
- cn.ziyicloud.framework.boot.autoconfigure.data.redis.RedisUtils

```
public class RedisUtils
extends Object
```
RedisService:curd

作者:

Li Ruitong

构造器概要

构造器
构造器和说明

RedisUtils()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static long`	`decr(String key, long delta)` 递减
`static void`	`del(Collection<String> keys)` 删除缓存
`static void`	`del(String key)` 删除缓存
`static boolean`	`expire(String key, long time)` 指定缓存失效时间
`static boolean`	`expire(String key, long time, TimeUnit timeUnit)` 指定缓存失效时间
`List<String>`	`findKeysForPage(String patternKey, int page, int size)` 分页查询 key
`static Object`	`get(String key)` 普通缓存获取
`static long`	`getExpire(String key)` 根据key 获取过期时间
`static boolean`	`hasKey(String key)` 判断key是否存在
`static Long`	`hdecr(String key, String item, long by)` hash递减
`static void`	`hdel(String key, Object... item)` 删除hash表中的值
`static Object`	`hget(String key, String item)` HashGet
`static boolean`	`hHasKey(String key, String item)` 判断hash表中是否有该项的值
`static Long`	`hincr(String key, String item, long by)` hash递增如果不存在,就会创建一个并把新增后的值返回
`static Map<Object,Object>`	`hmget(String key)` 获取hashKey对应的所有键值
`static boolean`	`hmset(String key, Map<String,?> map, long time)` HashSet 并设置时间
`static boolean`	`hmset(String key, Map<String,Object> map)` HashSet
`static boolean`	`hset(String key, String item, Object value)` 向一张hash表中放入数据,如果不存在将创建
`static boolean`	`hset(String key, String item, Object value, long time)` 向一张hash表中放入数据,如果不存在将创建
`static long`	`incr(String key, long delta)` 递增
`static void`	`init(org.springframework.data.redis.core.RedisTemplate<String,Object> template, int defaultDbIndex)`
`static List<Object>`	`lGet(String key)` 获取所有list缓存的内容
`static List<Object>`	`lGet(String key, long start, long end)` 获取list缓存的内容
`static Object`	`lGetIndex(String key, long index)` 通过索引获取list中的值
`static long`	`lGetListSize(String key)` 获取list缓存的长度
`static long`	`lRemove(String key, long count, Object value)` 移除N个值为value
`static boolean`	`lSet(String key, List<Object> value)` 将list放入缓存
`static boolean`	`lSet(String key, List<Object> value, long time)` 将list放入缓存
`static boolean`	`lSet(String key, Object value)` 将list放入缓存
`static boolean`	`lSet(String key, Object value, long time)` 将list放入缓存
`static boolean`	`lUpdateIndex(String key, long index, Object value)` 根据索引修改list中的某条数据
`List<Object>`	`multiGet(List<String> keys)` 批量获取
`static void`	`resetDatabase()` 重置回默认数据库索引
`static List<String>`	`scan(String pattern)` 查找匹配key
`static boolean`	`set(String key, Object value)` 普通缓存放入
`static boolean`	`set(String key, Object value, long time)` 普通缓存放入并设置时间
`static boolean`	`set(String key, Object value, long time, TimeUnit timeUnit)` 普通缓存放入并设置时间
`static void`	`setDatabase(Integer index)` 设置数据库索引 0-15
`static long`	`setRemove(String key, Object... values)` 移除值为value的
`static Set<Object>`	`sGet(String key)` 根据key获取Set中的所有值
`static long`	`sGetSetSize(String key)` 获取set缓存的长度
`static boolean`	`sHasKey(String key, Object value)` 根据value从一个set中查询,是否存在
`static long`	`sSet(String key, Object... values)` 将数据放入set缓存
`static long`	`sSetAndTime(String key, long time, Object... values)` 将set数据放入缓存

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

构造器详细资料
- RedisUtils
```
public RedisUtils()
```

方法详细资料

init

public static void init(org.springframework.data.redis.core.RedisTemplate<String,Object> template,
                        int defaultDbIndex)

setDatabase
```
public static void setDatabase(Integer index)
```
设置数据库索引 0-15

参数:

index - 数据库索引 0-15

resetDatabase
```
public static void resetDatabase()
```
重置回默认数据库索引

expire
```
public static boolean expire(String key,
                             long time)
```
指定缓存失效时间

参数:

key - 键

time - 时间(秒)

返回:

true-成功 false-失败

expire

public static boolean expire(String key,
                             long time,
                             TimeUnit timeUnit)

指定缓存失效时间

参数:: key - 键; time - 时间(秒); timeUnit - 单位

getExpire
```
public static long getExpire(String key)
```
根据key 获取过期时间

参数:

key - 键不能为null

返回:

时间(秒) 返回0代表为永久有效

hasKey
```
public static boolean hasKey(String key)
```
判断key是否存在

参数:

key - 键

返回:

true 存在 false不存在

del
```
public static void del(String key)
```
删除缓存

参数:

key - key

del

public static void del(Collection<String> keys)

删除缓存

参数:: keys - key集合

scan

public static List<String> scan(String pattern)

查找匹配key

参数:: pattern - key
返回:: /

findKeysForPage

public List<String> findKeysForPage(String patternKey,
                                    int page,
                                    int size)

分页查询 key

参数:: patternKey - key; page - 页码; size - 每页数目
返回:: /

get
```
public static Object get(String key)
```
普通缓存获取

参数:

key - 键

返回:

值

multiGet
```
public List<Object> multiGet(List<String> keys)
```
批量获取

参数:

keys - 批量key建

返回:

结果

set

public static boolean set(String key,
                          Object value)

普通缓存放入

参数:: key - 键; value - 值
返回:: true成功 false失败

set
```
public static boolean set(String key,
                          Object value,
                          long time)
```
普通缓存放入并设置时间

参数:

key - 键

value - 值

time - 时间(秒) time要大于0 如果time小于等于0 将设置无限期

返回:

true成功 false 失败

set

public static boolean set(String key,
                          Object value,
                          long time,
                          TimeUnit timeUnit)

普通缓存放入并设置时间

参数:: key - 键; value - 值; time - 时间; timeUnit - 类型
返回:: true成功 false 失败

incr
```
public static long incr(String key,
                        long delta)
```
递增

参数:

key - 键

delta - 要增加几(大于0)

返回:

when used in pipeline / transaction.

decr
```
public static long decr(String key,
                        long delta)
```
递减

参数:

key - 键

delta - 要减少几(大于0)

返回:

when used in pipeline / transaction.

hget

public static Object hget(String key,
                          String item)

HashGet

参数:: key - 键不能为null; item - 项不能为null
返回:: 值

hmget
```
public static Map<Object,Object> hmget(String key)
```
获取hashKey对应的所有键值

参数:

key - 键

返回:

对应的多个键值

hmset

public static boolean hmset(String key,
                            Map<String,Object> map)

HashSet

参数:: key - 键; map - 对应多个键值
返回:: true 成功 false 失败

hmset

public static boolean hmset(String key,
                            Map<String,?> map,
                            long time)

HashSet 并设置时间

参数:: key - 键; map - 对应多个键值; time - 时间(秒)
返回:: true成功 false失败

hset

public static boolean hset(String key,
                           String item,
                           Object value)

向一张hash表中放入数据,如果不存在将创建

参数:: key - 键; item - 项; value - 值
返回:: true 成功 false失败

hset

public static boolean hset(String key,
                           String item,
                           Object value,
                           long time)

向一张hash表中放入数据,如果不存在将创建

参数:: key - 键; item - 项; value - 值; time - 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
返回:: true 成功 false失败

hdel

public static void hdel(String key,
                        Object... item)

删除hash表中的值

参数:: key - 键不能为null; item - 项可以使多个不能为null

hHasKey
```
public static boolean hHasKey(String key,
                              String item)
```
判断hash表中是否有该项的值

参数:

key - 键不能为null

item - 项不能为null

返回:

true 存在 false不存在

hincr
```
public static Long hincr(String key,
                         String item,
                         long by)
```
hash递增如果不存在,就会创建一个并把新增后的值返回

参数:

key - 键

item - 项

by - 要增加几(大于0)

返回:

when used in pipeline / transaction.

hdecr

public static Long hdecr(String key,
                         String item,
                         long by)

hash递减

参数:: key - 键; item - 项; by - 要减少记(小于0)
返回:: when used in pipeline / transaction.

sGet
```
public static Set<Object> sGet(String key)
```
根据key获取Set中的所有值

参数:

key - 键

返回:

Set中的所有值

sHasKey

public static boolean sHasKey(String key,
                              Object value)

根据value从一个set中查询,是否存在

参数:: key - 键; value - 值
返回:: true 存在 false不存在

sSet

public static long sSet(String key,
                        Object... values)

将数据放入set缓存

参数:: key - 键; values - 值可以是多个
返回:: 成功个数

sSetAndTime

public static long sSetAndTime(String key,
                               long time,
                               Object... values)

将set数据放入缓存

参数:: key - 键; time - 时间(秒); values - 值可以是多个
返回:: 成功个数

sGetSetSize
```
public static long sGetSetSize(String key)
```
获取set缓存的长度

参数:

key - 键

返回:

set缓存的长度

setRemove

public static long setRemove(String key,
                             Object... values)

移除值为value的

参数:: key - 键; values - 值可以是多个
返回:: 移除的个数

lGet

public static List<Object> lGet(String key,
                                long start,
                                long end)

获取list缓存的内容

参数:: key - 键; start - 开始; end - 结束 0 到 -1代表所有值
返回:: list缓存的内容

lGet
```
public static List<Object> lGet(String key)
```
获取所有list缓存的内容

参数:

key - key

返回:

list集合

lGetListSize
```
public static long lGetListSize(String key)
```
获取list缓存的长度

参数:

key - 键

返回:

list缓存的长度

lGetIndex
```
public static Object lGetIndex(String key,
                               long index)
```
通过索引获取list中的值

参数:

key - 键

index - 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推

返回:

要获取的值

lSet

public static boolean lSet(String key,
                           Object value)

将list放入缓存

参数:: key - 键; value - 值
返回:: true 成功

lSet

public static boolean lSet(String key,
                           Object value,
                           long time)

将list放入缓存

参数:: key - 键; value - 值; time - 时间(秒)
返回:: true 成功

lSet

public static boolean lSet(String key,
                           List<Object> value)

将list放入缓存

参数:: key - 键; value - 值
返回:: true 成功

lSet

public static boolean lSet(String key,
                           List<Object> value,
                           long time)

将list放入缓存

参数:: key - 键; value - 值; time - 时间(秒)
返回:: true 成功

lUpdateIndex

public static boolean lUpdateIndex(String key,
                                   long index,
                                   Object value)

根据索引修改list中的某条数据

参数:: key - 键; index - 索引; value - 值
返回:: true 修改成功

lRemove

public static long lRemove(String key,
                           long count,
                           Object value)

移除N个值为value

参数:: key - 键; count - 移除多少个; value - 值
返回:: 移除的个数

类 RedisUtils

构造器概要

方法概要

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

构造器详细资料

RedisUtils

方法详细资料

init

setDatabase

resetDatabase

expire

expire

getExpire

hasKey

del

del

scan

findKeysForPage

get

multiGet

set

set

set

incr

decr

hget

hmget

hmset

hmset

hset

hset

hdel

hHasKey

hincr

hdecr

sGet

sHasKey

sSet

sSetAndTime

sGetSetSize

setRemove

lGet

lGet

lGetListSize

lGetIndex

lSet

lSet

lSet

lSet

lUpdateIndex

lRemove