RedisClient (exp-libs-db 2.0.0 API)

java.lang.Object
- exp.libs.db.redis.RedisClient

public class RedisClient
extends Object

 Redis连接客户端.
 内部自带连接池, 适用于Redis单机/主从/哨兵/集群模式 .
 
 根据实际Redis的配置，使用不同的构造函数即可，已屏蔽到集群/非集群的连接/操作方式差异性.
 Redis配置推荐使用RedisBean方式（XConfig}已提供对其的xml配置文件支持）
 --------------------------------------------------
 

 科普：
        对于 单机/主从/哨兵 模式，连接方式都是一样的，使用Jedis实例连接（已封装到_Jedis）
        对于 集群 模式，则需要使用JedisCluster实例连接（已封装到_JedisCluster）
 
        一般情况下，对于 主从/哨兵 模式，只需要连接到主机即可（或者连接从机亦可，但一般不建议）
        特别地，对于 哨兵模式，一定不能连接到 哨兵机（哨兵机是用于监控主从机器，当主机挂掉的时候重新选举主机的，不做数据业务）

PROJECT : exp-libs
SUPPORT : https://exp-blog.com

从以下版本开始:: JDK 1.8+
版本:: 2022-03-06
作者:: EXP: exp.lqb@foxmail.com

字段概要

字段
限定符和类型字段和说明

static String DEFAULT_IP
默认redis IP

