RedisUtil (xj-fw-redis 2.0.1 API)

java.lang.Object
- io.github.wslxm.springbootplus2.starter.redis.util.RedisUtil

@Component
public class RedisUtil
extends Object

构造器概要

构造器
构造器和说明

RedisUtil()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`delete(String... key)` 删除缓存
`boolean`	`expire(String key, long time)` 指定缓存失效时间
`Object`	`get(String key)` 普通缓存获取
`long`	`getExpire(String key)` 根据key 获取过期时间
`String`	`getNo(String key, Long delta)` 获取唯一编号（20位），目前只适用于个 redis, 不适用于 redis 集群分布式架构获取唯一编号（基于redis）--> 订单号，交易号，退款号等等，如果redis 集群,需设置自增歩长,请使用命令设置或所有其他方法规避
`boolean`	`hasKey(String key)` 判断key是否存在
`void`	`hDelete(String key, Object... item)` 删除hash表中的值
`Map<Object,Object>`	`hEntries(String key)` 获取hashKey对应的所有键值
`Object`	`hGet(String key, String item)` HashGet
`boolean`	`hHasKey(String key, String item)` 判断hash表中是否有该项的值
`double`	`hIncrement(String key, String item, double by)` hash递增如果不存在,就会创建一个并把新增后的值返回
`boolean`	`hPut(String key, String item, Object value)` 向一张hash表中放入数据,如果不存在将创建
`boolean`	`hPut(String key, String item, Object value, long time)` 向一张hash表中放入数据,如果不存在将创建
`boolean`	`hPutAll(String key, Map<String,Object> map)` HashSet
`boolean`	`hPutAll(String key, Map<String,Object> map, long time)` HashSet 并设置时间
`long`	`increment(String key, long delta)` 递增或递减
`static Boolean`	`isRedis()` 判断是否启用redis
`Object`	`lIndex(String key, long index)` 通过索引获取list中的值
`List<Object>`	`lRange(String key, long start, long end)` 获取list缓存的内容
`long`	`lRemove(String key, long count, Object value)` 移除N个值为value
`boolean`	`lRightPush(String key, Object value)` 将list放入缓存
`boolean`	`lRightPush(String key, Object value, long time)` 将list放入缓存
`boolean`	`lRightPushAll(String key, List<Object> value)` 将list放入缓存
`boolean`	`lRightPushAll(String key, List<Object> value, long time)` 将list放入缓存
`boolean`	`lSet(String key, long index, Object value)` 根据索引修改list中的某条数据
`long`	`lSize(String key)` 获取list缓存的长度
`long`	`sAdd(String key, long time, Object... values)` 将set数据放入缓存
`long`	`sAdd(String key, Object... values)` 将数据放入set缓存
`boolean`	`set(String key, Object value)` 普通缓存放入
`boolean`	`set(String key, Object value, long time)` 普通缓存放入并设置时间
`boolean`	`sIsMember(String key, Object value)` 根据value从一个set中查询,是否存在
`Set<Object>`	`sMembers(String key)` 根据key获取Set中的所有值
`long`	`sRemove(String key, Object... values)` 移除值为value的
`long`	`sSize(String key)` 获取set缓存的长度

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

- 构造器详细资料
  - RedisUtil
```
public RedisUtil()
```
- 方法详细资料
  - isRedis
```
public static Boolean isRedis()
```
    判断是否启用redis
    
    返回:
  - expire
```
public boolean expire(String key,
                      long time)
```
    指定缓存失效时间
    
    参数:
    
    key - 键
    
    time - 时间(秒)
    
    返回:
  - getExpire
```
public long getExpire(String key)
```
    根据key 获取过期时间
    
    参数:
    
    key - 键不能为null
    
    返回:
    
    时间(秒) 返回0代表为永久有效
  - hasKey
