SpringBoot2.x系列教程72--SpringBoot整合Hazelcast实现分布式缓存

灰太狼 2023-10-07 14:06 24阅读 0赞

### **一. 分布式缓存代码实现步骤** ###

#### **1. 创建web项目** ####

我们按照之前的经验，创建一个web程序，并将之改造成Spring Boot项目，具体过程略。

![format_png][]

#### **2. 添加依赖包** ####

<dependency>
        <groupId>com.hazelcast</groupId>
        <artifactId>hazelcast</artifactId>
    </dependency>
    <dependency>
        <groupId>com.hazelcast</groupId>
        <artifactId>hazelcast-spring</artifactId>
    </dependency>

#### **3. 创建application.yml配置文件** ####

创建application.yml配置文件，可以在这里设置服务器端口号。

server:
      port: 8081

#### **4. 添加Hazelcast配置类** ####

package com.yyg.boot.config;
    
    import com.hazelcast.config.*;
    import com.hazelcast.core.Hazelcast;
    import com.hazelcast.core.HazelcastInstance;
    import com.hazelcast.core.IMap;
    import com.hazelcast.core.ITopic;
    import com.yyg.boot.interceptor.IMapInterceptor;
    import com.yyg.boot.interceptor.MapListener;
    import com.yyg.boot.interceptor.TopicListener;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * @Author 一一哥Sun
     * @Date Created in 2020/4/23
     * @Description Description
     */
    @Configuration
    public class HazelcastConfiguration {
    
        @Bean
        public Config hazelCastConfig() {
            Config config = new Config();
            //解决同网段下，不同库项目
            GroupConfig gc=new GroupConfig("hazelGroup");
            config.setInstanceName("hazelcast-instance")
                    .addMapConfig(new MapConfig()
                                    .setName("configuration")
                                    // Map中存储条目的最大值[0~Integer.MAX_VALUE]。默认值为0。
                                    .setMaxSizeConfig(new MaxSizeConfig(200, MaxSizeConfig.MaxSizePolicy.FREE_HEAP_SIZE))
                                     //数据释放策略[NONE|LRU|LFU]。这是Map作为缓存的一个参数，用于指定数据的回收算法。默认为NONE。LRU：“最近最少使用“策略。
                                    .setEvictionPolicy(EvictionPolicy.LRU)
                                    //数据留存时间[0~Integer.MAX_VALUE]。缓存相关参数，单位秒，默认为0。
                                    .setTimeToLiveSeconds(-1))
                                    .setGroupConfig(gc);
            return config;
        }
    }

#### **关于配置说明** ####

#### **eviction-policy** ####

> *数据释放策略\[NONE|LRU|LFU\]。这是Map作为缓存的一个参数，用于指定数据的回收算法，默认为NONE。*

*  *NONE：当设置为NONE时，不会发生数据回收，同时max-size会失效。但是任然可以使用time-to-live-seconds和max-idle-seconds参数来控制数据留存时间。*
 *  *LRU：“最近最少使用“策略。*
 *  *LFU：“最不常用的使用”策略。*

#### **time-to-live-seconds（TTL）** ####

> *数据留存时间\[0~Integer.MAX\_VALUE\]。缓存相关参数，单位秒，默认为0。这个参数决定了一条数据在map中的停留时间。当数据在Map中留存超过这个时间并且没有被更新时，它会根据指定的回收策略从Map中移除。值为0时，意味着无求大。*

#### **4. 创建Controller接口方法** ####

package com.yyg.boot.web;
    
    import com.hazelcast.core.HazelcastInstance;
    import com.hazelcast.core.IList;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.*;
    
    import java.util.Map;
    import java.util.Queue;
    
    /**
     * @Author 一一哥Sun
     * @Date Created in 2020/4/23
     * @Description Description
     */
    @Slf4j
    @RestController
    @RequestMapping("/hazelcast")
    public class HazelcastController {
    
        @Autowired
        private HazelcastInstance hazelcastInstance;
    
        @PostMapping(value = "/save")
        public String saveMapData(@RequestParam String key, @RequestParam String value) {
            Map<String, String> hazelcastMap = hazelcastInstance.getMap("hazelcastMap");
            hazelcastMap.put(key, value);
            return "success";
        }
    
        @GetMapping(value = "/get")
        public String getMapData(@RequestParam String key) {
            Map<String, String> hazelcastMap = hazelcastInstance.getMap("hazelcastMap");
            return hazelcastMap.get(key);
        }
    
        @GetMapping(value = "/all")
        public Map<String, String> readAllDataFromHazelcast() {
            return hazelcastInstance.getMap("hazelcastMap");
        }
    
        @GetMapping(value = "/list")
        public String saveList(@RequestParam(required = false) String value) {
            // 创建集群List
            IList<Object> clusterList = hazelcastInstance.getList("myList");
            clusterList.add(value);
            return "success";
        }
    
        @GetMapping(value = "/showList")
        public IList<Object> showList() {
            return hazelcastInstance.getList("myList");
        }
    
        @GetMapping(value = "/clearList")
        public String clearList() {
            IList<Object> clusterList = hazelcastInstance.getList("myList");
            clusterList.clear();
            return "success";
        }
    
        @GetMapping(value = "/queue")
        public String saveQueue(@RequestParam String value) {
            // 创建集群Queue
            Queue<String> clusterQueue = hazelcastInstance.getQueue("myQueue");
            clusterQueue.offer(value);
            return "success";
        }
    
        @GetMapping(value = "/showQueue")
        public Queue<String> showQueue() {
            Queue<String> clusterQueue = hazelcastInstance.getQueue("myQueue");
            for (String obj : clusterQueue) {
                log.warn("value=" + obj);
            }
            return clusterQueue;
        }
    
        @GetMapping(value = "/clearQueue")
        public String clearQueue() {
            Queue<String> clusterQueue = hazelcastInstance.getQueue("myQueue");
            clusterQueue.clear();
            return "success";
        }
    
    }