static int DEFAULT_PORT
默认redis 端口

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_IP` 默认redis IP
`static int`	`DEFAULT_PORT` 默认redis 端口

构造器概要

构造器
构造器和说明
`RedisClient()` 构造函数（单机模式）使用默认的IP端口： 127.0.0.1:6379
`RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig, int timeout, redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig, int timeout, String... clusterSockets)` 构造函数（适用集群模式）
`RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig, int timeout, String password, redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig, int timeout, String password, String... clusterSockets)` 构造函数（适用集群模式）
`RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig, String password, redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig, String password, String... clusterSockets)` 构造函数（适用集群模式）
`RedisClient(redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(int timeout, redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(int timeout, String... clusterSockets)` 构造函数（适用集群模式）
`RedisClient(int timeout, String password, redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(int timeout, String password, String... clusterSockets)` 构造函数（适用集群模式）
`RedisClient(RedisBean rb)` 构造函数
`RedisClient(String... clusterSockets)` 构造函数（适用集群模式）
`RedisClient(String password, redis.clients.jedis.HostAndPort... clusterNodes)` 构造函数（适用集群模式）
`RedisClient(String ip, int port)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String ip, int port, int timeout)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String ip, int port, int timeout, org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String ip, int port, int timeout, String password)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String ip, int port, int timeout, String password, org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String ip, int port, String password)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String ip, int port, String password, org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)` 构造函数（适用单机/主从/哨兵模式）
`RedisClient(String password, String[] clusterSockets)` 构造函数（适用集群模式）

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`long`	`addSerialList(String redisKey, List<Serializable> list)` 新增一个 List<Serializable>列表.
`boolean`	`addSerialMap(String redisKey, Map<String,Serializable> map)` 新增一个 Map<String, Serializable>哈希表.
`boolean`	`addSerialObj(String redisKey, Serializable object)` 新增一个序列化对象（该对象须实现Serializable接口）.
`long`	`addSerialObjsToList(String redisKey, Serializable... objects)` 添加一些序列化对象到 List<Serializable>列表.
`long`	`addSerialObjsToListHead(String redisKey, Serializable... objects)` 添加一些序列化对象到 List<Serializable>列表头部.
`long`	`addSerialObjsToListTail(String redisKey, Serializable... objects)` 添加一些序列化对象到 List<Serializable>列表尾部.
`long`	`addSerialObjsToSet(String redisKey, Serializable... objects)` 添加一些值到 Set<Serializable>集合.
`boolean`	`addSerialObjToMap(String redisKey, String key, Serializable object)` 新增一个键值对像到 Map<String, Serializable>哈希表.
`long`	`addSerialSet(String redisKey, Set<Serializable> set)` 新增一个 Set<Serializable>集合.
`long`	`addStrList(String redisKey, List<String> list)` 新增一个 List<String>列表.
`boolean`	`addStrMap(String redisKey, Map<String,String> map)` 新增一个 Map<String, String>哈希表.
`long`	`addStrSet(String redisKey, Set<String> set)` 新增一个 Set<String>集合.
`boolean`	`addStrVal(String redisKey, String value)` 新增一个键值对（若已存在则覆盖）
`long`	`addStrValsToList(String redisKey, String... values)` 添加一些值到 List<String>列表.
`long`	`addStrValsToListHead(String redisKey, String... values)` 添加一些值到 List<String>列表头部.
`long`	`addStrValsToListTail(String redisKey, String... values)` 添加一些值到 List<String>列表尾部.
`long`	`addStrValsToSet(String redisKey, String... values)` 添加一些值到 Set<String>集合.
`boolean`	`addStrValToMap(String redisKey, String key, String value)` 新增一个键值对到 Map<String, String>哈希表.
`long`	`appendStrVal(String redisKey, String value)` 在已有的键的原值的末尾附加值（若键不存在则新增）.
`boolean`	`clearAll()` 清空Redis库中所有数据(集群模式不支持此操作)
`void`	`close()` 断开redis连接
`void`	`closeAutoCommit()` 在使用连接池的情况下, redis的操作默认均为短连接.
`void`	`commit()` 把redis操作模式切换为默认的短连接模式. ----------------- 此方法非多线程安全，集群模式不支持此操作.
`long`	`delKeys(String... redisKeys)` 删除Redis中的若干个键（及其对应的内容）
`long`	`delKeysInMap(String redisKey, String... keys)` 删除某个哈希表中的若干个键（及其对应的值）
`long`	`delSerialObjsInList(String redisKey, Serializable object)` 删除 List<Serializable>列表中, 值与期望值一致的所有元素.
`long`	`delSerialObjsInList(String redisKey, Serializable object, long count)` 删除 List<Serializable>列表中，从前往后数的前N个值与期望值一致的所有元素.
`long`	`delSerialObjsInSet(String redisKey, Serializable... objects)` 删除 Set<Serializable>集合中指定的值对象.
`long`	`delStrValsInList(String redisKey, String value)` 删除 List<String>列表中, 值与期望值一致的所有元素.
`long`	`delStrValsInList(String redisKey, String value, long count)` 删除 List<String>列表中，从前往后数的前N个值与期望值一致的所有元素.
`long`	`delStrValsInSet(String redisKey, String... values)` 删除 Set<String>集合中指定的值.
`void`	`destory()` 断开Redis连接
`boolean`	`existInSet(String redisKey, Serializable object)` 检测某个值对象是否在指定的 Set<Serializable>集合中.
`boolean`	`existInSet(String redisKey, String value)` 检测某个值是否在指定的 Set<String>集合中.
`boolean`	`existKey(String redisKey)` 检查Redis库里面是否存在某个键值
`boolean`	`existKeyInMap(String redisKey, String key)` 检查某个哈希表中是否存在某个键
`Set<String>`	`getAllKeysInMap(String redisKey)` 获取哈希表中所有键
`List<Object>`	`getAllSerialObjsInList(String redisKey)` 获取整个 List<Serializable>列表中的所有值.
`List<Object>`	`getAllSerialObjsInMap(String redisKey)` 获取某个Map<String, Serializable>哈希表中的所有值.
`Set<Object>`	`getAllSerialObjsInSet(String redisKey)` 获取 Set<Serializable>集合中的所对象（反序列化对象）.
`List<String>`	`getAllStrValsInList(String redisKey)` 获取整个 List<String>列表中的所有值.
`List<String>`	`getAllStrValsInMap(String redisKey)` 获取某个Map<String, String>哈希表中的所有值.
`Set<String>`	`getAllStrValsInSet(String redisKey)` 获取 Set<String>集合中的所有值.
`long`	`getListSize(String redisKey)` 获取列表的大小
`long`	`getMapSize(String redisKey)` 获取哈希表的大小
`Object`	`getRandomSerialObjInSet(String redisKey)` 获取 Set<Serializable>集合中一个随机对象（反序列化对象）.
`String`	`getRandomStrValInSet(String redisKey)` 获取 Set<String>集合中一个随机元素.
`List<Object>`	`getSerialList(String redisKey)` 获取整个 List<Serializable>列表（即返回其中的所有值）.
`Map<String,Object>`	`getSerialMap(String redisKey)` 取出一个 Map<String, Serializable>哈希表（其值为反序列化对象）.
`Object`	`getSerialObj(String redisKey)` 获取指定键的序列化对象.
`Object`	`getSerialObjInList(String redisKey, long index)` 获取 List<Serializable>列表中指定位置的值 .
`Object`	`getSerialObjInMap(String redisKey, String key)` 获取某个Map<String, Serializable>哈希表中的某个键的值对象（反序列化对象）配套`addSerialMap(java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>)`或`addSerialObjToMap(java.lang.String, java.lang.String, java.io.Serializable)`使用.
`List<Object>`	`getSerialObjsInMap(String redisKey, String... keys)` 获取某个Map<String, Serializable>哈希表中的若干个键的值对象（反序列化对象）配套`addSerialMap(java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>)`或`addSerialObjToMap(java.lang.String, java.lang.String, java.io.Serializable)`使用.
`Set<Object>`	`getSerialSet(String redisKey)` 获取整个 Set<Serializable>集合（即返回其中的所有值对象）.
`long`	`getSetSize(String redisKey)` 获取集合的大小
`List<String>`	`getStrList(String redisKey)` 获取整个 List<String>列表（即返回其中的所有值）.
`Map<String,String>`	`getStrMap(String redisKey)` 取出一个 Map<String, String>哈希表.
`Set<String>`	`getStrSet(String redisKey)` 获取整个 Set<String>集合（即返回其中的所有值）.
`String`	`getStrVal(String redisKey)` 获取指定键的值.
`String`	`getStrValInList(String redisKey, long index)` 获取 List<String>列表中指定位置的值 .
`String`	`getStrValInMap(String redisKey, String key)` 获取某个Map<String, String>哈希表中的某个键的值配套`addStrMap(java.lang.String, java.util.Map<java.lang.String, java.lang.String>)`或`addStrValToMap(java.lang.String, java.lang.String, java.lang.String)`使用.
`List<String>`	`getStrValsInMap(String redisKey, String... keys)` 获取某个Map<String, String>哈希表中的若干个键的值配套`addStrMap(java.lang.String, java.util.Map<java.lang.String, java.lang.String>)`或`addStrValToMap(java.lang.String, java.lang.String, java.lang.String)`使用.
`boolean`	`isVaild()` 测试Redis连接是否有效(集群模式不支持此操作)
`void`	`setAutoCommit(boolean autoCommit)` 设置是否自动提交.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料
- DEFAULT_IP
```
public static final String DEFAULT_IP
```
  默认redis IP
  
  另请参阅:
  
  常量字段值
- DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
  默认redis 端口
  
  另请参阅:
  
  常量字段值

构造器详细资料

RedisClient
```
public RedisClient(RedisBean rb)
```
构造函数

参数:

rb - redis配置对象（通过RedisBean.isCluster()方法自动切换集群/非集群模式）

RedisClient
```
public RedisClient()
```
构造函数（单机模式）使用默认的IP端口： 127.0.0.1:6379

RedisClient
```
public RedisClient(String ip,
                   int port)