```
public boolean hasKey(String key)
```
    判断key是否存在
    
    参数:
    
    key - 键
    
    返回:
    
    true 存在 false不存在
  - delete
```
public void delete(String... key)
```
    删除缓存
    
    参数:
    
    key - 可以传一个值或多个
  - get
```
public Object get(String key)
```
    普通缓存获取
    
    参数:
    
    key - 键
    
    返回:
    
    值
  - set
```
public boolean set(String key,
                   Object value)
```
    普通缓存放入
    
    参数:
    
    key - 键
    
    value - 值
    
    返回:
    
    true成功 false失败
  - set
```
public boolean set(String key,
                   Object value,
                   long time)
```
    普通缓存放入并设置时间
    
    参数:
    
    key - 键
    
    value - 值
    
    time - 时间(秒) time要大于0 如果time小于等于0 将设置无限期
    
    返回:
    
    true成功 false 失败
  - increment
```
public long increment(String key,
                      long delta)
```
    递增或递减
    
    参数:
    
    key - 键
    
    delta - 要增加或减少几(+正数 -负数)
    
    返回:
  - hGet
```
public Object hGet(String key,
                   String item)
```
    HashGet
    
    参数:
    
    key - 键不能为null
    
    item - 项不能为null
    
    返回:
    
    值
  - hEntries
```
public Map<Object,Object> hEntries(String key)
```
    获取hashKey对应的所有键值
    
    参数:
    
    key - 键
    
    返回:
    
    对应的多个键值
  - hPutAll
```
public boolean hPutAll(String key,
                       Map<String,Object> map)
```
    HashSet
    
    参数:
    
    key - 键
    
    map - 对应多个键值
    
    返回:
    
    true 成功 false 失败
  - hPutAll
```
public boolean hPutAll(String key,
                       Map<String,Object> map,
                       long time)
```
    HashSet 并设置时间
    
    参数:
    
    key - 键
    
    map - 对应多个键值
    
    time - 时间(秒)
    
    返回:
    
    true成功 false失败
  - hPut
```
public boolean hPut(String key,
                    String item,
                    Object value)
```
    向一张hash表中放入数据,如果不存在将创建
    
    参数:
    
    key - 键
    
    item - 项
    
    value - 值
    
    返回:
    
    true 成功 false失败
  - hPut
```
public boolean hPut(String key,
                    String item,
                    Object value,
                    long time)
```
    向一张hash表中放入数据,如果不存在将创建
    
    参数:
    
    key - 键
    
    item - 项
    
    value - 值
    
    time - 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
    
    返回:
    
    true 成功 false失败
  - hDelete
```
public void hDelete(String key,
                    Object... item)
```
    删除hash表中的值
    
    参数:
    
    key - 键不能为null
    
    item - 项可以使多个不能为null
  - hHasKey
```
public boolean hHasKey(String key,
                       String item)
```
    判断hash表中是否有该项的值
    
    参数:
    
    key - 键不能为null
    
    item - 项不能为null
    
    返回:
    
    true 存在 false不存在
  - hIncrement
```
public double hIncrement(String key,
                         String item,
                         double by)
```
    hash递增如果不存在,就会创建一个并把新增后的值返回
    
    参数:
    
    key - 键
    
    item - 项
    
    by - 要增加或减少几(+ 正数 -负数)
    
    返回:
  - sMembers
```
public Set<Object> sMembers(String key)
```
    根据key获取Set中的所有值
    
    参数:
    
    key - 键
    
    返回:
  - sIsMember
```
public boolean sIsMember(String key,
                         Object value)
```
    根据value从一个set中查询,是否存在
    
    参数:
    
    key - 键
    
    value - 值
    
    返回:
    
    true 存在 false不存在
  - sAdd
```
public long sAdd(String key,
                 Object... values)
```
    将数据放入set缓存
    
    参数:
    
    key - 键
    
    values - 值可以是多个
    
    返回:
    
    成功个数
  - sAdd