#### **5. 创建入口类** ####

package com.yyg.boot;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /**
     * @Author 一一哥Sun
     * @Date Created in 2020/4/23
     * @Description Description
     */
    @SpringBootApplication
    public class HazelcastApplication {
    
        public static void main(String[] args){
            SpringApplication.run(HazelcastApplication.class,args);
        }
    
    }

#### **6. 启动项目进行测试** ####

#### **6.1 启动集群** ####

**运行解析:**

程序启动时，控制台会输出如下信息：

[hazelGroup] [3.12.6] Prefer IPv4 stack is true, prefer IPv6 addresses is false
    2020-04-24 11:37:45.790  INFO 5820 --- com.hazelcast.instance.AddressPicker     
    [hazelGroup] [3.12.6] Picked [192.168.87.102]:5702, using socket ServerSocket[addr=/0:0:0:0:0:0:0:0,localport=5702], bind any local is true

> *这一段输出说明了当前 Hazelcast 的网络环境。首先是检测IPv4可用且检查到当前的IPv4地址是192.168.87.102。然后使用IPv6启用socket。在某些无法使用IPv6的环境上，需要强制指定使用IPv4，增加jvm启动参数：-Djava.net.preferIPv4Stack=true 即可。*

[192.168.87.102]:5702 [hazelGroup] [3.12.6] Hazelcast 3.12.6 (20200130 - be02cc5) starting at [192.168.87.102]:5702
    com.hazelcast.system                     : [192.168.87.102]:5702 [hazelGroup] [3.12.6] Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved.

> *这一段输出说明了当前实例的初始化端口号是5701。Hazelcast 默认使用5701端口。如果发现该端口被占用，会+1查看5702是否可用，如果还是不能用会继续向后探查直到5800。Hazelcast 默认使用5700到5800的端口，如果都无法使用会抛出启动异常。*

我们先在8081端口上进行启动，在控制台会发现此时Members数量只有1，个，Hazelcast运行在5701端口上。

![format_png 1][]

然后我们在8082端口上，再次启动第2个进程。此时在控制台，会发现Members数量变成了2个，意味着一个新的Hazelcast实例加入到了集群中。

![format_png 2][]

> *Members\[2\]表示当前集群只有2个节点，2个节点都在ip为192.168.87.102的这台设备上，2个节点分别占据了5701端口和5702端口。端口后面的this说明这是当前节点，而未标记this的是其他接入集群的节点。*

由此可见，Hazelcast实现集群非常的简单，会自动把不同进程添加到集群中。

#### **6.2 测试map结构** ####

我们先在8081端口的进程上存储一个数据到map中。

![format_png 3][]

然后我们在8081上取数据，会发现数据已经获取到了。

![format_png 4][]

然后我们在8082端口的进程上获取数据，发现同样也可以获取到之前存储的数据。说明在Hazelcast中只要在一个服务器节点上存储了数据，就可以自动实现从其他集群节点中获取到另一个节点中存储的数据。

![format_png 5][]

#### **6.3 测试list结构** ####

我们先在8081端口的进程上存储一个数据到list中。

![format_png 6][]

然后我们在8082上取数据，会发现数据已经获取到了。

![format_png 7][]

同样的实现了集群数据共享。

#### **6.4 测试queue结构** ####

我们先在8081端口的进程上存储一个数据到queue中。

![format_png 8][]

然后我们在8082上取数据，会发现数据已经获取到了。

![format_png 9][]

同样的实现了集群数据共享。

#### **7. 添加Hazelcast监听器配置** ####

我们在上面的HazelcastConfiguration配置类中添加一些监听器类。

@Bean
    public HazelcastInstance hazelcastInstance(Config config) {
        HazelcastInstance hzInstance = Hazelcast.newHazelcastInstance(config);
        //分布式map监听
        IMap<Object, Object> imap = hzInstance.getMap("hazelcastMap");
        imap.addLocalEntryListener(new MapListener());
        //拦截器（没写内容）
        imap.addInterceptor(new IMapInterceptor());
        //发布/订阅模式
        ITopic<String> topic = hzInstance.getTopic("hazelcastTopic");
        topic.addMessageListener(new TopicListener());
    
        return hzInstance;
    }

