Redisson官方文档 - 2. 配置方法-优快云博客

本文详细介绍了Redisson的配置方法，包括程序化配置、JSON和YAML文件配置、Spring XML配置，涉及集群、云托管、哨兵和主从模式的设置，涵盖线程池、连接池、超时时间、负载均衡算法等关键参数，旨在帮助用户灵活地管理和优化Redisson连接。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

2.1. 程序化配置方法

Redisson程序化的配置方法是通过构建Config对象实例来实现的。例如：

Config config = new Config();
config.setTransportMode(TransportMode.EPOLL);
config.useClusterServers()
      //可以用"rediss://"来启用SSL连接
      .addNodeAddress("redis://127.0.0.1:7181");

2.2. 文件方式配置

Redisson既可以通过用户提供的JSON或YAML格式的文本文件来配置，也可以通过含有Redisson专有命名空间的，Spring框架格式的XML文本文件来配置。

2.2.1 通过JSON或YAML格式配置

Redisson的配置文件可以是JSON格式或YAML格式。
可以通过调用Config.fromJSON方法并指定一个File实例来实现读取JSON格式的配置：

Config config = Config.fromJSON(new File("config-file.json"));
RedissonClient redisson = Redisson.create(config);

调用Config.toJSON方法可以将一个Config配置实例序列化为一个含有JSON数据类型的字符串：

Config config = new Config();
// ... 省略许多其他的设置
String jsonFormat = config.toJSON();

也通过调用config.fromYAML方法并指定一个File实例来实现读取YAML格式的配置：

Config config = Config.fromYAML(new File("config-file.yaml"));
RedissonClient redisson = Redisson.create(config);

调用config.toYAML方法可以将一个Config配置实例序列化为一个含有YAML数据类型的字符串：

Config config = new Config();
// ... 省略许多其他的设置
String jsonFormat = config.toYAML();

2.2.2 通过Spring XML命名空间配置

Redisson为Spring框架提供了一套通过命名空间来配置实例的方式。

一个Redisson的实例可以通过这样的方式来配置：

<redisson:client>
    <redisson:single-server ... />
    <!-- 或者 -->
    <redisson:master-slave-servers ... />
    <!-- 或者 -->
    <redisson:sentinel-servers ... />
    <!-- 或者 -->
    <redisson:cluster-servers ... />
    <!-- 或者 -->
    <redisson:replicated-servers ... />
</redisson:client>

更多的使用方法请前往第三方框架整合文档了解。有关各种连接方式的详细配置请继续本文阅读。

2.3. 常用设置

以下是关于org.redisson.Config类的配置参数，它适用于所有Redis组态模式（单机，集群和哨兵）

codec（编码）

默认值: org.redisson.codec.JsonJacksonCodec

Redisson的对象编码类是用于将对象进行序列化和反序列化，以实现对该对象在Redis里的读取和存储。Redisson提供了以下几种的对象编码应用，以供大家选择：

编码类名称	说明
`org.redisson.codec.JsonJacksonCodec`	Jackson JSON 编码默认编码
`org.redisson.codec.AvroJacksonCodec`	Avro 一个二进制的JSON编码
`org.redisson.codec.SmileJacksonCodec`	Smile 另一个二进制的JSON编码
`org.redisson.codec.CborJacksonCodec`	CBOR 又一个二进制的JSON编码
`org.redisson.codec.MsgPackJacksonCodec`	MsgPack 再来一个二进制的JSON编码
`org.redisson.codec.IonJacksonCodec`	Amazon Ion 亚马逊的Ion编码，格式与JSON类似
`org.redisson.codec.KryoCodec`	Kryo 二进制对象序列化编码
`org.redisson.codec.SerializationCodec`	JDK序列化编码
`org.redisson.codec.FstCodec`	FST 10倍于JDK序列化性能而且100%兼容的编码
`org.redisson.codec.LZ4Codec`	LZ4 压缩型序列化对象编码
`org.redisson.codec.SnappyCodec`	Snappy 另一个压缩型序列化对象编码
`org.redisson.client.codec.JsonJacksonMapCodec`	基于Jackson的映射类使用的编码。可用于避免序列化类的信息，以及用于解决使用`byte[]`遇到的问题。
`org.redisson.client.codec.StringCodec`	纯字符串编码（无转换）
`org.redisson.client.codec.LongCodec`	纯整长型数字编码（无转换）
`org.redisson.client.codec.ByteArrayCodec`	字节数组编码
`org.redisson.codec.CompositeCodec`	用来组合多种不同编码在一起

threads（线程池数量）

默认值: 当前处理核数量 * 2

这个线程池数量被所有RTopic对象监听器，RRemoteService调用者和RExecutorService任务共同共享。

