HashHandler (redis-spring-boot-starter-码云(gitee.com))

java.lang.Object
- wiki.xsx.core.handler.HashHandler

All Implemented Interfaces:: RedisHandler

public final class HashHandler
extends Object
implements RedisHandler

哈希助手

Since:: 1.8
Author:: xsx

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Long`	`decrement(String key, String hashKey)` Deprecated.
`Double`	`decrement(String key, String hashKey, Double data)` Deprecated.
`Long`	`decrement(String key, String hashKey, Long data)` Deprecated.
`Map<String,String>`	`entries(String key)` 获取字符串集合
`Map<String,Object>`	`entriesAsObj(String key)` 获取对象集合
`String`	`get(String key, String hashKey)` 获取字符串
`<T> T`	`getAsObj(Class<T> type, String key, String hashKey)` 获取对象
`<T> T`	`getAsObj(String key, String hashKey)` 获取对象
`org.springframework.data.redis.core.RedisTemplate<String,Object>`	`getRedisTemplate()` 获取spring redis模板
`org.springframework.data.redis.core.StringRedisTemplate`	`getStringRedisTemplate()` 获取spring string redis模板
`Boolean`	`hasKey(String key, String hashKey)` 是否包含字符串的key
`Boolean`	`hasKeyAsObj(String key, String hashKey)` 是否包含对象的key
`Long`	`increment(String key, String hashKey)` Deprecated.
`Double`	`increment(String key, String hashKey, Double data)` Deprecated.
`Long`	`increment(String key, String hashKey, Long data)` Deprecated.
`Set<String>`	`keys(String key)` 获取字符串hash键集合
`Set`	`keysAsObj(String key)` 获取对象hash键集合
`Long`	`lengthOfValue(String key, String hashKey)` 获取字符串长度
`List<String>`	`mget(String key, String... hashKeys)` 批量获取字符串
`List`	`mgetAsObj(String key, String... hashKeys)` 批量获取对象
`void`	`put(String key, String hashKey, String value)` 存入字符串
`void`	`putAll(String key, Map<String,String> map)` 存入字符串集合
`void`	`putAllAsObj(String key, Map<String,Object> map)` 存入对象集合
`void`	`putAsObj(String key, String hashKey, Object value)` 存入对象
`Boolean`	`putIfAbsent(String key, String hashKey, String value)` 存入字符串如果不存在
`Boolean`	`putIfAbsentAsObj(String key, String hashKey, Object value)` 存入对象如果不存在
`Long`	`remove(String key, String... hashKeys)` 移除字符串
`Long`	`removeAsObj(String key, String... hashKeys)` 移除对象
`org.springframework.data.redis.core.Cursor<Map.Entry<String,String>>`	`scan(String key, Long count, String pattern)` 匹配字符串
`org.springframework.data.redis.core.Cursor<Map.Entry<String,Object>>`	`scanAsObj(String key, Long count, String pattern)` 匹配对象
`Long`	`size(String key)` 获取字符串数量
`Long`	`sizeAsObj(String key)` 获取对象数量
`List<String>`	`values(String key)` 获取字符串集合
`List`	`valuesAsObj(String key)` 获取对象集合

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - putAsObj
```
public void putAsObj(String key,
                     String hashKey,
                     Object value)
```
    存入对象
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    value - 对象
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HSET
  - put
```
public void put(String key,
                String hashKey,
                String value)
```
    存入字符串
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    value - 字符串
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HSET
  - putIfAbsentAsObj
```
public Boolean putIfAbsentAsObj(String key,
                                String hashKey,
                                Object value)
```
    存入对象如果不存在
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    value - 对象
    
    Returns:
    
    返回布尔值,成功true,失败false
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HSETNX
  - putIfAbsent
```
public Boolean putIfAbsent(String key,
                           String hashKey,
                           String value)
```
    存入字符串如果不存在
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    value - 字符串
    
    Returns:
    
    返回布尔值,成功true,失败false
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HSETNX
  - putAllAsObj
```
public void putAllAsObj(String key,
                        Map<String,Object> map)
```
    存入对象集合
    
    Parameters:
    
    key - 键
    
    map - 对象集合
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HMSET
  - putAll
```
public void putAll(String key,
                   Map<String,String> map)
```
    存入字符串集合
    
    Parameters:
    
    key - 键
    
    map - 字符串集合
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HMSET
  - getAsObj
```
public <T> T getAsObj(String key,
                      String hashKey)
```
    获取对象
    
    Type Parameters:
    
    T - 返回类型
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回对象
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HGET
  - getAsObj
```
public <T> T getAsObj(Class<T> type,
                      String key,
                      String hashKey)
```
    获取对象
    
    Type Parameters:
    
    T - 返回类型
    
    Parameters:
    
    type - 返回值类型
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回对象
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HGET
  - get
```
public String get(String key,
                  String hashKey)
```
    获取字符串
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回字符串
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HGET
  - mgetAsObj
```
public List mgetAsObj(String key,
                      String... hashKeys)
```
    批量获取对象
    
    Parameters:
    
    key - 键
    
    hashKeys - hash键
    
    Returns:
    
    返回对象列表
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HMGET
  - mget
```
public List<String> mget(String key,
                         String... hashKeys)
```
    批量获取字符串
    
    Parameters:
    
    key - 键
    
    hashKeys - hash键
    
    Returns:
    
    返回字符串列表
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HMGET
  - removeAsObj
```
public Long removeAsObj(String key,
                        String... hashKeys)
```
    移除对象
    
    Parameters:
    
    key - 键
    
    hashKeys - hash键
    
    Returns:
    
    返回移除数量
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HDEL
  - remove
```
public Long remove(String key,
                   String... hashKeys)
