SpringBoot 集群 Codis 配置: 使用 Jodis 实现 CodisConnectionFactory

使用 SpringBoot io.codis.jodis 实现配置集群 CodisConnectionFactory

本文将介绍如何使用 SpringBoot 的 io.codis.jodis 库实现配置集群 CodisConnectionFactory，并通过示例代码展示具体的实现步骤。

1. 添加 Jodis 依赖

首先，在项目的 pom.xml 文件中添加 Jodis 依赖：

<dependency>
    <groupId>io.codis</groupId>
    <artifactId>jodis</artifactId>
    <version>1.8.2</version>
</dependency>

2. 创建 CodisConnectionFactory 类

创建一个名为 CodisConnectionFactory 的类，继承 AbstractRedisConnectionFactory 并实现其抽象方法。该类负责建立与 Codis 集群的连接。

import io.codis.jodis.JedisResourcePool;
import io.codis.jodis.RoundRobinJedisPool;
import org.springframework.data.redis.connection.AbstractRedisConnectionFactory;
import org.springframework.data.redis.connection.RedisNode;
import org.springframework.data.redis.connection.RedisPassword;
import org.springframework.data.redis.connection.RedisSentinelConfiguration;
import org.springframework.data.redis.connection.jedis.JedisClientConfiguration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;

import java.time.Duration;
import java.util.HashSet;
import java.util.Set;

public class CodisConnectionFactory extends AbstractRedisConnectionFactory {

    private final JedisResourcePool jedisResourcePool;

    public CodisConnectionFactory(String zkAddress, String zkProxyDir, RedisSentinelConfiguration sentinelConfig) {
        Set<String> zkProxySet = new HashSet<>();
        zkProxySet.add(zkAddress);

        this.jedisResourcePool = RoundRobinJedisPool.create().curatorClient(zkProxySet, zkProxyDir, Duration.ofSeconds(5).toMillis()).build();
    }

    @Override
    protected JedisConnection doCreateRedisConnection() {
        return new JedisConnection(jedisResourcePool.getResource(), getConvertPipelineAndTxResults());
    }

    @Override
    protected JedisClientConfiguration applyProperties(JedisClientConfiguration.Builder builder) {
        return builder.build();
    }

    @Override
    public RedisSentinelConfiguration getSentinelConfiguration() {
        return null;
    }

    @Override
    public RedisPassword getPassword() {
        return null;
    }

    @Override
    public void setPassword(RedisPassword password) {
        // Do nothing
    }

    @Override
    public void setSentinelConfiguration(RedisSentinelConfiguration sentinelConfig) {
        // Do nothing
    }

    @Override
    public void setHostName(String hostName) {
        // Do nothing
    }

    @Override
    public void setPort(int port) {
        // Do nothing
    }

    @Override
    public void setNode(RedisNode node) {
        // Do nothing
    }

    @Override
    public void setDatabase(int database) {
        // Do nothing
    }
}

3. 配置 Codis 连接信息

在 application.properties 文件中配置 Codis 连接信息：

# Codis 配置
codis.zk-address=127.0.0.1:2181
codis.zk-proxy-dir=/jodis/codis-demo

4. 创建 CodisConnectionFactoryBean 类

创建一个名为 CodisConnectionFactoryBean 的类，用于创建 CodisConnectionFactory 的 Bean 实例。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisSentinelConfiguration;

@Configuration
public class CodisConnectionFactoryBean {

    @Value('${codis.zk-address}')
    private String zkAddress;

    @Value('${codis.zk-proxy-dir}')
    private String zkProxyDir;

    @Bean
    public CodisConnectionFactory codisConnectionFactory() {
        return new CodisConnectionFactory(zkAddress, zkProxyDir, null);
    }
}

5. 创建 RedisTemplate 实例

最后，使用 CodisConnectionFactory 创建 RedisTemplate 实例，并进行配置：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);

        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());

        return redisTemplate;
    }
}

至此，你已成功配置了 Codis 集群连接，并可以通过 RedisTemplate 对象进行操作。

注意

• 确保你的 Codis 集群已经正常运行，并配置了 ZooKeeper 地址和代理目录。
• 在实际应用中，你需要根据自己的需求进行相应的配置调整。
• 以上代码仅供参考，请根据自己的具体情况进行修改。