```
构造函数（适用单机/主从/哨兵模式）

参数:

ip - redis IP

port - redis端口

RedisClient
```
public RedisClient(String ip,
                   int port,
                   int timeout)
```
构造函数（适用单机/主从/哨兵模式）

参数:

ip - redis IP

port - redis端口

timeout - 超时时间(ms)

RedisClient

public RedisClient(String ip,
                   int port,
                   String password)

构造函数（适用单机/主从/哨兵模式）

参数:: ip - redis IP; port - redis端口; password - redis密码

RedisClient

public RedisClient(String ip,
                   int port,
                   int timeout,
                   String password)

构造函数（适用单机/主从/哨兵模式）

参数:: ip - redis IP; port - redis端口; timeout - 超时时间(ms); password - redis密码

RedisClient

public RedisClient(String ip,
                   int port,
                   int timeout,
                   org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)

构造函数（适用单机/主从/哨兵模式）

参数:: ip - redis IP; port - redis端口; timeout - 超时时间(ms); poolConfig - 连接池配置

RedisClient

public RedisClient(String ip,
                   int port,
                   String password,
                   org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)

构造函数（适用单机/主从/哨兵模式）

参数:: ip - redis IP; port - redis端口; password - redis密码; poolConfig - 连接池配置

RedisClient

public RedisClient(String ip,
                   int port,
                   int timeout,
                   String password,
                   org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)

构造函数（适用单机/主从/哨兵模式）

参数:: ip - redis IP; port - redis端口; timeout - 超时时间(ms); password - redis密码; poolConfig - 连接池配置

RedisClient
```
public RedisClient(redis.clients.jedis.HostAndPort... clusterNodes)
```
构造函数（适用集群模式）

参数:

clusterNodes - 集群节点

RedisClient
```
public RedisClient(int timeout,
                   redis.clients.jedis.HostAndPort... clusterNodes)
```
构造函数（适用集群模式）

参数:

timeout - 超时时间(ms)

clusterNodes - 集群节点

RedisClient

public RedisClient(String password,
                   redis.clients.jedis.HostAndPort... clusterNodes)

构造函数（适用集群模式）

参数:: password - redis密码; clusterNodes - 集群节点

RedisClient

public RedisClient(int timeout,
                   String password,
                   redis.clients.jedis.HostAndPort... clusterNodes)

构造函数（适用集群模式）

参数:: timeout - 超时时间(ms); password - redis密码; clusterNodes - 集群节点

RedisClient

public RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig,
                   int timeout,
                   redis.clients.jedis.HostAndPort... clusterNodes)

构造函数（适用集群模式）

参数:: poolConfig - 连接池配置; timeout - 超时时间(ms); clusterNodes - 集群节点

RedisClient

public RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig,
                   String password,
                   redis.clients.jedis.HostAndPort... clusterNodes)

构造函数（适用集群模式）

参数:: poolConfig - 连接池配置; password - redis密码; clusterNodes - 集群节点

RedisClient

public RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig,
                   int timeout,
                   String password,
                   redis.clients.jedis.HostAndPort... clusterNodes)

构造函数（适用集群模式）

参数:: poolConfig - 连接池配置; timeout - 超时时间(ms); password - redis密码; clusterNodes - 集群节点

RedisClient
```
public RedisClient(String... clusterSockets)
```
构造函数（适用集群模式）

参数:

clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

RedisClient
```
public RedisClient(int timeout,
                   String... clusterSockets)
