spring-boot-redis-cluster简单整合例子

冷不防 2022-05-12 06:38 272阅读 0赞

> 代码地址如下：  
> [http://www.demodashi.com/demo/13184.html][http_www.demodashi.com_demo_13184.html]

### 一、前言 ###

spring-boot项目整合redis很常见，Redis 一般上生产的时候都是以集群模式部署，也就是redis cluster。本demo以最干净简洁的方式整合spring-boot和redis cluster，方便需要的同学查阅。

### 二、项目结构 ###

![YFkV1GbKlq4b7S2Mdsf.png][]

### 三、整合过程 ###

本工程采用maven管理依赖，程序主框架采用spring-boot。

#### maven核心依赖 ####

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <version>1.5.1.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-redis</artifactId>
                <version>1.4.4.RELEASE</version>
            </dependency>

工程主要包括4部分：  
\- redis cluster配置类  
\- spring-boot主文件  
\- spring-boot配置文件  
\- 单元测试

#### redis cluster配置类 ####

1.  RedisClusterProperties  
    把配置文件`application.yml`中redis cluster的配置项，映射到java对象中，方便直接使用

@Configuration
    @ConfigurationProperties(prefix = "spring.redis.cluster")
    public class RedisClusterProperties { 
    
        //集群节点
        private List<String> nodes=new ArrayList<>();
    
        public List<String> getNodes() {
            return nodes;
        }
    
        public void setNodes(List<String> nodes) {
            this.nodes = nodes;
        }
    }

1.  RedisClusterConfig  
    redis cluster核心配置类，启动spring-boot项目的时候在这里实例化JedisCluster对象

@Bean
        public JedisCluster redisCluster(){
    
            Set<HostAndPort> nodes = new HashSet<>();
            for (String node:redisClusterProperties.getNodes()){
                String[] parts= StringUtils.split(node,":");
                Assert.state(parts.length==2, "redis node shoule be defined as 'host:port', not '" + Arrays.toString(parts) + "'");
                nodes.add(new HostAndPort(parts[0], Integer.valueOf(parts[1])));
            }
    
            return new JedisCluster(nodes);
        }

#### spring-boot主文件 ####

1.  ItcljApplication  
    spring-boot工程启动文件，里面就是main方法，用于启动项目，项目启动过程中会自动扫描`com.itclj`包下的所有类，扫描到`RedisClusterConfig`类的时候，由于`public JedisCluster redisCluster()`方法加了`@Bean`注解，spring会自动执行该方法实例化一个`JedisCluster`对象放入spring上下文，以后需要使用的时候在需要的类直接自动注入即可。

#### spring-boot配置文件 ####

1.  application.yml  
    配置redis集群服务器地址

spring:
      redis:
        cluster:
          nodes:
            - redis1.msxf.lotest:7000
            - redis1.msxf.lotest:7001
            - redis2.msxf.lotest:7002
            - redis2.msxf.lotest:7003
            - redis3.msxf.lotest:7004
            - redis3.msxf.lotest:7005

#### 单元测试 ####

1.  RedisTest  
    采用junit作为单元测试工具，启动单元测试spring-boot会初始化整个项目，构建上下文，在这个过程中JedisCluster也将被实例化放入spring-boot上下文中，在单元测试类中直接使用，调用其get()方法获取redis集群的数据。

在正式写业务逻辑的时候用法也是一样的，在需要的类里面自动注入`JedisCluster`即可，然后直接使用，进行redis的增删改查。

@Autowired
        private JedisCluster jedisCluster;
    
        @Test
        public void get(){
           System.out.println("=============="+jedisCluster.get("youqian-spread-sync-to-mysql-date"));
        }

### 四、运行代码 ###

在idea里面，进入单元测试类`RedisTest`选中get()方法，有单击鼠标，run即可。然后在控制台输出从redis cluster中获取到的数据了。  
![ZO08x44PHJkmPSEUEMB.jpg][]spring-boot-redis-cluster简单整合例子

> 代码地址如下：  
> [http://www.demodashi.com/demo/13184.html][http_www.demodashi.com_demo_13184.html]
> 
> 注：本文著作权归作者，由demo大师发表，拒绝转载，转载需要作者授权

[http_www.demodashi.com_demo_13184.html]: http://www.demodashi.com/demo/13184.html
[YFkV1GbKlq4b7S2Mdsf.png]: /images/20220512/3d0a769c5e6b443e9f7ba0527af9ae5b.png
[ZO08x44PHJkmPSEUEMB.jpg]: /images/20220512/9ca39ae549b74d42af3f08efaa89b8c8.png