RedisMap (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.tools.collection.RedisMap<K,V>

All Implemented Interfaces:

Closeable, AutoCloseable, Map<K,V>, ICacheMap<K,V>
```
public class RedisMap<K,V>
extends Object
implements ICacheMap<K,V>, Closeable
```
基于 Redis 的 Map 实现简单实现,key 和 value 都是 String 类型为了支撑多线程达到线程安全所以默认必须采用JedisPoolConfig来支持每一个操作都获取一个独立的 Jedis 来操作如果 name 为 null,则采用 redis 的顶层键值系统, 如果 name 为非 null 则使用 redis 的 map 系统

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class RedisMap.RedisMapEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`class`	`RedisMap.RedisMapEntry<K,V>`

Field Summary

Fields
Modifier and Type Field and Description

static String LOCK_SUCCESS

static String SET_EXPIRE_TIME

static String SET_NOT_EXIST

static Long UNLOCK_SUCCESS

Fields
Modifier and Type	Field and Description
`static String`	`LOCK_SUCCESS`
`static String`	`SET_EXPIRE_TIME`
`static String`	`SET_NOT_EXIST`
`static Long`	`UNLOCK_SUCCESS`

Constructor Summary

Constructors
Constructor and Description
`RedisMap()` 构造函数如果 name 为 null,则采用 redis 的顶层键值系统
`RedisMap(redis.clients.util.Pool<redis.clients.jedis.Jedis> jedisPool)` 构造函数
`RedisMap(redis.clients.util.Pool<redis.clients.jedis.Jedis> jedisPool, String name)` 构造函数
`RedisMap(String name)` 构造函数
`RedisMap(String host, int port, int timeout, int poolsize)` 构造函数如果 name 为 null,则采用 redis 的顶层键值系统
`RedisMap(String host, int port, int timeout, int poolsize, String name)` 构造函数
`RedisMap(String host, int port, int timeout, int poolsize, String name, String password)` 构造函数

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`void`	`close()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`RedisMap<K,V>`	`dbIndex(int dbIndex)` 选择当前数据集
`Set<Map.Entry<K,V>>`	`entrySet()`
`RedisMap<K,V>`	`expire(long expire)` 设置超时时间
`V`	`get(Object key, Function<K,V> appointedSupplier, Long createExpire, boolean refresh)` 获取对象
`int`	`getDbIndex()` 获取当前选择的数据集
`long`	`getExpire()` 获取超时时间
`Function<K,V>`	`getSupplier()` 获取数据创建 Function 对象
`long`	`getTTL(K key)` 为 Key 获取 key 的超时时间
`long`	`incr(K key, long value)` 原子增加操作
`double`	`incrFloat(K key, double value)` 原子增加操作
`boolean`	`isEmpty()`
`Set<K>`	`keySet()`
`Set<K>`	`keySet(String pattern)` 获取键集合
`boolean`	`persist(K key)` 持久化某个
`V`	`put(K key, V value)`
`V`	`put(K key, V value, long expire)` 像 redis 中放置字符串数据
`void`	`putAll(Map<? extends K,? extends V> map)`
`void`	`putAll(Map<? extends K,? extends V> map, long expire)`
`V`	`putIfAbsent(K key, V value)` 在 Redis 环境下返回的数据不保证是 Redis 中的数据
`V`	`putIfAbsent(K key, V value, long expire)`
`V`	`remove(Object key)`
`ScanedObject`	`scan(String cursor, V matchValue, Integer count)`
`boolean`	`setTTL(K key, long expire)` 更新某个对象的超时时间可以为某个没有配置超时时间的键值对配置超时时间
`int`	`size()`
`RedisMap<K,V>`	`supplier(Function<K,V> supplier)` 如果参数为空的默认构造方法
`Collection<V>`	`values()`

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

Methods inherited from interface org.voovan.tools.collection.ICacheMap
get, get, get, getAndRefresh, getAndRefresh, getAndRefresh

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, remove, replace, replace, replaceAll

- Field Detail
  - LOCK_SUCCESS
```
public static final String LOCK_SUCCESS
```
    See Also:
    
    Constant Field Values
  - UNLOCK_SUCCESS
```
public static final Long UNLOCK_SUCCESS
```
  - SET_NOT_EXIST
```
public static final String SET_NOT_EXIST
```
    See Also:
    
    Constant Field Values
  - SET_EXPIRE_TIME
```
public static final String SET_EXPIRE_TIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RedisMap
```
public RedisMap(String host,
                int port,
                int timeout,
                int poolsize,
                String name,
                String password)
```
    构造函数
    
    Parameters:
    
    host - redis 服务地址
    
    port - redis 服务端口
    
    timeout - redis 连接超时时间
    
    poolsize - redis 连接池的大小
    
    name - 在 redis 中的 HashMap的名称
    
    password - redis 服务密码
  - RedisMap
```
public RedisMap(String host,
                int port,
                int timeout,
                int poolsize,
                String name)
```
    构造函数
    
    Parameters:
    
    host - redis 服务地址
    
    port - redis 服务端口
    
    timeout - redis 连接超时时间
    
    poolsize - redis 连接池的大小
    
    name - 在 redis 中的 HashMap的名称
  - RedisMap
```
public RedisMap(String host,
                int port,
                int timeout,
                int poolsize)
```
    构造函数如果 name 为 null,则采用 redis 的顶层键值系统
    
    Parameters:
    
    host - redis 服务地址
    
    port - redis 服务端口
    
    timeout - redis 连接超时时间
    
    poolsize - redis 连接池的大小
  - RedisMap
```
public RedisMap(String name)
```
    构造函数
    
    Parameters:
    
    name - 在 redis 中的 HashMap的名称
  - RedisMap
```
public RedisMap(redis.clients.util.Pool<redis.clients.jedis.Jedis> jedisPool,
                String name)
```
    构造函数
    
    Parameters:
    
    jedisPool - redis 连接池
    
    name - 在 redis 中的 HashMap的名称
  - RedisMap
```
public RedisMap(redis.clients.util.Pool<redis.clients.jedis.Jedis> jedisPool)
```
    构造函数
    
    Parameters:
    
    jedisPool - redis 连接池
  - RedisMap
```
public RedisMap()
```
    构造函数如果 name 为 null,则采用 redis 的顶层键值系统
- Method Detail
  - getDbIndex
```
public int getDbIndex()
```
    获取当前选择的数据集
    
    Returns:
    
    数据集序号
  - dbIndex
```
public RedisMap<K,V> dbIndex(int dbIndex)
```
    选择当前数据集
    
    Parameters:
    
    dbIndex - 数据集序号
    
    Returns:
    
    RedisMap 对象
  - getSupplier
```
public Function<K,V> getSupplier()
```
    获取数据创建 Function 对象
    
    Specified by:
    
    getSupplier in interface ICacheMap<K,V>
    
    Returns:
    
    Function 对象
  - supplier
```
public RedisMap<K,V> supplier(Function<K,V> supplier)
```
    如果参数为空的默认构造方法
    
    Specified by:
    
    supplier in interface ICacheMap<K,V>
    
    Parameters:
    
    supplier - 创建函数
    
    Returns:
    
    CachedHashMap 对象
  - getExpire
```
public long getExpire()
```
    获取超时时间
    
    Specified by:
    
    getExpire in interface ICacheMap<K,V>
    
    Returns:
    
    超时时间
  - expire
```
public RedisMap<K,V> expire(long expire)
```
    设置超时时间
    
    Specified by:
    
    expire in interface ICacheMap<K,V>
    
    Parameters:
    
    expire - 超时时间
    
    Returns:
    
    CachedHashMap 对象
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K,V>
  - get
```
public V get(Object key,
             Function<K,V> appointedSupplier,
             Long createExpire,
             boolean refresh)
```
    获取对象
    
    Specified by:
    
    get in interface ICacheMap<K,V>
    
    Parameters:
    
    key - 键
    
    appointedSupplier - 在指定的 key 不存在的时候使用指定的获取器构造对象
    
    createExpire - 超时时间
    
    refresh - 刷新超时时间
    
    Returns:
    
    值
  - put
```
public V put(K key,
             V value)
```
    Specified by:
    
    put in interface Map<K,V>
  - put
```
public V put(K key,
             V value,
             long expire)
```
    像 redis 中放置字符串数据
    
    Specified by:
    
    put in interface ICacheMap<K,V>
    
    Parameters:
    
    key - key 名称
    
    value - 数据
    
    expire - 超时事件
    
    Returns:
    
    true: 成功, false:失败
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value)
```
    在 Redis 环境下返回的数据不保证是 Redis 中的数据
    
    Specified by:
    
    putIfAbsent in interface Map<K,V>
    
    Parameters:
    
    key - 更新的 key
    
    value - 更新的 value,
    
    Returns:
    
    返回的数据对象, value: null更新成功, value: 有数据返回的情况下仅仅表示更新失败, 返回的数据无法准确视为 Redis 中保存的数据
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value,
                     long expire)
```
    Specified by:
    
    putIfAbsent in interface ICacheMap<K,V>
  - setTTL
