文章目录
上一章:redis主从+哨兵搭建
目的:搭建完主从后,整合到SpringBoot中,在实际项目中使用。
框架:ruoyi-vue-plus,基于该框架增加redis的主从+哨兵功能。
鸣谢:感谢狮佬的开源框架
一、yaml文件配置
里面用的节点以及哨兵都是 上一章:主从+哨兵搭建 的内容
spring.data:
redis:
sentinel:
master: mymaster
nodes:
- 10.8.8.177:8010
- 10.8.8.177:8011
- 10.8.8.177:8012
redisson:
# 线程池数量
threads: 16
# Netty线程池数量
nettyThreads: 32
# 哨兵配置
sentinelServerConfig:
idleConnectionTimeout: 10000
connectTimeout: 10000
timeout: 5000
retryAttempts: 3
retryInterval: 1000
# password: 1234
subscriptionsPerConnection: 200
clientName: ${ruoyi.name}
slaveConnectionMinimumIdleSize: 10
slaveConnectionPoolSize: 250
masterConnectionMinimumIdleSize: 5
masterConnectionPoolSize: 250
readMode: SLAVE
subscriptionMode: SLAVE
sentinelAddresses:
- redis://10.8.8.177:28010
- redis://10.8.8.177:28011
- redis://10.8.8.177:28012
masterName: "mymaster"
database: 0
# 发布和订阅连接池大小
subscriptionConnectionPoolSize: 50
二、RedissonProperties.class新增以下内容
2.1 增加哨兵内部类,在最下面加即可
@Data
@NoArgsConstructor
public static class SentinelServerConfig {
/**
* 客户端名称
*/
private String clientName;
/**
* 自定义的主节点名称,和哨兵配置文件一致
*/
private String masterName;
/**
* 连接空闲超时,单位:毫秒
*/
private int idleConnectionTimeout;
/**
* 命令等待超时,单位:毫秒。默认3000
*/
private int timeout;
/**
* 连接超时时间,默认10000毫秒
*/
private int connectTimeout;
/**
* 发送命令到redis,重试次数。默认:3次
*/
private int retryAttempts;
/**
* 重试命令间隔。默认1500毫秒
*/
private int retryInterval;
/**
* 密码.默认空
*/
private String password;
/**
* redis订阅限制。默认5
*/
private int subscriptionsPerConnection;
/**
* 哨兵地址
*/
private String[] sentinelAddresses;
/**
* 订阅通道最小连接池大小。默认24
*/
private int slaveConnectionMinimumIdleSize;
/**
* 从服务器连接池大小。默认64
*/
private int slaveConnectionPoolSize;
/**
* 主节点最小连接数大小,默认24
*/
private int masterConnectionMinimumIdleSize;
/**
* 主服务器连接池大小,默认64
*/
private int masterConnectionPoolSize;
/**
* 读操作节点类型。默认SLAVE(从)
*/
private ReadMode readMode;
/**
* 设置订阅操作的节点类型,默认MASTER(主)
*/
private SubscriptionMode subscriptionMode;
/**
* 发布和订阅连接池大小
*/
private int subscriptionConnectionPoolSize;
}
2.2 哨兵内部类作为属性
/**
* 主从+哨兵服务配置
*/
private SentinelServerConfig sentinelServerConfig;
2.3 整个文件
package org.dromara.common.redis.config.properties;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.redisson.config.ReadMode;
import org.redisson.config.SubscriptionMode;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Redisson 配置属性
*
* @author Lion Li
*/
@Data
@ConfigurationProperties(prefix = "redisson")
public class RedissonProperties {
/**
* redis缓存key前缀
*/
private String keyPrefix;
/**
* 线程池数量,默认值 = 当前处理核数量 * 2
*/
private int threads;
/**
* Netty线程池数量,默认值 = 当前处理核数量 * 2
*/
private int nettyThreads;
/**
* 单机服务配置
*/
private SingleServerConfig singleServerConfig;
/**
* 主从+哨兵服务配置
*/
private SentinelServerConfig sentinelServerConfig;
/**
* 集群服务配置
*/
private ClusterServersConfig clusterServersConfig;
@Data
@NoArgsConstructor
public static class SingleServerConfig {
/**
* 客户端名称
*/
private String clientName;
/**
* 最小空闲连接数
*/
private int connectionMinimumIdleSize;
/**
* 连接池大小
*/
private int connectionPoolSize;
/**
* 连接空闲超时,单位:毫秒
*/
private int idleConnectionTimeout;
/**
* 命令等待超时,单位:毫秒
*/
private int timeout;
/**
* 发布和订阅连接池大小
*/
private int subscriptionConnectionPoolSize;
}
@Data
@NoArgsConstructor
public static class ClusterServersConfig {
/**
* 客户端名称
*/
private String clientName;
/**
* master最小空闲连接数
*/
private int masterConnectionMinimumIdleSize;
/**
* master连接池大小
*/
private int masterConnectionPoolSize;
/**
* slave最小空闲连接数
*/
private int slaveConnectionMinimumIdleSize;
/**
* slave连接池大小
*/
private int slaveConnectionPoolSize;
/**
* 连接空闲超时,单位:毫秒
*/
private int idleConnectionTimeout;
/**
* 命令等待超时,单位:毫秒
*/
private int timeout;
/**
* 发布和订阅连接池大小
*/
private int subscriptionConnectionPoolSize;
/**
* 读取模式
*/
private ReadMode readMode;
/**
* 订阅模式
*/
private SubscriptionMode subscriptionMode;
}
@Data
@NoArgsConstructor
public static class SentinelServerConfig {
/**
* 客户端名称
*/
private String clientName;
/**
* 自定义的主节点名称,和哨兵配置文件一致
*/
private String masterName;
/**
* 连接空闲超时,单位:毫秒
*/
private int idleConnectionTimeout;
/**
* 命令等待超时,单位:毫秒。默认3000
*/
private int timeout;
/**
* 连接超时时间,默认10000毫秒
*/
private int connectTimeout;
/**
* 发送命令到redis,重试次数。默认:3次
*/
private int retryAttempts;
/**
* 重试命令间隔。默认1500毫秒
*/
private int retryInterval;
/**
* 密码.默认空
*/
private String password;
/**
* redis订阅限制。默认5
*/
private int subscriptionsPerConnection;
/**
* 哨兵地址
*/
private String[] sentinelAddresses;
/**
* 订阅通道最小连接池大小。默认24
*/
private int slaveConnectionMinimumIdleSize;
/**
* 从服务器连接池大小。默认64
*/
private int slaveConnectionPoolSize;
/**
* 主节点最小连接数大小,默认24
*/
private int masterConnectionMinimumIdleSize;
/**
* 主服务器连接池大小,默认64
*/
private int masterConnectionPoolSize;
/**
* 读操作节点类型。默认SLAVE(从)
*/
private ReadMode readMode;
/**
* 设置订阅操作的节点类型,默认MASTER(主)
*/
private SubscriptionMode subscriptionMode;
/**
* 发布和订阅连接池大小
*/
private int subscriptionConnectionPoolSize;
}
}
三、redisConfig.class配置
3.1 添加哨兵模式
在方法redissonCustomizer后添加代码块
// 哨兵模式
RedissonProperties.SentinelServerConfig sentinelServerConfig = redissonProperties.getSentinelServerConfig();
if (ObjectUtil.isNotNull(sentinelServerConfig)) {
config.useSentinelServers()
.setNameMapper(new KeyPrefixHandler(redissonProperties.getKeyPrefix()))
.setTimeout(sentinelServerConfig.getTimeout())
.setClientName(sentinelServerConfig.getClientName())
.setConnectTimeout(sentinelServerConfig.getConnectTimeout())
.setRetryAttempts(sentinelServerConfig.getRetryAttempts())
.setRetryInterval(sentinelServerConfig.getRetryInterval())
.setIdleConnectionTimeout(sentinelServerConfig.getIdleConnectionTimeout())
.setSubscriptionsPerConnection(sentinelServerConfig.getSubscriptionsPerConnection())
.setSubscriptionConnectionPoolSize(sentinelServerConfig.getSubscriptionConnectionPoolSize())
.setMasterName(sentinelServerConfig.getMasterName())
.setSlaveConnectionMinimumIdleSize(sentinelServerConfig.getSlaveConnectionMinimumIdleSize())
.setSlaveConnectionPoolSize(sentinelServerConfig.getSlaveConnectionPoolSize())
.setMasterConnectionMinimumIdleSize(sentinelServerConfig.getMasterConnectionMinimumIdleSize())
.setMasterConnectionPoolSize(sentinelServerConfig.getMasterConnectionPoolSize())
.setReadMode(sentinelServerConfig.getReadMode())
.setSubscriptionMode(sentinelServerConfig.getSubscriptionMode())
.addSentinelAddress(sentinelServerConfig.getSentinelAddresses());
log.info(String.valueOf(config));
}
3.3 整个文件
package org.dromara.common.redis.config;
import cn.hutool.core.util.ObjectUtil;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import lombok.extern.slf4j.Slf4j;
import org.dromara.common.core.utils.SpringUtils;
import org.dromara.common.redis.config.properties.RedissonProperties;
import org.dromara.common.redis.handler.KeyPrefixHandler;
import org.dromara.common.redis.handler.RedisExceptionHandler;
import org.redisson.client.codec.StringCodec;
import org.redisson.codec.CompositeCodec;
import org.redisson.codec.TypedJsonJacksonCodec;
import org.redisson.spring.starter.RedissonAutoConfigurationCustomizer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.core.task.VirtualThreadTaskExecutor;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.TimeZone;
/**
* redis配置
*
* @author Lion Li
*/
@Slf4j
@AutoConfiguration
@EnableConfigurationProperties(RedissonProperties.class)
public class RedisConfig {
@Autowired
private RedissonProperties redissonProperties;
@Bean
public RedissonAutoConfigurationCustomizer redissonCustomizer() {
return config -> {
JavaTimeModule javaTimeModule = new JavaTimeModule();
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(formatter));
javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(formatter));
ObjectMapper om = new ObjectMapper();
om.registerModule(javaTimeModule);
om.setTimeZone(TimeZone.getDefault());
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
// 指定序列化输入的类型,类必须是非final修饰的。序列化时将对象全类名一起保存下来
om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
TypedJsonJacksonCodec jsonCodec = new TypedJsonJacksonCodec(Object.class, om);
// 组合序列化 key 使用 String 内容使用通用 json 格式
CompositeCodec codec = new CompositeCodec(StringCodec.INSTANCE, jsonCodec, jsonCodec);
config.setThreads(redissonProperties.getThreads())
.setNettyThreads(redissonProperties.getNettyThreads())
// 缓存 Lua 脚本 减少网络传输(redisson 大部分的功能都是基于 Lua 脚本实现)
.setUseScriptCache(true)
.setCodec(codec);
if (SpringUtils.isVirtual()) {
config.setNettyExecutor(new VirtualThreadTaskExecutor("redisson-"));
}
RedissonProperties.SingleServerConfig singleServerConfig = redissonProperties.getSingleServerConfig();
if (ObjectUtil.isNotNull(singleServerConfig)) {
// 使用单机模式
config.useSingleServer()
//设置redis key前缀
.setNameMapper(new KeyPrefixHandler(redissonProperties.getKeyPrefix()))
.setTimeout(singleServerConfig.getTimeout())
.setClientName(singleServerConfig.getClientName())
.setIdleConnectionTimeout(singleServerConfig.getIdleConnectionTimeout())
.setSubscriptionConnectionPoolSize(singleServerConfig.getSubscriptionConnectionPoolSize())
.setConnectionMinimumIdleSize(singleServerConfig.getConnectionMinimumIdleSize())
.setConnectionPoolSize(singleServerConfig.getConnectionPoolSize());
}
// 集群配置方式 参考下方注释
RedissonProperties.ClusterServersConfig clusterServersConfig = redissonProperties.getClusterServersConfig();
if (ObjectUtil.isNotNull(clusterServersConfig)) {
config.useClusterServers()
//设置redis key前缀
.setNameMapper(new KeyPrefixHandler(redissonProperties.getKeyPrefix()))
.setTimeout(clusterServersConfig.getTimeout())
.setClientName(clusterServersConfig.getClientName())
.setIdleConnectionTimeout(clusterServersConfig.getIdleConnectionTimeout())
.setSubscriptionConnectionPoolSize(clusterServersConfig.getSubscriptionConnectionPoolSize())
.setMasterConnectionMinimumIdleSize(clusterServersConfig.getMasterConnectionMinimumIdleSize())
.setMasterConnectionPoolSize(clusterServersConfig.getMasterConnectionPoolSize())
.setSlaveConnectionMinimumIdleSize(clusterServersConfig.getSlaveConnectionMinimumIdleSize())
.setSlaveConnectionPoolSize(clusterServersConfig.getSlaveConnectionPoolSize())
.setReadMode(clusterServersConfig.getReadMode())
.setSubscriptionMode(clusterServersConfig.getSubscriptionMode());
}
// 哨兵模式
RedissonProperties.SentinelServerConfig sentinelServerConfig = redissonProperties.getSentinelServerConfig();
if (ObjectUtil.isNotNull(sentinelServerConfig)) {
config.useSentinelServers()
.setNameMapper(new KeyPrefixHandler(redissonProperties.getKeyPrefix()))
.setTimeout(sentinelServerConfig.getTimeout())
.setClientName(sentinelServerConfig.getClientName())
.setConnectTimeout(sentinelServerConfig.getConnectTimeout())
.setRetryAttempts(sentinelServerConfig.getRetryAttempts())
.setRetryInterval(sentinelServerConfig.getRetryInterval())
.setIdleConnectionTimeout(sentinelServerConfig.getIdleConnectionTimeout())
.setSubscriptionsPerConnection(sentinelServerConfig.getSubscriptionsPerConnection())
.setSubscriptionConnectionPoolSize(sentinelServerConfig.getSubscriptionConnectionPoolSize())
.setMasterName(sentinelServerConfig.getMasterName())
.setSlaveConnectionMinimumIdleSize(sentinelServerConfig.getSlaveConnectionMinimumIdleSize())
.setSlaveConnectionPoolSize(sentinelServerConfig.getSlaveConnectionPoolSize())
.setMasterConnectionMinimumIdleSize(sentinelServerConfig.getMasterConnectionMinimumIdleSize())
.setMasterConnectionPoolSize(sentinelServerConfig.getMasterConnectionPoolSize())
.setReadMode(sentinelServerConfig.getReadMode())
.setSubscriptionMode(sentinelServerConfig.getSubscriptionMode())
.addSentinelAddress(sentinelServerConfig.getSentinelAddresses());
log.info(String.valueOf(config));
}
log.info("初始化 redis 配置");
};
}
/**
* 异常处理器
*/
@Bean
public RedisExceptionHandler redisExceptionHandler() {
return new RedisExceptionHandler();
}
/**
* redis集群配置 yml
*
* --- # redis 集群配置(单机与集群只能开启一个另一个需要注释掉)
* spring.data:
* redis:
* cluster:
* nodes:
* - 192.168.0.100:6379
* - 192.168.0.101:6379
* - 192.168.0.102:6379
* # 密码
* password:
* # 连接超时时间
* timeout: 10s
* # 是否开启ssl
* ssl.enabled: false
*
* redisson:
* # 线程池数量
* threads: 16
* # Netty线程池数量
* nettyThreads: 32
* # 集群配置
* clusterServersConfig:
* # 客户端名称
* clientName: ${ruoyi.name}
* # master最小空闲连接数
* masterConnectionMinimumIdleSize: 32
* # master连接池大小
* masterConnectionPoolSize: 64
* # slave最小空闲连接数
* slaveConnectionMinimumIdleSize: 32
* # slave连接池大小
* slaveConnectionPoolSize: 64
* # 连接空闲超时,单位:毫秒
* idleConnectionTimeout: 10000
* # 命令等待超时,单位:毫秒
* timeout: 3000
* # 发布和订阅连接池大小
* subscriptionConnectionPoolSize: 50
* # 读取模式
* readMode: "SLAVE"
* # 订阅模式
* subscriptionMode: "MASTER"
*/
}
四、租户配置类修改:TenantConfig
4.1 在方法tenantRedissonCustomizer添加代码块
SentinelServersConfig sentinelServersConfig = ReflectUtils.invokeGetter(config, "sentinelServersConfig");
// 哨兵模式配置方式
if (ObjectUtil.isNotNull(sentinelServersConfig)) {
// 设置多租户 redis key前缀
sentinelServersConfig.setNameMapper(nameMapper);
ReflectUtils.invokeSetter(config, "sentinelServersConfig", sentinelServersConfig);
}
4.2 整个方法tenantRedissonCustomizer
@Bean
public RedissonAutoConfigurationCustomizer tenantRedissonCustomizer(RedissonProperties redissonProperties) {
return config -> {
TenantKeyPrefixHandler nameMapper = new TenantKeyPrefixHandler(redissonProperties.getKeyPrefix());
SingleServerConfig singleServerConfig = ReflectUtils.invokeGetter(config, "singleServerConfig");
if (ObjectUtil.isNotNull(singleServerConfig)) {
// 使用单机模式
// 设置多租户 redis key前缀
singleServerConfig.setNameMapper(nameMapper);
ReflectUtils.invokeSetter(config, "singleServerConfig", singleServerConfig);
}
ClusterServersConfig clusterServersConfig = ReflectUtils.invokeGetter(config, "clusterServersConfig");
// 集群配置方式 参考下方注释
if (ObjectUtil.isNotNull(clusterServersConfig)) {
// 设置多租户 redis key前缀
clusterServersConfig.setNameMapper(nameMapper);
ReflectUtils.invokeSetter(config, "clusterServersConfig", clusterServersConfig);
}
SentinelServersConfig sentinelServersConfig = ReflectUtils.invokeGetter(config, "sentinelServersConfig");
// 哨兵模式配置方式
if (ObjectUtil.isNotNull(sentinelServersConfig)) {
// 设置多租户 redis key前缀
sentinelServersConfig.setNameMapper(nameMapper);
ReflectUtils.invokeSetter(config, "sentinelServersConfig", sentinelServersConfig);
}
};
}
五、启动效果
可以看到,redis以及哨兵都已加载完成。