```
构造函数（适用集群模式）

参数:

timeout - 超时时间(ms)

clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

RedisClient
```
public RedisClient(String password,
                   String[] clusterSockets)
```
构造函数（适用集群模式）

参数:

password - redis密码

clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

RedisClient
```
public RedisClient(int timeout,
                   String password,
                   String... clusterSockets)
```
构造函数（适用集群模式）

参数:

timeout - 超时时间(ms)

password - redis密码

clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

RedisClient
```
public RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig,
                   int timeout,
                   String... clusterSockets)
```
构造函数（适用集群模式）

参数:

poolConfig - 连接池配置

timeout - 超时时间(ms)

clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

RedisClient

public RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig,
                   String password,
                   String... clusterSockets)

构造函数（适用集群模式）

参数:: poolConfig - 连接池配置; password - redis密码; clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

RedisClient

public RedisClient(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig,
                   int timeout,
                   String password,
                   String... clusterSockets)

构造函数（适用集群模式）

参数:: poolConfig - 连接池配置; timeout - 超时时间(ms); password - redis密码; clusterSockets - 集群连接Socket串（格式为 ip:port，如 127.0.0.1:6739）

方法详细资料

isVaild
```
public boolean isVaild()
```
测试Redis连接是否有效(集群模式不支持此操作)

返回:

true:连接成功; false:连接失败

setAutoCommit

public void setAutoCommit(boolean autoCommit)

 设置是否自动提交.
 在使用连接池的情况下, redis的操作默认均为短连接.
 此方法可临时切换操作模式为长连接/短连接.
 在调用commit()方法后恢复为短连接模式.
 -----------------
 此方法非多线程安全，集群模式不支持此操作.

参数:: autoCommit - true:自动提交; false:手动提交(需调用commit()方法)

closeAutoCommit

public void closeAutoCommit()

 在使用连接池的情况下, redis的操作默认均为短连接.
 此方法可临时切换操作模式为长连接, 在调用commit()方法后恢复为短连接模式.
 -----------------
 此方法非多线程安全，集群模式不支持此操作.

commit

public void commit()

 把redis操作模式切换为默认的短连接模式.
 -----------------
 此方法非多线程安全，集群模式不支持此操作.

destory
```
public void destory()
```
断开Redis连接

close
```
public void close()
```
断开redis连接

clearAll
```
public boolean clearAll()
```
清空Redis库中所有数据(集群模式不支持此操作)

返回:

true:清空成功; false:清空失败

existKey
```
public boolean existKey(String redisKey)
```
检查Redis库里面是否存在某个键值

参数:

redisKey - 所操作对象在redis中的键

返回:

true:存在; false:不存在

delKeys
```
public long delKeys(String... redisKeys)
```
删除Redis中的若干个键（及其对应的内容）

参数:

redisKeys - 所操作对象在redis中的键集

返回:

删除成功的个数

addStrVal
```
public boolean addStrVal(String redisKey,
                         String value)
