基于上一篇Redis工具类接口方法陈列说明
续写在上一篇博客中介绍了总结的比较全的redis工具类
添加链接描述
一下对工具类中的方法做了以下陈列
一、key相关操作
| 序号 | 方法 | Redis命令 | 描述 | 返回值备注 |
|---|---|---|---|---|
| 1 | Boolean exists(String key) | exists | 检查给定 key 是否存在 | 是否存在 |
| 2 | Boolean expire(String key, int seconds) | expire | 设置key过期时间 单位秒 | 是否成功 |
| 3 | Boolean expire(String key, int duration, TimeUnit timeUnit) | pexpire | 设置key过期时间 单位以枚举自定义 | 是否成功 |
| 4 | Long getExpiresTtl(String key) | ttl | 根据key 获取过期时间秒数 | 秒数 |
| 5 | Long getExpiresPttl(String key) | pttl | 根据key 获取过期时间毫秒数 | 毫秒数 |
| 6 | Boolean persist(String key) | persist | 移除 key 的过期时间，key 将持久保持 | 是否成功 |
| 7 | String getType(String key) | type | 根据key 获取存储类型 | 存储类型 |
| 8 | Long remove(String key) | del | 用于删除已存在的键。不存在的 key 会被忽略 | 被删除 key 的数量 |
补充
1)String getType(String key)
类型值有 none (key不存在)、string (字符串)、list (列表)、set (集合)、zset (有序集)、hash (哈希表)
二、String相关操作
| 序号 | 方法 | Redis命令 | 描述 | 返回值备注 |
|---|---|---|---|---|
| 1 | Boolean put(String key, Object value) | set | 添加数据，默认效期5分钟 | 是否成功 |
| 2 | Boolean put(String key, Object value, int duration, TimeUnit timeUnit) | set | 添加数据，自定义效期 | 是否成功 |
| 3 | Boolean putNeverExpires(String key, Object value) | set | 添加数据设置永不过期 | 是否成功 |
| 4 | T get(String key, Class clazz) | get | 根据key 获取值 | 相应对象 |
| 5 | String get(String key) | get | 根据key 获取String类型值 | String值 |
| 6 | List getList(String key, Class clazz) | get | 根据key 获取集合对象值 | 集合对象 |
| 7 | Boolean setNx(String key) | setNx | 将key 的值设为 value ,当且仅当 key 不存在，默认值是时间戳 默认有效期是 5 分钟 | 是否成功 |
| 8 | Boolean setNx(String key, Object value) | setNx | 将key 的值设为 value ,当且仅当 key 不存在,默认有效期5 分钟 | 是否成功 |
| 9 | Boolean setNx(String key, int seconds) | setNx | 将key 的值设为 value ,当且仅当 key 不存在，默认值是时间戳 | 是否成功 |
| 10 | Boolean setNx(String key, Object value, int seconds) | setNx | 将key 的值设为 value ,当且仅当 key 不存在，默认时间单位是秒 | 是否成功 |
| 11 | Boolean setNx(String key, Object value, int duration, TimeUnit timeUnit) | setNx | 将key 的值设为 value ,当且仅当 key 不存在 | 是否成功 |
| 12 | String getSet(String key, String value) | getSet | 设置指定 key 的值，并返回 key 的旧值，默认有效期为 5分钟 | 旧值 |
| 13 | String getSet(String key, String value, int duration, TimeUnit timeUnit) | getSet | 设置指定 key 的值，并返回 key 的旧值，自定义效期 | 旧值 |
| 14 | Long getStrLen(String key) | strlen | 获取指定 key 所储存的字符串值的长度 | 值的长度，当 key 不存在时，返回 0 |
| 15 | Long incr(String key) | incr | key 中储存的数字值增一 (默认增量+1) | 当前值 |
| 16 | Long incr(String key, long value) | incrBy | key 中储存的数字值增一 （自定义增量值 ） | 当前值 |
| 17 | Double incr(String key, Double value) | incrByFloat | key 中所储存的值加上指定的浮点数增量值 | 当前值 |
| 18 | Long decr(String key) | decr | key 中储存的数字值减一 | 当前值 |
| 19 | Long decr(String key, long value) | decrBy | key 中储存的数字值减自定义减量 | 当前值 |
| 20 | Long append(String key, Object value) | append | 用于为指定的 key 追加值 | 追加指定值之后， key 中字符串的长度 |
三、zset有序集合相关操作
| 序号 | 方法 | Redis命令 | 描述 | 返回值备注 |
|---|---|---|---|---|
| 1 | Long zAddByScore(String key, Object obj, double score) | zadd | 添加元素到有序集合,有序集合是按照元素的score进行排列 | 被成功添加的新成员的数量 |
| 2 | Long zCard(String key) | zcard | 根据key 计算集合中元素的数量 | 集合元素数量 |
| 3 | Long zCount(String key, double minScore, double maxScore) | zcount | 根据key 计算在有序集合中指定区间分数的成员数 | 集合元素数量 |
| 4 | List zRange(String key, Class clazz, int start, int end) | zrange | 返回有序集中，指定区间内的成员 -> 从小到大 | 有序集合 |
| 5 | List zRevRange(String key, Class clazz, int start, int end) | zrevrange | 返回有序集中，指定区间内的成员 -> 从大到小 | 有序集合 |
| 6 | List zRangeByScore(String key, Class clazz, double minScore, double maxScore) | zrangeByScore | 通过分数返回有序集合指定区间内的成员 -> 从小到大 | 有序集合 |
| 7 | List zRevRangeByScore(String key, Class clazz, double minScore, double maxScore) | zrevrangeByScore | 通过分数返回有序集合指定区间内的成员 -> 从大到小 | 有序集合 |
| 8 | Long zRank(String key, Object obj) | zrank | 返回有序集中指定成员的排名按分数值递增(从小到大)顺序排列 | |
| 9 | Long zRevRank(String key, Object obj) | zrevrank | 返回有序集中指定成员的排名分数值递减(从大到小)排序 | |
| 10 | Long zRem(String key, Object obj) | zrem | 移除有序集合中的个成员 | 被成功移除的成员的数量，不包括被忽略的成员 |
| 11 | Long zRemRangeByRank(String key, int start, int end) | zremrangeByRank | 移除有序集合中给定的排名区间的所有成员从排序小的开始删除 | 被移除成员的数量。 |
| 12 | Double zScore(String key, Object obj) | zscore | 返回有序集中，成员的分数值 |
三、list相关操作
| 序号 | 方法 | Redis命令 | 描述 | 返回值备注 |
|---|---|---|---|---|
| 1 | Long lpush(String key, Object… value) | lpush | 将一个或多个值插入到列表头部如果 key 不存在，一个空列表会被创建并执行 LPUSH 操作 | |
| 2 | Long lLen(String key) | llen | 用于返回列表的长度,如果列表 key 不存在返回0 | |
| 3 | T lindex(String key, int index, Class clazz) | lindex | 通过索引获取列表中的元素 | |
| 4 | T lpop(String key, Class clazz) | lpop | 移除并返回列表的第一个元素 | 列表的第一个元素。 当列表 key 不存在时，返回 null |
| 5 | T rpop(String key, Class clazz) | rpop | 移除并返回列表的最后一个元素 | 列表的最后一个元素。 当列表不存在时，返回 null |
四、Hash相关操作
| 序号 | 方法 | Redis命令 | 描述 | 返回值备注 |
|---|---|---|---|---|
| 1 | Boolean setHash(String key, String field, Object value) | hset | 用于为哈希表中的字段赋值，如果哈希表不存在，一个新的哈希表被创建并进行 HSET 操作 | 是否保存成功 |
| 2 | Boolean setNxHash(String key, String field, Object value) | hsetnx | 用于为哈希表中不存在的的字段赋值，如果哈希表不存在，一个新的哈希表被创建并进行 HSET 操作 | 是否保存成功 |
| 3 | T getHash(String key, String field, Class clazz) | hget | 获取存储在哈希表中指定字段的值 | 返回给定字段的值。如果给定的字段或 key 不存在时，返回 null |
| 4 | Long delHash(String key, String field) | hdel | 用于删除哈希表 key 中的个指定字段 | 被成功删除字段的数量，不包括被忽略的字段 |
| 5 | Boolean hashKeyExists(String key, String field) | hexists | 用于查看哈希表的指定字段是否存在 | 是否存在 |
| 6 | Map<String, T> getAllHash(String key, Class clazz) | hgetAll | 获取在哈希表中指定 key 的所有字段和值 |