```
public boolean setTTL(K key,
                      long expire)
```
    更新某个对象的超时时间可以为某个没有配置超时时间的键值对配置超时时间
    
    Specified by:
    
    setTTL in interface ICacheMap<K,V>
    
    Parameters:
    
    key - 键
    
    expire - 超时时间
    
    Returns:
    
    true: 成功, false: 失败
  - getTTL
```
public long getTTL(K key)
```
    为 Key 获取 key 的超时时间
    
    Specified by:
    
    getTTL in interface ICacheMap<K,V>
    
    Parameters:
    
    key - key 名称
    
    Returns:
    
    超时时间
  - persist
```
public boolean persist(K key)
```
    持久化某个
    
    Parameters:
    
    key - key 名称
    
    Returns:
    
    true: 成功, false:失败
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,V>
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Specified by:
    
    putAll in interface Map<K,V>
  - putAll
```
public void putAll(Map<? extends K,? extends V> map,
                   long expire)
```
    Specified by:
    
    putAll in interface ICacheMap<K,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K,V>
  - keySet
```
public Set<K> keySet()
```
    Specified by:
    
    keySet in interface Map<K,V>
  - keySet
```
public Set<K> keySet(String pattern)
```
    获取键集合
    
    Parameters:
    
    pattern - 匹配表达式
    
    Returns:
    
    键集合
  - values
