cn.fscode.commons.redis.utils

类 RedisUtils.HashOps

java.lang.Object

cn.fscode.commons.redis.utils.RedisUtils.HashOps

封闭类:

RedisUtils

public static class RedisUtils.HashOps
extends Object

hash相关操作 提示: 简单的，可以将redis中hash的数据结构看作是 Map> 提示: redis中String的数据结构可参考resources/data-structure/Hash(散列)的数据结构(示例一).png redis中String的数据结构可参考resources/data-structure/Hash(散列)的数据结构(示例二).png

作者:

shenguangyang

构造器概要

构造器

构造器和说明
HashOps()

方法概要

限定符和类型	方法和说明
static long	hDelete(String key, Object... entryKeys) (批量)删除(key对应的)hash中的对应entryKey-entryValue 注: 1、若redis中不存在对应的key, 则返回0; 2、若要删除的entryKey，在key对应的hash中不存在，在count不会+1, 如: RedisUtil.HashOps.hPut("ds", "name", "邓沙利文"); RedisUtil.HashOps.hPut("ds", "birthday", "1994-02-05"); RedisUtil.HashOps.hPut("ds", "hobby", "女"); 则调用RedisUtil.HashOps.hDelete("ds", "name", "birthday", "hobby", "non-exist-entryKey") 的返回结果为3 注: 若(key对应的)hash中的所有entry都被删除了，那么该key也会被删除
static boolean	hExists(String key, String entryKey) 查看(key对应的)hash中，是否存在entryKey对应的entry 注: 若redis中不存在key,则返回false。
static Object	hGet(String key, Object entryKey) 获取到key对应的hash里面的对应字段的值 注: 若redis中不存在对应的key, 则返回null。
static Map<String,Object>	hGetAll(String key) 获取到key对应的hash(即: 获取到key对应的Map) 注: 若redis中不存在对应的key, 则返回一个没有任何entry的空的Map(，而不是返回null)。
static long	hIncrBy(String key, Object entryKey, long increment) 增/减(hash中的某个entryValue值) 整数 注: 负数则为减。
static double	hIncrByFloat(String key, Object entryKey, double increment) 增/减(hash中的某个entryValue值) 浮点数 注: 负数则为减。
static Set<Object>	hKeys(String key) 获取(key对应的)hash中的所有entryKey 注: 若key不存在，则返回的是一个空的Set(，而不是返回null)
static List<Object>	hMultiGet(String key, Collection<Object> entryKeys) 批量获取(key对应的)hash中的entryKey的entryValue 注: 若hash中对应的entryKey不存在，那么返回的对应的entryValue值为null 注: redis中key不存在，那么返回的List中，每个元素都为null。
static void	hPut(String key, String entryKey, Object entryValue) 向key对应的hash中，增加一个键值对entryKey-entryValue 注: 同一个hash里面，若已存在相同的entryKey， 那么此操作将丢弃原来的entryKey-entryValue， 而使用新的entryKey-entryValue。
static void	hPutAll(String key, Map<Object,Object> maps) 向key对应的hash中，增加maps(即: 批量增加entry集) 注: 同一个hash里面，若已存在相同的entryKey， 那么此操作将丢弃原来的entryKey-entryValue， 而使用新的entryKey-entryValue
static boolean	hPutIfAbsent(String key, Object entryKey, Object entryValue) 当key对应的hash中,不存在entryKey时，才(向key对应的hash中，)增加entryKey-entryValue 否者，不进行任何操作
static org.springframework.data.redis.core.Cursor<Map.Entry<Object,Object>>	hScan(String key, org.springframework.data.redis.core.ScanOptions options) 根据options匹配到(key对应的)hash中的对应的entryKey, 并返回对应的entry集 注: ScanOptions实例的创建方式举例: 1、ScanOptions.NONE 2、ScanOptions.scanOptions().match("n??
static long	hSize(String key) 获取(key对应的)hash中的所有entry的数量 注: 若redis中不存在对应的key, 则返回值为0
static List<Object>	hValues(String key) 获取(key对应的)hash中的所有entryValue 注: 若key不存在，则返回的是一个空的List(，而不是返回null)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

HashOps

public HashOps()

方法详细资料

hPut

public static void hPut(String key,
                        String entryKey,
                        Object entryValue)

向key对应的hash中，增加一个键值对entryKey-entryValue 注: 同一个hash里面，若已存在相同的entryKey， 那么此操作将丢弃原来的entryKey-entryValue， 而使用新的entryKey-entryValue。

参数:

key - 定位hash的key

entryKey - 要向hash中增加的键值对里的 键

entryValue - 要向hash中增加的键值对里的 值

hPutAll

public static void hPutAll(String key,
                           Map<Object,Object> maps)

向key对应的hash中，增加maps(即: 批量增加entry集) 注: 同一个hash里面，若已存在相同的entryKey， 那么此操作将丢弃原来的entryKey-entryValue， 而使用新的entryKey-entryValue

参数:

key - 定位hash的key

maps - 要向hash中增加的键值对集

hPutIfAbsent

public static boolean hPutIfAbsent(String key,
                                   Object entryKey,
                                   Object entryValue)

当key对应的hash中,不存在entryKey时，才(向key对应的hash中，)增加entryKey-entryValue 否者，不进行任何操作

参数:

key - 定位hash的key

entryKey - 要向hash中增加的键值对里的 键

entryValue - 要向hash中增加的键值对里的 值

返回:

操作是否成功。

hGet

public static Object hGet(String key,
                          Object entryKey)

获取到key对应的hash里面的对应字段的值 注: 若redis中不存在对应的key, 则返回null。 若key对应的hash中不存在对应的entryKey, 也会返回null。

参数:

key - 定位hash的key

entryKey - 定位hash里面的entryValue的entryKey

返回:

key对应的hash里的entryKey对应的entryValue值

hGetAll

public static Map<String,Object> hGetAll(String key)

获取到key对应的hash(即: 获取到key对应的Map) 注: 若redis中不存在对应的key, 则返回一个没有任何entry的空的Map(，而不是返回null)。

参数:

key - 定位hash的key

返回:

key对应的hash。

hMultiGet

public static List<Object> hMultiGet(String key,
                                     Collection<Object> entryKeys)

批量获取(key对应的)hash中的entryKey的entryValue 注: 若hash中对应的entryKey不存在，那么返回的对应的entryValue值为null 注: redis中key不存在，那么返回的List中，每个元素都为null。 追注: 这个List本身不为null, size也不为0， 只是每个list中的每个元素为null而已。

参数:

key - 定位hash的key

entryKeys - 需要获取的hash中的字段集

返回:

hash中对应entryKeys的对应entryValue集

hDelete

public static long hDelete(String key,
                           Object... entryKeys)

(批量)删除(key对应的)hash中的对应entryKey-entryValue 注: 1、若redis中不存在对应的key, 则返回0; 2、若要删除的entryKey，在key对应的hash中不存在，在count不会+1, 如: RedisUtil.HashOps.hPut("ds", "name", "邓沙利文"); RedisUtil.HashOps.hPut("ds", "birthday", "1994-02-05"); RedisUtil.HashOps.hPut("ds", "hobby", "女"); 则调用RedisUtil.HashOps.hDelete("ds", "name", "birthday", "hobby", "non-exist-entryKey") 的返回结果为3 注: 若(key对应的)hash中的所有entry都被删除了，那么该key也会被删除

参数:

key - 定位hash的key

entryKeys - 定位要删除的entryKey-entryValue的entryKey

返回:

删除了对应hash中多少个entry

hExists

public static boolean hExists(String key,
                              String entryKey)

查看(key对应的)hash中，是否存在entryKey对应的entry 注: 若redis中不存在key,则返回false。 注: 若key对应的hash中不存在对应的entryKey, 也会返回false。

参数:

key - 定位hash的key

entryKey - 定位hash中entry的entryKey

返回:

hash中是否存在entryKey对应的entry.

hIncrBy

public static long hIncrBy(String key,
                           Object entryKey,
                           long increment)

增/减(hash中的某个entryValue值) 整数 注: 负数则为减。 注: 若key不存在，那么会自动创建对应的hash,并创建对应的entryKey、entryValue,entryValue的初始值为increment。 注: 若entryKey不存在，那么会自动创建对应的entryValue,entryValue的初始值为increment。 注: 若key对应的value值不支持增/减操作(即: value不是数字)， 那么会 抛出org.springframework.data.redis.RedisSystemException

参数:

key - 用于定位hash的key

entryKey - 用于定位entryValue的entryKey

increment - 增加多少

返回:

增加后的总值。

抛出:

org.springframework.data.redis.RedisSystemException - key对应的value值不支持增/减操作时

hIncrByFloat

public static double hIncrByFloat(String key,
                                  Object entryKey,
                                  double increment)

增/减(hash中的某个entryValue值) 浮点数 注: 负数则为减。 注: 若key不存在，那么会自动创建对应的hash,并创建对应的entryKey、entryValue,entryValue的初始值为increment。 注: 若entryKey不存在，那么会自动创建对应的entryValue,entryValue的初始值为increment。 注: 若key对应的value值不支持增/减操作(即: value不是数字)， 那么会 抛出org.springframework.data.redis.RedisSystemException 注: 因为是浮点数， 所以可能会和RedisUtils.StringOps.incrByFloat(String, double)一样， 出现精度问题。 追注: 本人简单测试了几组数据，暂未出现精度问题。

参数:

key - 用于定位hash的key

entryKey - 用于定位entryValue的entryKey

increment - 增加多少

返回:

增加后的总值。

抛出:

org.springframework.data.redis.RedisSystemException - key对应的value值不支持增/减操作时

hKeys

public static Set<Object> hKeys(String key)

获取(key对应的)hash中的所有entryKey 注: 若key不存在，则返回的是一个空的Set(，而不是返回null)

参数:

key - 定位hash的key

返回:

hash中的所有entryKey

hValues

public static List<Object> hValues(String key)

获取(key对应的)hash中的所有entryValue 注: 若key不存在，则返回的是一个空的List(，而不是返回null)

参数:

key - 定位hash的key

返回:

hash中的所有entryValue

hSize

public static long hSize(String key)

获取(key对应的)hash中的所有entry的数量 注: 若redis中不存在对应的key, 则返回值为0

参数:

key - 定位hash的key

返回:

(key对应的)hash中,entry的个数

hScan

public static org.springframework.data.redis.core.Cursor<Map.Entry<Object,Object>> hScan(String key,
                                                                                         org.springframework.data.redis.core.ScanOptions options)

根据options匹配到(key对应的)hash中的对应的entryKey, 并返回对应的entry集 注: ScanOptions实例的创建方式举例: 1、ScanOptions.NONE 2、ScanOptions.scanOptions().match("n??e").build()

参数:

key - 定位hash的key

options - 匹配entryKey的条件 注: ScanOptions.NONE表示全部匹配。 注: ScanOptions.scanOptions().match(pattern).build()表示按照pattern匹配, 其中pattern中可以使用通配符 * ? 等, * 表示>=0个字符 ？ 表示有且只有一个字符 此处的匹配规则与RedisUtils.KeyOps.keys(String)处的一样。

返回:

匹配到的(key对应的)hash中的entry