```
public long sAdd(String key,
                 long time,
                 Object... values)
```
    将set数据放入缓存
    
    参数:
    
    key - 键
    
    time - 时间(秒)
    
    values - 值可以是多个
    
    返回:
    
    成功个数
  - sSize
```
public long sSize(String key)
```
    获取set缓存的长度
    
    参数:
    
    key - 键
    
    返回:
  - sRemove
```
public long sRemove(String key,
                    Object... values)
```
    移除值为value的
    
    参数:
    
    key - 键
    
    values - 值可以是多个
    
    返回:
    
    移除的个数
  - lRange
```
public List<Object> lRange(String key,
                           long start,
                           long end)
```
    获取list缓存的内容
    
    参数:
    
    key - 键
    
    start - 开始
    
    end - 结束 0 到 -1代表所有值
    
    返回:
  - lSize
```
public long lSize(String key)
```
    获取list缓存的长度
    
    参数:
    
    key - 键
    
    返回:
  - lIndex
```
public Object lIndex(String key,
                     long index)
```
    通过索引获取list中的值
    
    参数:
    
    key - 键
    
    index - 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
    
    返回:
  - lRightPush
```
public boolean lRightPush(String key,
                          Object value)
```
    将list放入缓存
    
    参数:
    
    key - 键
    
    value - 值
    
    time - 时间(秒)
    
    返回:
  - lRightPush
```
public boolean lRightPush(String key,
                          Object value,
                          long time)
```
    将list放入缓存
    
    参数:
    
    key - 键
    
    value - 值
    
    time - 时间(秒)
    
    返回:
  - lRightPushAll
```
public boolean lRightPushAll(String key,
                             List<Object> value)
```
    将list放入缓存
    
    参数:
    
    key - 键
    
    value - 值
    
    time - 时间(秒)
    
    返回:
  - lRightPushAll
```
public boolean lRightPushAll(String key,
                             List<Object> value,
                             long time)
```
    将list放入缓存
    
    参数:
    
    key - 键
    
    value - 值
    
    time - 时间(秒)
    
    返回:
  - lSet
```
public boolean lSet(String key,
                    long index,
                    Object value)
```
    根据索引修改list中的某条数据
    
    参数:
    
    key - 键
    
    index - 索引
    
    value - 值
    
    返回:
  - lRemove
```
public long lRemove(String key,
                    long count,
                    Object value)
```
    移除N个值为value
    
    参数:
    
    key - 键
    
    count - 移除多少个
    
    value - 值
    
    返回:
    
    移除的个数
  - getNo
```
public String getNo(String key,
                    Long delta)
```
    获取唯一编号（20位），目前只适用于个 redis, 不适用于 redis 集群
    分布式架构获取唯一编号（基于redis）--> 订单号，交易号，退款号等等，如果redis 集群,需设置自增歩长,请使用命令设置或所有其他方法规避
    
    参数:
    
    key - key前缀-- 实际key等于前缀+每秒时间戳(同一秒delta 自增，下一秒根据时间戳生成新的key,delta重新计算)
    
    delta - 默认初始自增值 *** 2019-10-20 12:00:01 000001 --> 20191020120001000001,20191020120001000002,20191020120001000003...... *** 2019-10-20 12:00:02 000001 --> 20191020120002000001,20191020120002000002,20191020120002000003......
    
    返回:
    
    java.lang.String

类 RedisUtil

构造器概要

方法概要

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

构造器详细资料

RedisUtil

方法详细资料

isRedis

expire

getExpire

hasKey

delete

get

set

set

increment

hGet

hEntries

hPutAll

hPutAll

hPut

hPut

hDelete

hHasKey

hIncrement

sMembers

sIsMember

sAdd

sAdd

sSize

sRemove

lRange

lSize

lIndex

lRightPush

lRightPush

lRightPushAll

lRightPushAll

lSet

lRemove

getNo