```
public Collection<V> values()
```
    Specified by:
    
    values in interface Map<K,V>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<K,V>
  - incr
```
public long incr(K key,
                 long value)
```
    原子增加操作
    
    Parameters:
    
    key - key 名称
    
    value - 值
    
    Returns:
    
    自增后的结果
  - incrFloat
```
public double incrFloat(K key,
                        double value)
```
    原子增加操作
    
    Parameters:
    
    key - key 名称
    
    value - 值
    
    Returns:
    
    自增后的结果
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - scan
```
public ScanedObject scan(String cursor,
                         V matchValue,
                         Integer count)
```

Class RedisMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.voovan.tools.collection.ICacheMap

Methods inherited from interface java.util.Map

Field Detail

LOCK_SUCCESS

UNLOCK_SUCCESS

SET_NOT_EXIST

SET_EXPIRE_TIME

Constructor Detail

RedisMap

RedisMap

RedisMap

RedisMap

RedisMap

RedisMap

RedisMap

Method Detail

getDbIndex

dbIndex

getSupplier

supplier

getExpire

expire

size

isEmpty

containsKey

containsValue

get

put

put

putIfAbsent

putIfAbsent

setTTL

getTTL

persist

remove

putAll

putAll

clear

keySet

keySet

values

entrySet

incr

incrFloat

close

scan