wang.bigbird.domain.framework.data.redis.service

接口 RedisHashService

所有已知实现类:

RedisHashServiceImpl

public interface RedisHashService

redis hash 服务

作者:

Bigbird

方法概要

限定符和类型	方法和说明
int	hdel(String key, String... fields) HDEL 删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。
boolean	hexists(String key, String field) HEXISTS 检查给定域 field 是否存在于哈希表 hash 当中。
<T> T	hget(String key, String field, Class<T> clazz) HGET 返回哈希表中给定域的值。
<T> Map<String,T>	hgetall(String key, Class<T> clazz) HGETALL 用于返回哈希表中，所有的字段和值。
Number	hincrby(String key, String field, Number delta) HINCRBY 为哈希表 key 中的域 field 的值加上增量 increment 。
Set<String>	hkeys(String key) HKEYS 返回哈希表 key 中的所有域。
int	hlen(String key) HLEN 返回哈希表 key 中域的数量。
<T> Map<String,T>	hmget(String key, Collection<String> fields, Class<T> clazz) HMGET 用于返回哈希表中，一个或多个给定字段的值。
void	hmset(String key, Map<String,Object> fieldValueMap) HMSET 同时将多个 field-value (域-值)对设置到哈希表 key 中。
int	hset(String key, String field, Object value) HSET 将哈希表 hash 中域 field 的值设置为 value 。
boolean	hsetnx(String key, String field, Object value) HSETNX 当且仅当域 field 尚未存在于哈希表的情况下，将它的值设置为 value 。

方法详细资料

hset

int hset(String key,
         String field,
         Object value)

HSET

将哈希表 hash 中域 field 的值设置为 value 。 如果给定的哈希表并不存在， 那么一个新的哈希表将被创建并执行 HSET 操作。 如果域 field 已经存在于哈希表中， 那么它的旧值将被新值 value 覆盖。

参数:

key - 键

field - 域

value - 值

返回:

当在哈希表中新创建 field 域并成功为它设置值时，命令返回 1 ；如果域 field 已经存在于哈希表，并且 HSET 命令成功使用新值覆盖了它的旧值，那么命令返回 0 。

hsetnx

boolean hsetnx(String key,
               String field,
               Object value)

HSETNX

当且仅当域 field 尚未存在于哈希表的情况下，将它的值设置为 value 。 如果给定域已经存在于哈希表当中，那么命令将放弃执行设置操作。 如果哈希表hash不存在，那么一个新的哈希表将被创建并执行 HSETNX 命令。

参数:

key - 键

field - 域

value - 值

返回:

在设置成功时返回 true，在给定域已经存在而放弃执行设置操作时返回 false。

hget

<T> T hget(String key,
           String field,
           Class<T> clazz)

HGET

返回哈希表中给定域的值。

参数:

key - 键

field - 域

clazz - 值类型

返回:

返回给定域的值

hexists

boolean hexists(String key,
                String field)

HEXISTS

检查给定域 field 是否存在于哈希表 hash 当中。

参数:

key - 键

field - 域

返回:

给定域存在时返回 true, 在给定域不存在时返回 false。

hdel

int hdel(String key,
         String... fields)

HDEL

删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。

参数:

key - 键

fields - 域

返回:

被成功移除的域的数量，不包括被忽略的域。

hlen

int hlen(String key)

HLEN

返回哈希表 key 中域的数量。

参数:

key - 键

返回:

哈希表中域的数量。

hincrby

Number hincrby(String key,
               String field,
               Number delta)

HINCRBY

为哈希表 key 中的域 field 的值加上增量 increment 。 增量也可以为负数，相当于对给定域进行减法操作。 如果 key 不存在，一个新的哈希表被创建并执行 HINCRBY 命令。 如果域 field 不存在，那么在执行命令前，域的值被初始化为 0 。 对一个储存字符串值的域 field 执行 HINCRBY 命令将造成一个错误。 本操作的值被限制在 64 位(bit)有符号数字表示之内。

参数:

key - 键

field - 域

delta - 偏移量

返回:

执行加法操作之后 field 域的值。

hmset

void hmset(String key,
           Map<String,Object> fieldValueMap)

HMSET

同时将多个 field-value (域-值)对设置到哈希表 key 中。 此命令会覆盖哈希表中已存在的域。 如果 key 不存在，一个空哈希表被创建并执行 HMSET 操作。

参数:

key - 键

fieldValueMap - 域、值 Map

hmget

<T> Map<String,T> hmget(String key,
                        Collection<String> fields,
                        Class<T> clazz)

HMGET

用于返回哈希表中，一个或多个给定字段的值。 如果指定的字段不存在于哈希表，那么返回一个 null 值。

参数:

key - 键

fields - 域列表

clazz - 值类型

返回:

一个或多个给定字段的值，不存在则返回 null

hgetall

<T> Map<String,T> hgetall(String key,
                          Class<T> clazz)

HGETALL

用于返回哈希表中，所有的字段和值。

参数:

key - 键

clazz - 值类型

返回:

所有的字段和值，不存在则返回 null

hkeys

Set<String> hkeys(String key)

HKEYS

返回哈希表 key 中的所有域。

参数:

key - 键

返回:

一个包含哈希表中所有域的表。当 key 不存在时，返回一个空表。