连接模式
Redis 可以在多种部署形态下运行。每种运行模式都需要特定的配置,后续章节会逐一说明。
Redis 独立节点 {#redis:standalone}
最简单的入门方式是使用单台 Redis 服务器的 Redis 独立节点,
如下例所示,配置 LettuceConnectionFactory 或 JedisConnectionFactory:
@Configuration
class RedisStandaloneConfiguration {
/**
* Lettuce
*/
@Bean
public RedisConnectionFactory lettuceConnectionFactory() {
return new LettuceConnectionFactory(new RedisStandaloneConfiguration("server", 6379));
}
/**
* Jedis
*/
@Bean
public RedisConnectionFactory jedisConnectionFactory() {
return new JedisConnectionFactory(new RedisStandaloneConfiguration("server", 6379));
}
}
写主节点,读副本 {#redis:write-to-master-read-from-replica}
@Configuration
class WriteToMasterReadFromReplicaConfiguration {
@Bean
public LettuceConnectionFactory redisConnectionFactory() {
LettuceClientConfiguration clientConfig = LettuceClientConfiguration.builder()
.readFrom(REPLICA_PREFERRED)
.build();
RedisStandaloneConfiguration serverConfig = new RedisStandaloneConfiguration("server", 6379);
return new LettuceConnectionFactory(serverConfig, clientConfig);
}
}
对于通过 INFO 命令上报非公开地址的环境(例如使用 AWS 时),请使用 RedisStaticMasterReplicaConfiguration 而非 RedisStandaloneConfiguration。请注意,由于缺少跨各服务器的 Pub/Sub 消息传播,RedisStaticMasterReplicaConfiguration 不支持 Pub/Sub。
Redis Sentinel {#redis:sentinel}
为处理高可用 Redis,Spring Data Redis 通过 RedisSentinelConfiguration 支持 Redis Sentinel,如下例所示:
/**
* Lettuce
*/
@Bean
public RedisConnectionFactory lettuceConnectionFactory() {
RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration()
.master("mymaster")
.sentinel("127.0.0.1", 26379)
.sentinel("127.0.0.1", 26380);
return new LettuceConnectionFactory(sentinelConfig);
}
/**
* Jedis
*/
@Bean
public RedisConnectionFactory jedisConnectionFactory() {
RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration()
.master("mymaster")
.sentinel("127.0.0.1", 26379)
.sentinel("127.0.0.1", 26380);
return new JedisConnectionFactory(sentinelConfig);
}
RedisSentinelConfiguration 也可以通过 RedisSentinelConfiguration.of(PropertySource) 定义,它让你可以读取以下属性:
配置属性
spring.redis.sentinel.master:主节点的名称。spring.redis.sentinel.nodes:以逗号分隔的 host:port 对列表。spring.redis.sentinel.username:向 Redis Sentinel 认证时使用的用户名(需要 Redis 6)。spring.redis.sentinel.password:向 Redis Sentinel 认证时使用的密码。spring.redis.sentinel.dataNode.username:向 Redis 数据节点认证时使用的用户名。spring.redis.sentinel.dataNode.password:向 Redis 数据节点认证时使用的密码。spring.redis.sentinel.dataNode.database:向 Redis 数据节点认证时使用的数据库索引。
有时需要直接与其中某个 Sentinel 交互。使用 RedisConnectionFactory.getSentinelConnection() 或 RedisConnection.getSentinelCommands() 即可访问所配置的第一个活动 Sentinel。
Redis Cluster
集群支持基于与非集群通信相同的构建块。RedisClusterConnection 是 RedisConnection 的扩展,负责处理与 Redis Cluster 的通信,并把错误转换为 Spring DAO 异常体系。RedisClusterConnection 实例由 RedisConnectionFactory 创建,而后者必须用相关的 RedisClusterConfiguration 来配置,如下例所示:
示例 1:用于 Redis Cluster 的 RedisConnectionFactory 配置示例
@Component
@ConfigurationProperties(prefix = "spring.redis.cluster")
public class ClusterConfigurationProperties {
/*
* spring.redis.cluster.nodes[0] = 127.0.0.1:7379
* spring.redis.cluster.nodes[1] = 127.0.0.1:7380
* ...
*/
List<String> nodes;
/**
* Get initial collection of known cluster nodes in format {@code host:port}.
*
* @return
*/
public List<String> getNodes() {
return nodes;
}
public void setNodes(List<String> nodes) {
this.nodes = nodes;
}
}
@Configuration
public class AppConfig {
/**
* Type safe representation of application.properties
*/
@Autowired ClusterConfigurationProperties clusterProperties;
public @Bean RedisConnectionFactory connectionFactory() {
return new LettuceConnectionFactory(
new RedisClusterConfiguration(clusterProperties.getNodes()));
}
}
RedisClusterConfiguration 也可以通过 RedisClusterConfiguration.of(PropertySource) 定义,它让你可以读取以下属性:
配置属性
spring.redis.cluster.nodes:以逗号分隔的 host:port 对列表。spring.redis.cluster.max-redirects:允许的集群重定向次数。
初始配置将驱动库指向一组初始的集群节点。由实时集群重配置产生的变更只保存在原生驱动中,不会回写到配置中。