```
新增一个键值对（若已存在则覆盖）

参数:

redisKey - 所操作对象在redis中的键

value - 新的值

返回:

true:新增成功; false:新增失败

appendStrVal

public long appendStrVal(String redisKey,
                         String value)

 在已有的键的原值的末尾附加值（若键不存在则新增）.
 配套addStrVal(java.lang.String, java.lang.String)使用.

参数:: redisKey - 所操作对象在redis中的键; value - 附加的值
返回:: 附加值后，该键上最新的值的总长度(若附加失败返回-1)

getStrVal

public String getStrVal(String redisKey)

 获取指定键的值.
 配套addStrVal(java.lang.String, java.lang.String)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: 对应的值（若不存在键则返回null）

addSerialObj

public boolean addSerialObj(String redisKey,
                            Serializable object)

 新增一个序列化对象（该对象须实现Serializable接口）.
 该对象会以序列化形式存储到Redis.

参数:: redisKey - 所操作对象在redis中的键; object - 新增的对象（须实现Serializable接口）
返回:: true:新增成功; false:新增失败

getSerialObj

public Object getSerialObj(String redisKey)

 获取指定键的序列化对象.
 该对象会从Redis反序列化.
 配套addSerialObj(java.lang.String, java.io.Serializable)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: 反序列化的对象（若失败则返回null）

addStrMap

public boolean addStrMap(String redisKey,
                         Map<String,String> map)

 新增一个 Map<String, String>哈希表.
        若已存在同键的哈希表，则两个哈希表合并, 表内同键的值会被后者覆盖.

参数:: redisKey - 所操作对象在redis中的键; map - Map<String, String>哈希表
返回:: true:新增成功; false:新增失败

addStrValToMap

public boolean addStrValToMap(String redisKey,
                              String key,
                              String value)

 新增一个 键值对 到 Map<String, String>哈希表.
 若该哈希表不存在则创建.

参数:: redisKey - 所操作对象在redis中的键; key - 新增到哈希表内的键; value - 新增到哈希表内的值
返回:: true:新增成功; false:新增失败

getStrMap

public Map<String,String> getStrMap(String redisKey)

 取出一个  Map<String, String>哈希表.
 配套addStrMap(java.lang.String, java.util.Map<java.lang.String, java.lang.String>)或addStrValToMap(java.lang.String, java.lang.String, java.lang.String)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: Map<String, String>哈希表（若不存在则返回空表，不会返回null）

getStrValInMap

public String getStrValInMap(String redisKey,
                             String key)

 获取某个Map<String, String>哈希表中的某个键的值
 配套addStrMap(java.lang.String, java.util.Map<java.lang.String, java.lang.String>)或addStrValToMap(java.lang.String, java.lang.String, java.lang.String)使用.

参数:: redisKey - 所操作对象在redis中的键; key - 哈希表中的某个键
返回:: 哈希表中对应的值（若不存在返回null）

getStrValsInMap

public List<String> getStrValsInMap(String redisKey,
                                    String... keys)

 获取某个Map<String, String>哈希表中的若干个键的值
 配套addStrMap(java.lang.String, java.util.Map<java.lang.String, java.lang.String>)或addStrValToMap(java.lang.String, java.lang.String, java.lang.String)使用.

参数:: redisKey - 所操作对象在redis中的键; keys - 哈希表中的一些键
返回:: 哈希表中对应的一些值列表（列表不会为null，内部值顺序对应入参的键顺序, 若该键对应值不存在, 则该位置为null）

getAllStrValsInMap

public List<String> getAllStrValsInMap(String redisKey)

 获取某个Map<String, String>哈希表中的所有值.
 配套addStrMap(java.lang.String, java.util.Map<java.lang.String, java.lang.String>)或addStrValToMap(java.lang.String, java.lang.String, java.lang.String)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: 若不存在该哈希表或哈希表为空，则返回空列表（不会返回null）

addSerialMap

public boolean addSerialMap(String redisKey,
                            Map<String,Serializable> map)

 新增一个 Map<String, Serializable>哈希表.
        若已存在同键的哈希表，则两个哈希表合并, 表内同键的值会被后者覆盖.

参数:: redisKey - 所操作对象在redis中的键; map - 哈希表（其值须实现Serializable接口）
返回:: true:新增成功; false:新增失败

addSerialObjToMap

public boolean addSerialObjToMap(String redisKey,
                                 String key,
                                 Serializable object)

 新增一个 键值对像 到  Map<String, Serializable>哈希表.
 若该哈希表不存在则创建.

参数:: redisKey - 所操作对象在redis中的键; key - 新增到哈希表内的键; object - 新增到哈希表内的值对象（须实现Serializable接口）
返回:: true:新增成功; false:新增失败

getSerialMap

public Map<String,Object> getSerialMap(String redisKey)

 取出一个  Map<String, Serializable>哈希表（其值为反序列化对象）.
 配套addSerialMap(java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>)或addSerialObjToMap(java.lang.String, java.lang.String, java.io.Serializable)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: Map<String, Object>哈希表（若不存在则返回空表，不会返回null）

getSerialObjInMap

public Object getSerialObjInMap(String redisKey,
                                String key)

 获取某个Map<String, Serializable>哈希表中的某个键的值对象（反序列化对象）
 配套addSerialMap(java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>)或addSerialObjToMap(java.lang.String, java.lang.String, java.io.Serializable)使用.

参数:: redisKey - 所操作对象在redis中的键; key - 哈希表中的某个键
返回:: 哈希表中对应的值对象（反序列化对象，若不存在返回null）

getSerialObjsInMap

public List<Object> getSerialObjsInMap(String redisKey,
                                       String... keys)

 获取某个Map<String, Serializable>哈希表中的若干个键的值对象（反序列化对象）
 配套addSerialMap(java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>)或addSerialObjToMap(java.lang.String, java.lang.String, java.io.Serializable)使用.

参数:: redisKey - 哈希表的键; keys - 哈希表中的一些键
返回:: 哈希表中对应的一些值对象列表（列表不会为null，内部值顺序对应入参的键顺序, 若该键对应值对象不存在, 则该位置为null）

getAllSerialObjsInMap

public List<Object> getAllSerialObjsInMap(String redisKey)

 获取某个Map<String, Serializable>哈希表中的所有值.
 配套addSerialMap(java.lang.String, java.util.Map<java.lang.String, java.io.Serializable>)或addSerialObjToMap(java.lang.String, java.lang.String, java.io.Serializable)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: 若不存在该哈希表或哈希表为空，则返回空列表（不会返回null）

existKeyInMap
```
public boolean existKeyInMap(String redisKey,
                             String key)