```
    移除字符串
    
    Parameters:
    
    key - 键
    
    hashKeys - hash键
    
    Returns:
    
    返回移除数量
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HDEL
  - entriesAsObj
```
public Map<String,Object> entriesAsObj(String key)
```
    获取对象集合
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回对象字典
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HGETALL
  - entries
```
public Map<String,String> entries(String key)
```
    获取字符串集合
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回字符串字典
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HGETALL
  - keysAsObj
```
public Set keysAsObj(String key)
```
    获取对象hash键集合
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回对象字典键集合
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HKEYS
  - keys
```
public Set<String> keys(String key)
```
    获取字符串hash键集合
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回字符串字典键集合
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HKEYS
  - valuesAsObj
```
public List valuesAsObj(String key)
```
    获取对象集合
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回对象列表
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HVALS
  - values
```
public List<String> values(String key)
```
    获取字符串集合
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回字符串列表
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HVALS
  - lengthOfValue
```
public Long lengthOfValue(String key,
                          String hashKey)
```
    获取字符串长度
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回字符串长度
    
    Since:
    
    redis 3.2.0
    
    See Also:
    
    Redis Documentation: HSTRLEN
  - sizeAsObj
```
public Long sizeAsObj(String key)
```
    获取对象数量
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回对象数量
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HLEN
  - size
```
public Long size(String key)
```
    获取字符串数量
    
    Parameters:
    
    key - 键
    
    Returns:
    
    返回字符串数量
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HLEN
  - hasKeyAsObj
```
public Boolean hasKeyAsObj(String key,
                           String hashKey)
```
    是否包含对象的key
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回布尔值,存在true,不存在false
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HEXISTS
  - hasKey
```
public Boolean hasKey(String key,
                      String hashKey)
```
    是否包含字符串的key
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回布尔值,存在true,不存在false
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HEXISTS
  - increment
```
@Deprecated
public Double increment(String key,
                                    String hashKey,
                                    Double data)
```
    Deprecated.
    
    自增已过期，请使用 NumberHandler.addDouble(String, String, double) 替换
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    data - 步长
    
    Returns:
    
    返回自增后的值
    
    Since:
    
    redis 2.6.0
    
    See Also:
    
    Redis Documentation: HINCRBYFLOAT
  - increment
```
@Deprecated
public Long increment(String key,
                                  String hashKey,
                                  Long data)
```
    Deprecated.
    
    自增已过期，请使用 NumberHandler.addLong(String, String, long) 替换
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    data - 步长
    
    Returns:
    
    返回自增后的值
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HINCRBY
  - increment
```
@Deprecated
public Long increment(String key,
                                  String hashKey)
```
    Deprecated.
    
    自增已过期，请使用 NumberHandler.incrementLong(String, String) 替换
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回自增后的值
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HINCRBY
  - decrement
```
@Deprecated
public Double decrement(String key,
                                    String hashKey,
                                    Double data)
```
    Deprecated.
    
    递减已过期，请使用 NumberHandler.subtractDouble(String, String, double) 替换
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    data - 步长
    
    Returns:
    
    返回递减后的值
    
    Since:
    
    redis 2.6.0
    
    See Also:
    
    Redis Documentation: HINCRBYFLOAT
  - decrement
```
@Deprecated
public Long decrement(String key,
                                  String hashKey,
                                  Long data)
```
    Deprecated.
    
    递减已过期，请使用 NumberHandler.subtractLong(String, String, long) 替换
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    data - 步长
    
    Returns:
    
    返回递减后的值
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HINCRBY
  - decrement
```
@Deprecated
public Long decrement(String key,
                                  String hashKey)
```
    Deprecated.
    
    递减已过期，请使用 NumberHandler.decrementLong(String, String) 替换
    
    Parameters:
    
    key - 键
    
    hashKey - hash键
    
    Returns:
    
    返回递减后的值
    
    Since:
    
    redis 2.0.0
    
    See Also:
    
    Redis Documentation: HINCRBY
  - scanAsObj
```
public org.springframework.data.redis.core.Cursor<Map.Entry<String,Object>> scanAsObj(String key,
                                                                                      Long count,
                                                                                      String pattern)
```
    匹配对象
    
    Parameters:
    
    key - 键
    
    count - 数量
    
    pattern - 规则
    
    Returns:
    
    返回匹配对象
    
    Since:
    
    redis 2.8.0
    
    See Also:
    
    Redis Documentation: HSCAN
  - scan
```
public org.springframework.data.redis.core.Cursor<Map.Entry<String,String>> scan(String key,
                                                                                 Long count,
                                                                                 String pattern)
```
    匹配字符串
    
    Parameters:
    
    key - 键
    
    count - 数量
    
    pattern - 规则
    
    Returns:
    
    返回匹配字符串
    
    Since:
    
    redis 2.8.0
    
    See Also:
    
    Redis Documentation: HSCAN
  - getRedisTemplate
```
public org.springframework.data.redis.core.RedisTemplate<String,Object> getRedisTemplate()
```
    获取spring redis模板
    
    Returns:
    
    返回对象模板
  - getStringRedisTemplate
```
public org.springframework.data.redis.core.StringRedisTemplate getStringRedisTemplate()
```
    获取spring string redis模板
    
    Returns:
    
    返回字符串模板

Class HashHandler

Method Summary

Methods inherited from class java.lang.Object

Method Detail

putAsObj

put

putIfAbsentAsObj

putIfAbsent

putAllAsObj

putAll

getAsObj

getAsObj

get

mgetAsObj

mget

removeAsObj

remove

entriesAsObj

entries

keysAsObj

keys

valuesAsObj

values

lengthOfValue

sizeAsObj

size

hasKeyAsObj

hasKey

increment

increment

increment

decrement

decrement

decrement

scanAsObj

scan

getRedisTemplate

getStringRedisTemplate