nettyThreads （Netty线程池数量）

默认值: 当前处理核数量 * 2

这个线程池数量是在一个Redisson实例内，被其创建的所有分布式数据类型和服务，以及底层客户端所一同共享的线程池里保存的线程数量。

executor（线程池）

单独提供一个用来执行所有RTopic对象监听器，RRemoteService调用者和RExecutorService任务的线程池（ExecutorService）实例。

eventLoopGroup

用于特别指定一个EventLoopGroup. EventLoopGroup是用来处理所有通过Netty与Redis服务之间的连接发送和接受的消息。每一个Redisson都会在默认情况下自己创建管理一个EventLoopGroup实例。因此，如果在同一个JVM里面可能存在多个Redisson实例的情况下，采取这个配置实现多个Redisson实例共享一个EventLoopGroup的目的。

只有io.netty.channel.epoll.EpollEventLoopGroup或io.netty.channel.nio.NioEventLoopGroup才是允许的类型。

transportMode（传输模式）

默认值：TransportMode.NIO

可选参数：
TransportMode.NIO,
TransportMode.EPOLL - 需要依赖里有netty-transport-native-epoll包（Linux）
TransportMode.KQUEUE - 需要依赖里有 netty-transport-native-kqueue包（macOS）

lockWatchdogTimeout（监控锁的看门狗超时，单位：毫秒）

默认值：30000

监控锁的看门狗超时时间单位为毫秒。该参数只适用于分布式锁的加锁请求中未明确使用leaseTimeout参数的情况。如果该看门口未使用lockWatchdogTimeout去重新调整一个分布式锁的lockWatchdogTimeout超时，那么这个锁将变为失效状态。这个参数可以用来避免由Redisson客户端节点宕机或其他原因造成死锁的情况。

keepPubSubOrder（保持订阅发布顺序）

默认值：true

通过该参数来修改是否按订阅发布消息的接收顺序出来消息，如果选否将对消息实行并行处理，该参数只适用于订阅发布消息的情况。

performanceMode（高性能模式）

默认值：HIGHER_THROUGHPUT

用来指定高性能引擎的行为
该参数仅限于Redisson PRO版本。

可选模式：
HIGHER_THROUGHPUT - 将高性能引擎切换到 高通量 模式。
LOWER_LATENCY - 将高性能引擎切换到 低延时 模式。

2.4. 集群模式

集群模式除了适用于Redis集群环境，也适用于任何云计算服务商提供的集群模式，例如AWS ElastiCache集群版、Azure Redis Cache和阿里云（Aliyun）的云数据库Redis版。

程序化配置集群的用法:

Config config = new Config();
config.useClusterServers()
    .setScanInterval(2000) // 集群状态扫描间隔时间，单位是毫秒
    //可以用"rediss://"来启用SSL连接
    .addNodeAddress("redis://127.0.0.1:7000", "redis://127.0.0.1:7001")
    .addNodeAddress("redis://127.0.0.1:7002");

RedissonClient redisson = Redisson.create(config);

2.4.1. 集群设置

介绍配置Redis集群组态的文档在这里。 Redis集群组态的最低要求是必须有三个主节点。Redisson的集群模式的使用方法如下：

ClusterServersConfig clusterConfig = config.useClusterServers();

ClusterServersConfig 类的设置参数如下：

nodeAddresses（添加节点地址）

可以通过host:port的格式来添加Redis集群节点的地址。多个节点可以一次性批量添加。

scanInterval（集群扫描间隔时间）

默认值： 1000

对Redis集群节点状态扫描的时间间隔。单位是毫秒。

readMode（读取操作的负载均衡模式）

默认值： SLAVE（只在从服务节点里读取）

注：在从服务节点里读取的数据说明已经至少有两个节点保存了该数据，确保了数据的高可用性。

设置读取操作选择节点的模式。
可用值为：
SLAVE - 只在从服务节点里读取。
MASTER - 只在主服务节点里读取。
MASTER_SLAVE - 在主从服务节点里都可以读取。

subscriptionMode（订阅操作的负载均衡模式）

默认值：SLAVE（只在从服务节点里订阅）

设置订阅操作选择节点的模式。
可用值为：
SLAVE - 只在从服务节点里订阅。
MASTER - 只在主服务节点里订阅。

loadBalancer（负载均衡算法类的选择）

默认值： org.redisson.connection.balancer.RoundRobinLoadBalancer

在多Redis服务节点的环境里，可以选用以下几种负载均衡方式选择一个节点：
org.redisson.connection.balancer.WeightedRoundRobinBalancer - 权重轮询调度算法
org.redisson.connection.balancer.RoundRobinLoadBalancer - 轮询调度算法
org.redisson.connection.balancer.RandomLoadBalancer - 随机调度算法