```
检查某个哈希表中是否存在某个键

参数:

redisKey - 所操作对象在redis中的键

key - 哈希表中的某个键

返回:

true:存在; false:不存在

getAllKeysInMap
```
public Set<String> getAllKeysInMap(String redisKey)
```
获取哈希表中所有键

参数:

redisKey - 所操作对象在redis中的键

返回:

若不存在该哈希表或哈希表为空，则返回空集（不会返回null）

delKeysInMap
```
public long delKeysInMap(String redisKey,
                         String... keys)
```
删除某个哈希表中的若干个键（及其对应的值）

参数:

redisKey - 所操作对象在redis中的键

keys - 哈希表中的一些键

返回:

删除成功的个数

getMapSize
```
public long getMapSize(String redisKey)
```
获取哈希表的大小

参数:

redisKey - 所操作对象在redis中的键

返回:

哈希表的大小

addStrList

public long addStrList(String redisKey,
                       List<String> list)

 新增一个 List<String>列表.
        若已存在同键列表，则两个列表合并.

参数:: redisKey - 所操作对象在redis中的键; list - List<String>列表
返回:: 该列表的总长度

addStrValsToList

public long addStrValsToList(String redisKey,
                             String... values)

 添加一些值到 List<String>列表.
 若列表不存在则自动创建.

参数:: redisKey - 所操作对象在redis中的键; values - 添加的值
返回:: 添加后，该列表的总长度

addStrValsToListHead

public long addStrValsToListHead(String redisKey,
                                 String... values)

 添加一些值到 List<String>列表 头部.
 若列表不存在则自动创建.

参数:: redisKey - 所操作对象在redis中的键; values - 添加的值
返回:: 添加后，该列表的总长度

addStrValsToListTail

public long addStrValsToListTail(String redisKey,
                                 String... values)

 添加一些值到 List<String>列表 尾部.
 若列表不存在则自动创建.

参数:: redisKey - 所操作对象在redis中的键; values - 添加的值列表
返回:: 添加后，该列表的总长度

getStrList

public List<String> getStrList(String redisKey)

 获取整个 List<String>列表（即返回其中的所有值）.
 配套addStrList(java.lang.String, java.util.List<java.lang.String>)或addStrValsToList(java.lang.String, java.lang.String...)或addStrValsToListHead(java.lang.String, java.lang.String...)或addStrValsToListTail(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: List<String>列表（若不存在则返回空表，不会返回null）

getStrValInList

public String getStrValInList(String redisKey,
                              long index)

 获取 List<String>列表 中指定位置的值 .
 配套addStrList(java.lang.String, java.util.List<java.lang.String>)或addStrValsToList(java.lang.String, java.lang.String...)或addStrValsToListHead(java.lang.String, java.lang.String...)或addStrValsToListTail(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键; index - 列表中的索引位置（第一个元素为0, 最后一个元素为-1, 正数索引为从前向后数, 负数索引为从后向前数）
返回:: 索引对应值（若列表为空则返回null）

getAllStrValsInList

public List<String> getAllStrValsInList(String redisKey)

 获取整个 List<String>列表中的所有值.
 配套addStrList(java.lang.String, java.util.List<java.lang.String>)或addStrValsToList(java.lang.String, java.lang.String...)或addStrValsToListHead(java.lang.String, java.lang.String...)或addStrValsToListTail(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: List<String>列表（若不存在则返回空表，不会返回null）

delStrValsInList

public long delStrValsInList(String redisKey,
                             String value)

 删除 List<String>列表中, 值与期望值一致的所有元素.
 配套addStrList(java.lang.String, java.util.List<java.lang.String>)或addStrValsToList(java.lang.String, java.lang.String...)或addStrValsToListHead(java.lang.String, java.lang.String...)或addStrValsToListTail(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键; value - 期望被删除的值
返回:: 成功从改集合中删除的值个数

delStrValsInList

public long delStrValsInList(String redisKey,
                             String value,
                             long count)

 删除 List<String>列表中，从前往后数的前N个值与期望值一致的所有元素.
 配套addStrList(java.lang.String, java.util.List<java.lang.String>)或addStrValsToList(java.lang.String, java.lang.String...)或addStrValsToListHead(java.lang.String, java.lang.String...)或addStrValsToListTail(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键; value - 期望被删除的值; count - 期望被删除的个数（正数表示从前往后数，负数表示从后往前数）
返回:: 成功从改集合中删除的值个数

addSerialList

public long addSerialList(String redisKey,
                          List<Serializable> list)

 新增一个 List<Serializable>列表.
        若已存在同键列表，则两个列表合并.

参数:: redisKey - 所操作对象在redis中的键; list - List<Serializable>列表
返回:: 该列表的总长度

addSerialObjsToList

public long addSerialObjsToList(String redisKey,
                                Serializable... objects)

 添加一些序列化对象到 List<Serializable>列表.
 若列表不存在则自动创建.

参数:: redisKey - 所操作对象在redis中的键; objects - 添加的序列化对象（需实现Serializable接口）
返回:: 添加后，该列表的总长度

addSerialObjsToListHead

public long addSerialObjsToListHead(String redisKey,
                                    Serializable... objects)

 添加一些序列化对象到 List<Serializable>列表 头部.
 若列表不存在则自动创建.

参数:: redisKey - 所操作对象在redis中的键; objects - 添加的序列化对象（需实现Serializable接口）
返回:: 添加后，该列表的总长度

addSerialObjsToListTail

public long addSerialObjsToListTail(String redisKey,
                                    Serializable... objects)

 添加一些序列化对象到 List<Serializable>列表 尾部.
 若列表不存在则自动创建.

参数:: redisKey - 所操作对象在redis中的键; objects - 添加的序列化对象（需实现Serializable接口）
返回:: 添加后，该列表的总长度

delSerialObjsInList

public long delSerialObjsInList(String redisKey,
                                Serializable object)

 删除 List<Serializable>列表中, 值与期望值一致的所有元素.
 配套addSerialList(java.lang.String, java.util.List<java.io.Serializable>)或addSerialObjsToList(java.lang.String, java.io.Serializable...)或addSerialObjsToListHead(java.lang.String, java.io.Serializable...)或addSerialObjsToListTail(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键; object - 期望被删除的值（需实现Serializable接口）
返回:: 成功从改集合中删除的值个数

delSerialObjsInList

public long delSerialObjsInList(String redisKey,
                                Serializable object,
                                long count)

 删除 List<Serializable>列表中，从前往后数的前N个值与期望值一致的所有元素.
 配套addSerialList(java.lang.String, java.util.List<java.io.Serializable>)或addSerialObjsToList(java.lang.String, java.io.Serializable...)或addSerialObjsToListHead(java.lang.String, java.io.Serializable...)或addSerialObjsToListTail(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键; object - 期望被删除的值（需实现Serializable接口）; count - 期望被删除的个数（正数表示从前往后数，负数表示从后往前数）
返回:: 成功从改集合中删除的值个数

getSerialList

public List<Object> getSerialList(String redisKey)

 获取整个 List<Serializable>列表（即返回其中的所有值）.
 配套addSerialList(java.lang.String, java.util.List<java.io.Serializable>)或addSerialObjsToList(java.lang.String, java.io.Serializable...)或addSerialObjsToListHead(java.lang.String, java.io.Serializable...)或addSerialObjsToListTail(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: List<Object>列表（若不存在则返回空表，不会返回null）

getSerialObjInList

public Object getSerialObjInList(String redisKey,
                                 long index)

 获取 List<Serializable>列表 中指定位置的值 .
 配套addSerialList(java.lang.String, java.util.List<java.io.Serializable>)或addSerialObjsToList(java.lang.String, java.io.Serializable...)或addSerialObjsToListHead(java.lang.String, java.io.Serializable...)或addSerialObjsToListTail(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键; index - 列表中的索引位置（第一个元素为0, 最后一个元素为-1, 正数索引为从前向后数, 负数索引为从后向前数）
返回:: 索引对应值（若列表为空则返回null）

getAllSerialObjsInList

public List<Object> getAllSerialObjsInList(String redisKey)

 获取整个 List<Serializable>列表中的所有值.
 配套addSerialList(java.lang.String, java.util.List<java.io.Serializable>)或addSerialObjsToList(java.lang.String, java.io.Serializable...)或addSerialObjsToListHead(java.lang.String, java.io.Serializable...)或addSerialObjsToListTail(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: List<Object>列表（若不存在则返回空表，不会返回null）

getListSize
```
public long getListSize(String redisKey)
```
获取列表的大小

参数:

redisKey - 所操作对象在redis中的键

返回:

列表的大小

addStrSet

public long addStrSet(String redisKey,
                      Set<String> set)

 新增一个 Set<String>集合.
        若已存在同键列表，则两个集合合并, 表内同键的值会被后者覆盖.

参数:: redisKey - 所操作对象在redis中的键; set - Set<String>列表
返回:: 成功添加到该集合的值个数

addStrValsToSet
```
public long addStrValsToSet(String redisKey,
                            String... values)
