SpringBoot2.1.X使用Redis連接池Lettuce踩坑

一、引言

　　近期項目頻繁部署不同測試環境，在搭建運行環境與部署項目過程中踩到了不少Redis的坑。項目是基於SpringBoot2.1.12，SpringBoot2.1.X集成jar包Spring-data-redis-start 使用Lettuce作為Redis連接池。

• SpringBoot1.x默認采用Jedis作為redis客戶端連接池。
• SpringBoot2.x，spring-data-redis 默認采用Lettuce作為redis客戶端驅動連接池。

二、踩坑場景

　　運行環境Redis集群中某個master節點不穩定連接不上，導致SpringBoot應用連接Redis報錯，報錯連接timeout。

三、解決方案

　　基於Spring-data-redis重寫RedisConnectionFactory Bean。需要設置“取消校驗集群節點的成員關系”：.validateClusterNodeMembership(false)。

1、redis配置

spring:
  redis:
    cluster:
      nodes:
      - ${redis.host.cluster} #redis集群ip-port
    password: ${redis.password}
    timeout: 5000 #連接超時時間
    lettuce:
      pool:
        max-active: 10 #連接池最大連接數
        max-wait: -1 #連接池最大阻塞時間
        max-idle: 5 #連接池中最大空閑連接
        min-idle: 1 #連接池中最小空閑連接
redis:
  cluster:
    enabled: true

2、Config配置類

@Data
@Component
@ConditionalOnProperty(name = "redis.cluster.enabled", havingValue = "true", matchIfMissing = false)
public class RedisConfig {
    @Autowired
    RedisProperties redisProperties;

    // 在構建LettuceConnectionFactory時，如果不使用內置的destroyMethod，可能會導致Redis連接早於其它Bean被銷毀
    @Bean(destroyMethod = "destroy")
    public RedisConnectionFactory newLettuceConnectionFactory() {
        // 配置用於開啟自適應刷新和定時刷新。如自適應刷新不開啟，Redis集群變更時將會導致連接異常
        ClusterTopologyRefreshOptions clusterTopologyRefreshOptions = ClusterTopologyRefreshOptions.builder()
                .enablePeriodicRefresh(Duration.ofSeconds(60))// 開啟周期刷新(默認60秒)
                .enableAdaptiveRefreshTriggers(RefreshTrigger.ASK_REDIRECT,RefreshTrigger.UNKNOWN_NODE)// 開啟自適應刷新
                .build();
        ClusterClientOptions clusterClientOptions = ClusterClientOptions.builder()
                                 .topologyRefreshOptions(clusterTopologyRefreshOptions)//拓撲刷新
                                 .disconnectedBehavior(ClientOptions.DisconnectedBehavior.REJECT_COMMANDS)
                                 .autoReconnect(true)
                                 .socketOptions(SocketOptions.builder().keepAlive(true).build())
　　　　　　　　　　　　　　　　       .validateClusterNodeMembership(false)// 取消校驗集群節點的成員關系
                                 .build();
        LettuceClientConfiguration clientConfig = LettuceClientConfiguration.builder()
                .clientOptions(clusterClientOptions)
                                .readFrom(ReadFrom.SLAVE_PREFERRED)
                                .build();
        return new LettuceConnectionFactory(getClusterConfiguration(), clientConfig);
    }
    
    private  RedisClusterConfiguration getClusterConfiguration() {
        RedisProperties.Cluster clusterProperties = redisProperties.getCluster();
        RedisClusterConfiguration config = new RedisClusterConfiguration(clusterProperties.getNodes());
        if (clusterProperties.getMaxRedirects() != null) {
            config.setMaxRedirects(clusterProperties.getMaxRedirects());
        }
        if (redisProperties.getPassword() != null) {
            config.setPassword(RedisPassword.of(redisProperties.getPassword()));
        }
        return config;
    }

}

注意：

RedisClusterConfiguration getClusterConfiguration()需要設置Password，不然SpringBoot啟動報認證錯誤：
“io.lettuce.core.RedisCommandExecutionException: NOAUTH Authentication required”。如下：

 另外，lettuce-core jar包版本不能過低，避免部分配置項無法支持，以上配置為lettuce-core-5.18.RELEASE.jar。