RedissonClient 接口中文注释
接口概述
/**
* 访问所有 Redisson 对象的主接口，提供同步/异步操作界面
*
* @see RedissonReactiveClient 响应式客户端
* @see RedissonRxClient RxJava 客户端
*
* @author Nikita Koksharov
*/
public interface RedissonClient {
时间序列相关方法
/**
* 根据名称获取时间序列实例
*
* @param <V> 值类型
* @param <L> 标签类型
* @param name 实例名称
* @return RTimeSeries 对象
*/
<V, L> RTimeSeries<V, L> getTimeSeries(String name);
/**
* 根据名称获取时间序列实例，使用指定的编解码器处理值
*
* @param <V> 值类型
* @param <L> 标签类型
* @param name 实例名称
* @param codec 值的编解码器
* @return RTimeSeries 对象
*/
<V, L> RTimeSeries<V, L> getTimeSeries(String name, Codec codec);
/**
* 获取指定选项配置的时间序列实例
*
* @param <V> 值类型
* @param <L> 标签类型
* @param options 实例选项
* @return RTimeSeries 对象
*/
<V, L> RTimeSeries<V, L> getTimeSeries(PlainOptions options);
数据流相关方法
/**
* 根据名称获取流实例（要求 Redis 5.0.0 及以上版本）
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 流名称
* @return RStream 对象
*/
<K, V> RStream<K, V> getStream(String name);
/**
* 根据名称获取流实例，使用指定编解码器处理条目（要求 Redis 5.0.0 及以上版本）
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 流名称
* @param codec 条目的编解码器
* @return RStream 对象
*/
<K, V> RStream<K, V> getStream(String name, Codec codec);
/**
* 获取指定选项配置的流实例（要求 Redis 5.0.0 及以上版本）
*
* @param <K> 键类型
* @param <V> 值类型
* @param options 实例选项
* @return RStream 对象
*/
<K, V> RStream<K, V> getStream(PlainOptions options);
RediSearch 模块方法
/**
* 返回 RediSearch 模块的 API 接口
*
* @return RSearch 对象
*/
RSearch getSearch();
/**
* 返回 RediSearch 模块的 API 接口，使用指定编解码器处理属性值
*
* @param codec 条目的编解码器
* @return RSearch 对象
*/
RSearch getSearch(Codec codec);
/**
* 返回指定选项配置的 RediSearch 模块 API 接口
*
* @param options 实例选项
* @return RSearch 对象
*/
RSearch getSearch(OptionalOptions options);
速率限制器方法
/**
* 根据名称获取速率限制器实例
*
* @param name 速率限制器名称
* @return RateLimiter 对象
*/
RRateLimiter getRateLimiter(String name);
/**
* 获取指定选项配置的速率限制器实例
*
* @param options 实例选项
* @return RateLimiter 对象
*/
RRateLimiter getRateLimiter(CommonOptions options);
二进制流方法
/**
* 根据名称获取二进制流持有者实例
*
* @param name 二进制流名称
* @return BinaryStream 对象
*/
RBinaryStream getBinaryStream(String name);
/**
* 获取指定选项配置的二进制流持有者实例
*
* @param options 实例选项
* @return BinaryStream 对象
*/
RBinaryStream getBinaryStream(CommonOptions options);
地理空间方法
/**
* 根据名称获取地理空间项目持有者实例
*
* @param <V> 值类型
* @param name 对象名称
* @return Geo 对象
*/
<V> RGeo<V> getGeo(String name);
/**
* 根据名称获取地理空间项目持有者实例，使用指定编解码器处理地理成员
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return Geo 对象
*/
<V> RGeo<V> getGeo(String name, Codec codec);
/**
* 获取指定选项配置的地理空间项目持有者实例
*
* @param <V> 值类型
* @param options 实例选项
* @return Geo 对象
*/
<V> RGeo<V> getGeo(PlainOptions options);
集合缓存方法
/**
* 根据名称获取基于集合的缓存实例（支持带 TTL 值的值逐出）
*
* <p>如果不需要逐出，建议使用常规集合 {@link #getSet(String, Codec)}</p>
*
* @param <V> 值类型
* @param name 对象名称
* @return SetCache 对象
*/
<V> RSetCache<V> getSetCache(String name);
/**
* 根据名称获取基于集合的缓存实例，使用指定编解码器（支持带 TTL 值的值逐出）
*
* <p>如果不需要逐出，建议使用常规集合 {@link #getSet(String, Codec)}</p>
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return SetCache 对象
*/
<V> RSetCache<V> getSetCache(String name, Codec codec);
/**
* 获取指定选项配置的基于集合的缓存实例（支持带 TTL 值的值逐出）
*
* <p>如果不需要逐出，建议使用常规集合 {@link #getSet(PlainOptions)}</p>
*
* @param <V> 值类型
* @param options 实例选项
* @return SetCache 对象
*/
<V> RSetCache<V> getSetCache(PlainOptions options);
映射缓存方法（部分已弃用）
/**
* 根据名称获取基于映射的缓存实例，使用指定编解码器处理键值（支持条目逐出）
*
* <p>如果不需要逐出，建议使用常规映射 {@link #getMap(String, Codec)}</p>
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param codec 键值的编解码器
* @return MapCache 对象
*/
<K, V> RMapCache<K, V> getMapCache(String name, Codec codec);
/**
* （已弃用）根据名称获取基于映射的缓存实例，使用指定编解码器和选项
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param codec 键值的编解码器
* @param options 映射选项
* @return MapCache 对象
*/
@Deprecated
<K, V> RMapCache<K, V> getMapCache(String name, Codec codec, MapCacheOptions<K, V> options);
/**
* 获取指定选项配置的基于映射的缓存实例（支持条目逐出）
*
* <p>如果不需要逐出，建议使用常规映射 {@link #getMap(org.redisson.api.options.MapOptions)}</p>
*
* @param <K> 键类型
* @param <V> 值类型
* @param options 实例选项
* @return MapCache 对象
*/
<K, V> RMapCache<K, V> getMapCache(org.redisson.api.options.MapCacheOptions<K, V> options);
桶（单个值存储）方法
/**
* 根据名称获取对象持有者实例
*
* @param <V> 值类型
* @param name 对象名称
* @return Bucket 对象
*/
<V> RBucket<V> getBucket(String name);
/**
* 根据名称获取对象持有者实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return Bucket 对象
*/
<V> RBucket<V> getBucket(String name, Codec codec);
/**
* 获取指定选项配置的对象持有者实例
*
* @param <V> 值类型
* @param options 实例选项
* @return Bucket 对象
*/
<V> RBucket<V> getBucket(PlainOptions options);
批量桶操作方法
/**
* 返回批量操作 Bucket 对象的接口
*
* @return Buckets 对象
*/
RBuckets getBuckets();
/**
* 返回批量操作 Bucket 对象的接口，使用指定编解码器
*
* @param codec Bucket 对象的编解码器
* @return Buckets 对象
*/
RBuckets getBuckets(Codec codec);
/**
* 返回指定选项配置的批量操作 Bucket 对象的接口
*
* @param options 实例选项
* @return Buckets 对象
*/
RBuckets getBuckets(OptionalOptions options);
JSON 桶方法
/**
* 根据名称获取 JSON 数据持有者实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return JsonBucket 对象
*/
<V> RJsonBucket<V> getJsonBucket(String name, JsonCodec<V> codec);
/**
* 获取指定选项配置的 JSON 数据持有者实例
*
* @param <V> 值类型
* @param options 实例选项
* @return JsonBucket 对象
*/
<V> RJsonBucket<V> getJsonBucket(JsonBucketOptions<V> options);
超日志日志方法
/**
* 根据名称获取 HyperLogLog 实例
*
* @param <V> 值类型
* @param name 对象名称
* @return HyperLogLog 对象
*/
<V> RHyperLogLog<V> getHyperLogLog(String name);
/**
* 根据名称获取 HyperLogLog 实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return HyperLogLog 对象
*/
<V> RHyperLogLog<V> getHyperLogLog(String name, Codec codec);
/**
* 获取指定选项配置的 HyperLogLog 实例
*
* @param <V> 值类型
* @param options 实例选项
* @return HyperLogLog 对象
*/
<V> RHyperLogLog<V> getHyperLogLog(PlainOptions options);
列表方法
/**
* 根据名称获取列表实例
*
* @param <V> 值类型
* @param name 对象名称
* @return List 对象
*/
<V> RList<V> getList(String name);
/**
* 根据名称获取列表实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return List 对象
*/
<V> RList<V> getList(String name, Codec codec);
/**
* 获取指定选项配置的列表实例
*
* @param <V> 值类型
* @param options 实例选项
* @return List 对象
*/
<V> RList<V> getList(PlainOptions options);
列表多重映射方法
/**
* 根据名称获取基于列表的多重映射实例
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @return ListMultimap 对象
*/
<K, V> RListMultimap<K, V> getListMultimap(String name);
/**
* 根据名称获取基于列表的多重映射实例，使用指定编解码器
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param codec 键值的编解码器
* @return ListMultimap 对象
*/
<K, V> RListMultimap<K, V> getListMultimap(String name, Codec codec);
/**
* 获取指定选项配置的基于列表的多重映射实例
*
* @param <K> 键类型
* @param <V> 值类型
* @param options 实例选项
* @return ListMultimap 对象
*/
<K, V> RListMultimap<K, V> getListMultimap(PlainOptions options);
本地缓存映射方法（部分已弃用）
/**
* （已弃用）根据名称获取本地缓存映射实例，使用指定选项
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param options 本地映射选项
* @return LocalCachedMap 对象
*/
@Deprecated
<K, V> RLocalCachedMap<K, V> getLocalCachedMap(String name, LocalCachedMapOptions<K, V> options);
/**
* （已弃用）根据名称获取本地缓存映射实例，使用指定编解码器和选项
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param codec 键值的编解码器
* @param options 本地映射选项
* @return LocalCachedMap 对象
*/
@Deprecated
<K, V> RLocalCachedMap<K, V> getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K, V> options);
/**
* 获取指定选项配置的本地缓存映射实例
*
* @param <K> 键类型
* @param <V> 值类型
* @param options 实例选项
* @return LocalCachedMap 对象
*/
<K, V> RLocalCachedMap<K, V> getLocalCachedMap(org.redisson.api.options.LocalCachedMapOptions<K, V> options);
映射方法
/**
* 根据名称获取映射实例
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @return Map 对象
*/
<K, V> RMap<K, V> getMap(String name);
/**
* （已弃用）根据名称获取映射实例，使用指定选项
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param options 映射选项
* @return Map 对象
*/
@Deprecated
<K, V> RMap<K, V> getMap(String name, MapOptions<K, V> options);
/**
* 根据名称获取映射实例，使用指定编解码器处理键值
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param codec 键值的编解码器
* @return Map 对象
*/
<K, V> RMap<K, V> getMap(String name, Codec codec);
集合多重映射方法
/**
* 根据名称获取基于集合的多重映射实例
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @return SetMultimap 对象
*/
<K, V> RSetMultimap<K, V> getSetMultimap(String name);
/**
* 根据名称获取基于集合的多重映射实例，使用指定编解码器
*
* @param <K> 键类型
* @param <V> 值类型
* @param name 对象名称
* @param codec 键值的编解码器
* @return SetMultimap 对象
*/
<K, V> RSetMultimap<K, V> getSetMultimap(String name, Codec codec);
/**
* 获取指定选项配置的基于集合的多重映射实例
*
* @param <K> 键类型
* @param <V> 值类型
* @param options 实例选项
* @return SetMultimap 对象
*/
<K, V> RSetMultimap<K, V> getSetMultimap(PlainOptions options);
信号量方法
/**
* 根据名称获取信号量实例
*
* @param name 对象名称
* @return Semaphore 对象
*/
RSemaphore getSemaphore(String name);
/**
* 获取指定选项配置的信号量实例
*
* @param options 实例选项
* @return Semaphore 对象
*/
RSemaphore getSemaphore(CommonOptions options);
/**
* 根据名称获取可过期许可信号量实例（支持每个获取的许可设置租约时间）
*
* @param name 对象名称
* @return PermitExpirableSemaphore 对象
*/
RPermitExpirableSemaphore getPermitExpirableSemaphore(String name);
/**
* 获取指定选项配置的可过期许可信号量实例（支持每个获取的许可设置租约时间）
*
* @param options 实例选项
* @return PermitExpirableSemaphore 对象
*/
RPermitExpirableSemaphore getPermitExpirableSemaphore(CommonOptions options);
锁相关方法
/**
* 根据名称获取锁实例（实现非公平锁，不保证线程获取顺序）
*
* <p>为了在故障转移时提高可靠性，所有操作都会等待传播到所有 Redis 从节点</p>
*
* @param name 对象名称
* @return Lock 对象
*/
RLock getLock(String name);
/**
* 获取指定选项配置的锁实例（实现非公平锁，不保证线程获取顺序）
*
* <p>为了在故障转移时提高可靠性，所有操作都会等待传播到所有 Redis 从节点</p>
*
* @param options 实例选项
* @return Lock 对象
*/
RLock getLock(CommonOptions options);
/**
* 根据名称获取自旋锁实例（实现非公平锁，不使用发布/订阅机制）
*
* @param name 对象名称
* @return Lock 对象
*/
RLock getSpinLock(String name);
/**
* 根据名称获取自旋锁实例，使用指定退避选项
*
* @param name 对象名称
* @param backOff 退避选项
* @return Lock 对象
*/
RLock getSpinLock(String name, LockOptions.BackOff backOff);
读写锁方法
/**
* 根据名称获取读写锁实例
*
* <p>为了在故障转移时提高可靠性，所有操作都会等待传播到所有 Redis 从节点</p>
*
* @param name 对象名称
* @return Lock 对象
*/
RReadWriteLock getReadWriteLock(String name);
/**
* 获取指定选项配置的读写锁实例
*
* <p>为了在故障转移时提高可靠性，所有操作都会等待传播到所有 Redis 从节点</p>
*
* @param options 实例选项
* @return Lock 对象
*/
RReadWriteLock getReadWriteLock(CommonOptions options);
集合方法
/**
* 根据名称获取集合实例
*
* @param <V> 值类型
* @param name 对象名称
* @return Set 对象
*/
<V> RSet<V> getSet(String name);
/**
* 根据名称获取集合实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return Set 对象
*/
<V> RSet<V> getSet(String name, Codec codec);
/**
* 获取指定选项配置的集合实例
*
* @param <V> 值类型
* @param options 实例选项
* @return Set 对象
*/
<V> RSet<V> getSet(PlainOptions options);
有序集合方法
/**
* 根据名称获取有序集合实例（使用比较器排序对象）
*
* @param <V> 值类型
* @param name 对象名称
* @return SortedSet 对象
*/
<V> RSortedSet<V> getSortedSet(String name);
/**
* 根据名称获取有序集合实例，使用指定编解码器（使用比较器排序对象）
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return SortedSet 对象
*/
<V> RSortedSet<V> getSortedSet(String name, Codec codec);
/**
* 获取指定选项配置的有序集合实例（使用比较器排序对象）
*
* @param <V> 值类型
* @param options 实例选项
* @return SortedSet 对象
*/
<V> RSortedSet<V> getSortedSet(PlainOptions options);
带分数有序集合方法
/**
* 根据名称获取带分数的 Redis 有序集合实例（按对象分数排序）
*
* @param <V> 值类型
* @param name 对象名称
* @return ScoredSortedSet 对象
*/
<V> RScoredSortedSet<V> getScoredSortedSet(String name);
/**
* 根据名称获取带分数的 Redis 有序集合实例，使用指定编解码器（按对象分数排序）
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return ScoredSortedSet 对象
*/
<V> RScoredSortedSet<V> getScoredSortedSet(String name, Codec codec);
/**
* 获取指定选项配置的带分数 Redis 有序集合实例（按对象分数排序）
*
* @param <V> 值类型
* @param options 实例选项
* @return ScoredSortedSet 对象
*/
<V> RScoredSortedSet<V> getScoredSortedSet(PlainOptions options);
主题消息方法
/**
* 根据名称获取分片主题实例（消息传递给连接到相同主题的监听器）
*
* @param name 对象名称
* @return Topic 对象
*/
RShardedTopic getShardedTopic(String name);
/**
* 根据名称获取分片主题实例，使用指定编解码器处理消息
*
* @param name 对象名称
* @param codec 消息的编解码器
* @return Topic 对象
*/
RShardedTopic getShardedTopic(String name, Codec codec);
/**
* 获取指定选项配置的分片主题实例（消息传递给连接到相同主题的监听器）
*
* @param options 实例选项
* @return Topic 对象
*/
RShardedTopic getShardedTopic(PlainOptions options);
可靠主题方法
/**
* 根据名称获取可靠主题实例（每个实例分配专用 Redis 连接，要求 Redis 5.0.0 及以上版本）
*
* @param name 对象名称
* @return ReliableTopic 对象
*/
RReliableTopic getReliableTopic(String name);
/**
* 根据名称获取可靠主题实例，使用指定编解码器处理消息（要求 Redis 5.0.0 及以上版本）
*
* @param name 对象名称
* @param codec 消息的编解码器
* @return ReliableTopic 对象
*/
RReliableTopic getReliableTopic(String name, Codec codec);
/**
* 获取指定选项配置的可靠主题实例（每个实例分配专用 Redis 连接，要求 Redis 5.0.0 及以上版本）
*
* @param options 实例选项
* @return ReliableTopic 对象
*/
RReliableTopic getReliableTopic(PlainOptions options);
模式主题方法
/**
* 根据模式名称获取主题实例（支持通配符模式：h?llo、h*llo、h[ae]llo 等）
*
* @param pattern 主题模式
* @return PatterTopic 对象
*/
RPatternTopic getPatternTopic(String pattern);
/**
* 根据模式名称获取主题实例，使用指定编解码器处理消息（支持通配符模式）
*
* @param pattern 主题模式
* @param codec 消息的编解码器
* @return PatterTopic 对象
*/
RPatternTopic getPatternTopic(String pattern, Codec codec);
/**
* 获取满足模式名称和指定选项的主题实例（支持通配符模式）
*
* @param options 实例选项
* @return PatterTopic 对象
*/
RPatternTopic getPatternTopic(PatternTopicOptions options);
队列相关方法
/**
* 根据名称获取无界队列实例
*
* @param <V> 值类型
* @param name 对象名称
* @return 队列对象
*/
<V> RQueue<V> getQueue(String name);
/**
* 根据名称获取传输队列实例
*
* @param <V> 值类型
* @param name 对象名称
* @return TransferQueue 对象
*/
<V> RTransferQueue<V> getTransferQueue(String name);
/**
* 根据名称获取传输队列实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return TransferQueue 对象
*/
<V> RTransferQueue<V> getTransferQueue(String name, Codec codec);
/**
* 获取指定选项配置的传输队列实例
*
* @param <V> 值类型
* @param options 实例选项
* @return TransferQueue 对象
*/
<V> RTransferQueue<V> getTransferQueue(PlainOptions options);
延迟队列方法
/**
* 获取无界延迟队列实例（需附加到目标队列，所有元素插入时带传输延迟）
*
* @param <V> 值类型
* @param destinationQueue 目标队列
* @return 延迟队列对象
*/
<V> RDelayedQueue<V> getDelayedQueue(RQueue<V> destinationQueue);
环形缓冲区方法
/**
* 获取基于环形缓冲区的队列
*
* @param <V> 值类型
* @param name 对象名称
* @return RingBuffer 对象
*/
<V> RRingBuffer<V> getRingBuffer(String name);
/**
* 获取基于环形缓冲区的队列，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return RingBuffer 对象
*/
<V> RRingBuffer<V> getRingBuffer(String name, Codec codec);
/**
* 获取指定选项配置的基于环形缓冲区的队列
*
* @param <V> 值类型
* @param options 实例选项
* @return RingBuffer 对象
*/
<V> RRingBuffer<V> getRingBuffer(PlainOptions options);
优先级队列方法
/**
* 根据名称获取无界优先级队列实例（使用比较器排序对象）
*
* @param <V> 值类型
* @param name 对象名称
* @return 队列对象
*/
<V> RPriorityQueue<V> getPriorityQueue(String name);
/**
* 根据名称获取无界优先级队列实例，使用指定编解码器（使用比较器排序对象）
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 消息的编解码器
* @return 队列对象
*/
<V> RPriorityQueue<V> getPriorityQueue(String name, Codec codec);
原子操作方法
/**
* 根据名称获取原子长整型实例
*
* @param name 对象名称
* @return AtomicLong 对象
*/
RAtomicLong getAtomicLong(String name);
/**
* 获取指定选项配置的原子长整型实例
*
* @param options 实例选项
* @return AtomicLong 对象
*/
RAtomicLong getAtomicLong(CommonOptions options);
/**
* 根据名称获取原子双精度浮点型实例
*
* @param name 对象名称
* @return AtomicDouble 对象
*/
RAtomicDouble getAtomicDouble(String name);
/**
* 获取指定选项配置的原子双精度浮点型实例
*
* @param options 实例选项
* @return AtomicDouble 对象
*/
RAtomicDouble getAtomicDouble(CommonOptions options);
计数相关方法
/**
* 根据名称获取 LongAdder 实例
*
* @param name 对象名称
* @return LongAdder 对象
*/
RLongAdder getLongAdder(String name);
/**
* 获取指定选项配置的 LongAdder 实例
*
* @param options 实例选项
* @return LongAdder 对象
*/
RLongAdder getLongAdder(CommonOptions options);
/**
* 根据名称获取 DoubleAdder 实例
*
* @param name 对象名称
* @return LongAdder 对象
*/
RDoubleAdder getDoubleAdder(String name);
/**
* 获取指定选项配置的 DoubleAdder 实例
*
* @param options 实例选项
* @return LongAdder 对象
*/
RDoubleAdder getDoubleAdder(CommonOptions options);
倒计时 latch 方法
/**
* 根据名称获取 CountDownLatch 实例
*
* @param name 对象名称
* @return CountDownLatch 对象
*/
RCountDownLatch getCountDownLatch(String name);
/**
* 获取指定选项配置的 CountDownLatch 实例
*
* @param options 实例选项
* @return CountDownLatch 对象
*/
RCountDownLatch getCountDownLatch(CommonOptions options);
位集合方法
/**
* 根据名称获取位集合实例
*
* @param name 对象名称
* @return BitSet 对象
*/
RBitSet getBitSet(String name);
/**
* 获取指定选项配置的位集合实例
*
* @param options 实例选项
* @return BitSet 对象
*/
RBitSet getBitSet(CommonOptions options);
布隆过滤器方法
/**
* 根据名称获取布隆过滤器实例
*
* @param <V> 值类型
* @param name 对象名称
* @return BloomFilter 对象
*/
<V> RBloomFilter<V> getBloomFilter(String name);
/**
* 根据名称获取布隆过滤器实例，使用指定编解码器
*
* @param <V> 值类型
* @param name 对象名称
* @param codec 值的编解码器
* @return BloomFilter 对象
*/
<V> RBloomFilter<V> getBloomFilter(String name, Codec codec);
/**
* 获取指定选项配置的布隆过滤器实例
*
* @param <V> 值类型
* @param options 实例选项
* @return BloomFilter 对象
*/
<V> RBloomFilter<V> getBloomFilter(PlainOptions options);
ID 生成器方法
/**
* 根据名称获取 ID 生成器实例
*
* @param name 对象名称
* @return IdGenerator 对象
*/
RIdGenerator getIdGenerator(String name);
/**
* 获取指定选项配置的 ID 生成器实例
*
* @param options 实例选项
* @return IdGenerator 对象
*/
RIdGenerator getIdGenerator(CommonOptions options);
Redis 函数方法
/**
* 返回 Redis Function 特性的 API 接口
*
* @return function 对象
*/
RFunction getFunction();
/**
* 返回 Redis Function 特性的 API 接口，使用指定编解码器处理参数和结果
*
* @param codec 参数和结果的编解码器
* @return function 接口
*/
RFunction getFunction(Codec codec);
/**
* 返回指定选项配置的 Redis Function 特性 API 接口
*
* @param options 实例选项
* @return function 对象
*/
RFunction getFunction(OptionalOptions options);
脚本操作方法
/**
* 返回脚本操作对象
*
* @return Script 对象
*/
RScript getScript();
/**
* 返回脚本操作对象，使用指定编解码器处理参数和结果
*
* @param codec 参数和结果的编解码器
* @return Script 对象
*/
RScript getScript(Codec codec);
/**
* 返回指定选项配置的脚本操作对象
*
* @param options 实例选项
* @return Script 对象
*/
RScript getScript(OptionalOptions options);
执行器服务方法
/**
* 根据名称获取 ScheduledExecutorService 实例
*
* @param name 对象名称
* @return ScheduledExecutorService 对象
*/
RScheduledExecutorService getExecutorService(String name);
/**
* （已弃用）使用指定选项获取 ScheduledExecutorService 实例
*
* @param name 对象名称
* @param options 执行器选项
* @return ScheduledExecutorService 对象
*/
@Deprecated
RScheduledExecutorService getExecutorService(String name, ExecutorOptions options);
/**
* 根据名称获取 ScheduledExecutorService 实例，使用指定编解码器处理任务序列化
*
* @param name 对象名称
* @param codec 任务、请求和响应的编解码器
* @return ScheduledExecutorService 对象
*/
RScheduledExecutorService getExecutorService(String name, Codec codec);
远程服务方法（部分已弃用）
/**
* （已弃用）返回使用默认名称（redisson_remote_service）的远程操作对象
*
* @return RemoteService 对象
*/
@Deprecated
RRemoteService getRemoteService();
/**
* （已弃用）返回使用默认名称和指定编解码器的远程操作对象
*
* @param codec 响应和请求的编解码器
* @return RemoteService 对象
*/
@Deprecated
RRemoteService getRemoteService(Codec codec);
/**
* 返回使用指定名称前缀的远程操作对象
*
* @param name Redis 键前缀名称
* @return RemoteService 对象
*/
RRemoteService getRemoteService(String name);
事务与批处理方法
/**
* 创建具有 READ_COMMITTED 隔离级别的事务
*
* @param options 事务配置
* @return Transaction 对象
*/
RTransaction createTransaction(TransactionOptions options);
/**
* 创建批处理对象，可在之后以管道模式执行收集的命令组
*
* <p>参见 <a href="http://redis.io/topics/pipelining">http://redis.io/topics/pipelining</a></p>
*
* @param options 批处理配置
* @return Batch 对象
*/
RBatch createBatch(BatchOptions options);
键操作方法
/**
* 返回 Redis 键操作接口（每个 Redis/Redisson 对象关联自己的键）
*
* @return Keys 对象
*/
RKeys getKeys();
/**
* 返回指定选项配置的 Redis 键操作接口（每个对象关联自己的键）
*
* @return Keys 对象
*/
RKeys getKeys(KeysOptions options);
活对象服务方法
/**
* 返回用于存储 Java 对象的活对象服务
*
* @return LiveObjectService 对象
*/
RLiveObjectService getLiveObjectService();
/**
* 返回指定选项配置的活对象服务（用于存储 Java 对象）
*
* @return LiveObjectService 对象
*/
RLiveObjectService getLiveObjectService(LiveObjectOptions options);
响应式与 RxJava 客户端方法
/**
* 返回 RxJava 版本的 Redisson 实例
*
* @return redisson 实例
*/
RedissonRxClient rxJava();
/**
* 返回响应式版本的 Redisson 实例
*
* @return redisson 实例
*/
RedissonReactiveClient reactive();
关闭与配置方法
/**
* 关闭 Redisson 实例（不关闭 Redis 服务器）
*
* 等同于调用 shutdown(0, 2, TimeUnit.SECONDS);
*/
void shutdown();
/**
* 关闭 Redisson 实例（不关闭 Redis 服务器）
*
* 关闭前会确保在静默期内没有任务提交，静默期通常为几秒
*
* @param quietPeriod 静默期
* @param timeout 最大等待时间
* @param unit 时间单位
*/
void shutdown(long quietPeriod, long timeout, TimeUnit unit);
/**
* 获取 Redisson 实例创建时提供的配置（修改此对象不影响 Redisson 实例）
*
* @return Config 对象
*/
Config getConfig();
Redis 节点管理方法
/**
* 返回管理 Redis 节点的 API 接口
*
* @see RedisNodes#CLUSTER 集群模式
* @see RedisNodes#MASTER_SLAVE 主从模式
* @see RedisNodes#SENTINEL_MASTER_SLAVE 哨兵主从模式
* @see RedisNodes#SINGLE 单节点模式
*
* @param nodes Redis 节点 API 类
* @param <T> Redis 节点 API 类型
* @return Redis 节点 API 对象
*/
<T extends BaseRedisNodes> T getRedisNodes(RedisNodes<T> nodes);
状态检查方法
/**
* 判断 Redisson 实例是否已关闭
*
* @return 已关闭返回 true，否则返回 false
*/
boolean isShutdown();
/**
* 判断 Redisson 实例是否已开始关闭或已关闭
*
* @return 已开始关闭或已关闭返回 true，否则返回 false
*/
boolean isShuttingDown();
/**
* 返回 Redisson 实例的 ID
*
* @return 实例 ID
*/
String getId();
}
浙公网安备 33010602011771号