此时完整的HazelcastConfiguration类代码为：

#### **8. 重新启动8081和8082进程测试** ####

此时我们可以8081进程的map结构中添加一个新的key与value，如下所示：

![format_png 10][]

然后在控制台可以看到我们之前Map结构的监听器类中，打印的log输出如下：

![format_png 11][]

说明我们的IMap的拦截器生效了。而且8082进程中也获取到了存储的age值。

![format_png 12][]

因为Hazelcast是集群的，数据可以在许多应用程序实例之间共享。

#### **9. 完整项目结构** ####

![format_png 13][]

### **二. hazelcast管理终端** ###

hazelcast其实提供了一个管理中心程序，可以帮助我们查看hazelcast中缓存的数据，当然这个管理中心可以不用安装，它只是帮我们查看缓存状态的一个工具而已。

#### **1. 下载hazelcast管理中心** ####

[https://hazelcast.org/download/archives/\#management-center][https_hazelcast.org_download_archives_management-center]

![format_png 14][]

#### **2. 解压之后，进入根目录进行启动。** ####

![format_png 15][]

#### **3. 启动start.bat命令** ####

![format_png 16][]

#### **4. 打开管理中心mancenter。** ####

一开始会要求先注册一个管理员用户，密码需要8位以上，然后进行登录。

![format_png 17][]

![format_png 18][]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi02YWViZGRhZmQ5ODQ5YjcwNGY1Njg3YmI2YWRkYjNiNV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi1hYjk5NDg5MzRjYjg0ODkyYzY0ZDEzNjkxYWJmMjE4OV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi02MTExNDE3MjdiZjBkYzM3Y2IwNGU4MDQ5NjcxNTgxOV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMzLnpoaW1nLmNvbS84MC92Mi04N2FkMzdkOGViMWY2Y2VmZDYyN2M2ZjkxODhhZTUwMl83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi0xZmVkYjZkNzdlNjVjMzM0YTA4MWFmYmM4YzFiMzg1NV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMzLnpoaW1nLmNvbS84MC92Mi1kZDA0NGY5ODJhNjQ5MzU5NDNjM2YzNmUzMWIwNDEwZV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMzLnpoaW1nLmNvbS84MC92Mi1iNTI1MGZiMDY1Njk2NzZjZjU2NmE0MDI5OGNlYjExYV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMxLnpoaW1nLmNvbS84MC92Mi0zYzhjNWMwYTA3MGIzMGY0MTg4ZjRmNWY1NmYzZjEwNF83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWM0LnpoaW1nLmNvbS84MC92Mi02N2VjMTUyMmQzNTYzZjQ5Yjc5OTI4MWZiNmY0OTJkM183MjB3LmpwZw?x-oss-process=image/format,png
[format_png 9]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi1hMmRjYTVhNjQ0ZThmOTM1NTgwMThiNGRhOTRlMmI2OV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 10]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi1jYmUyNTVjNzkyN2U2MGIwYTllMWVlOWY3MTJkMTdmZF83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMzLnpoaW1nLmNvbS84MC92Mi1iOTA4NjE3ODZjNzAyN2M3M2I0NjM3MjNiN2ExOTk0Nl83MjB3LnBuZw?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWM0LnpoaW1nLmNvbS84MC92Mi1iOWMxMmVjMGE0MDUwZDBmMDJkMmJkYjdhMzQzYWQ3N183MjB3LmpwZw?x-oss-process=image/format,png
[format_png 13]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWM0LnpoaW1nLmNvbS84MC92Mi0zNTRlYjg1NTlhYTg4ZWE3OTRiMTM5OGZjYzczMDZiZl83MjB3LmpwZw?x-oss-process=image/format,png
[https_hazelcast.org_download_archives_management-center]: https://link.zhihu.com/?target=https%3A//hazelcast.org/download/archives/%23management-center
[format_png 14]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMxLnpoaW1nLmNvbS84MC92Mi1kMDJmNzU3OGU5MzQ4YzI1NzhkZTBkMmRmNWIzZTM3NF83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 15]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWM0LnpoaW1nLmNvbS84MC92Mi0zODRhOTViZjllNTc0ZjI2ODAxNzBhY2U0NzVhMTNjYl83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 16]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi01YjRiNTAzZmJjZjdhZWY2MTQyYzBkYjJmOGVjNTllOV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 17]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWM0LnpoaW1nLmNvbS84MC92Mi1iYmJiNDk1ZjEwYWI4OTY4ODFjNGQyY2YzYzhkNTJhN183MjB3LmpwZw?x-oss-process=image/format,png
[format_png 18]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMzLnpoaW1nLmNvbS84MC92Mi0zMjhiYjhiYjZlN2FkZTU5ZDQzNjI3ZGFiOTZjZDM3Nl83MjB3LmpwZw?x-oss-process=image/format,png