```
添加一些值到 Set<String>集合.

参数:

redisKey - 所操作对象在redis中的键

values - 添加的值

返回:

成功添加到该集合的值个数

getStrSet

public Set<String> getStrSet(String redisKey)

 获取整个 Set<String>集合（即返回其中的所有值）.
 配套addStrSet(java.lang.String, java.util.Set<java.lang.String>)或addStrValsToSet(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: Set<String>集合（若不存在则返回空集，不会返回null）

getRandomStrValInSet

public String getRandomStrValInSet(String redisKey)

 获取 Set<String>集合中一个随机元素.
 配套addStrSet(java.lang.String, java.util.Set<java.lang.String>)或addStrValsToSet(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: 若集合为空则返回null

getAllStrValsInSet

public Set<String> getAllStrValsInSet(String redisKey)

 获取 Set<String>集合中的所有值.
 配套addStrSet(java.lang.String, java.util.Set<java.lang.String>)或addStrValsToSet(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: Set<String>集合（若不存在则返回空集，不会返回null）

delStrValsInSet

public long delStrValsInSet(String redisKey,
                            String... values)

 删除 Set<String>集合中指定的值.
 配套addStrSet(java.lang.String, java.util.Set<java.lang.String>)或addStrValsToSet(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键; values - 期望被删除的值
返回:: 成功从该集合中删除的值个数

existInSet

public boolean existInSet(String redisKey,
                          String value)

 检测某个值是否在指定的 Set<String>集合中.
 配套addStrSet(java.lang.String, java.util.Set<java.lang.String>)或addStrValsToSet(java.lang.String, java.lang.String...)使用.

参数:: redisKey - 所操作对象在redis中的键; value - 被检测的值
返回:: true:在集合中; false:不在集合中

addSerialSet

public long addSerialSet(String redisKey,
                         Set<Serializable> set)

 新增一个 Set<Serializable>集合.
        若已存在同键列表，则两个集合合并, 表内同键的值会被后者覆盖.

参数:: redisKey - 所操作对象在redis中的键; set - Set<Serializable>列表
返回:: 成功添加到该集合的值个数

addSerialObjsToSet
```
public long addSerialObjsToSet(String redisKey,
                               Serializable... objects)
```
添加一些值到 Set<Serializable>集合.

参数:

redisKey - 所操作对象在redis中的键

objects - 添加的值对象（需实现Serializable接口）

返回:

成功添加到该集合的值个数

getSerialSet

public Set<Object> getSerialSet(String redisKey)

 获取整个 Set<Serializable>集合（即返回其中的所有值对象）.
 配套addSerialSet(java.lang.String, java.util.Set<java.io.Serializable>)或addSerialObjsToSet(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: Set<Object>集合（若不存在则返回空集，不会返回null）

getRandomSerialObjInSet

public Object getRandomSerialObjInSet(String redisKey)

 获取 Set<Serializable>集合中一个随机对象（反序列化对象）.
 配套addSerialSet(java.lang.String, java.util.Set<java.io.Serializable>)或addSerialObjsToSet(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: 若集合为空则返回null

getAllSerialObjsInSet

public Set<Object> getAllSerialObjsInSet(String redisKey)

 获取 Set<Serializable>集合中的所对象（反序列化对象）.
 配套addSerialSet(java.lang.String, java.util.Set<java.io.Serializable>)或addSerialObjsToSet(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键
返回:: Set<Object>集合（若不存在则返回空集，不会返回null）

delSerialObjsInSet

public long delSerialObjsInSet(String redisKey,
                               Serializable... objects)

 删除 Set<Serializable>集合中指定的值对象.
 配套addSerialSet(java.lang.String, java.util.Set<java.io.Serializable>)或addSerialObjsToSet(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键; objects - 期望被删除的值对象（需实现Serializable接口）
返回:: 成功从该集合中删除的值个数

existInSet

public boolean existInSet(String redisKey,
                          Serializable object)

 检测某个值对象是否在指定的 Set<Serializable>集合中.
 配套addSerialSet(java.lang.String, java.util.Set<java.io.Serializable>)或addSerialObjsToSet(java.lang.String, java.io.Serializable...)使用.

参数:: redisKey - 所操作对象在redis中的键; object - 被检测的值对象（需实现Serializable接口）
返回:: true:在集合中; false:不在集合中

getSetSize
```
public long getSetSize(String redisKey)
```
获取集合的大小

参数:

redisKey - 所操作对象在redis中的键

返回:

集合的大小

类 RedisClient

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_IP

DEFAULT_PORT

构造器详细资料

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

RedisClient

方法详细资料

isVaild

setAutoCommit

closeAutoCommit

commit

destory

close

clearAll

existKey

delKeys

addStrVal

appendStrVal

getStrVal

addSerialObj

getSerialObj

addStrMap

addStrValToMap

getStrMap

getStrValInMap

getStrValsInMap

getAllStrValsInMap

addSerialMap

addSerialObjToMap

getSerialMap

getSerialObjInMap

getSerialObjsInMap

getAllSerialObjsInMap

existKeyInMap

getAllKeysInMap

delKeysInMap

getMapSize

addStrList

addStrValsToList

addStrValsToListHead

addStrValsToListTail

getStrList

getStrValInList

getAllStrValsInList

delStrValsInList

delStrValsInList

addSerialList

addSerialObjsToList

addSerialObjsToListHead

addSerialObjsToListTail

delSerialObjsInList

delSerialObjsInList

getSerialList

getSerialObjInList