Spring Boot 2.x基础教程：使用EhCache缓存集群

转载

limiyq 2020-09-09 20:51:07

文章标签 java 文章分类 Java 后端开发

https://mp.weixin.qq.com/s/yqXYnoupzc9Kx60rwkbCXA

上一篇我们介绍了在Spring Boot中整合EhCache的方法。既然用了ehcache，我们自然要说说它的一些高级功能，不然我们用默认的ConcurrentHashMap就好了。本篇不具体介绍EhCache缓存如何落文件、如何配置各种过期参数等常规细节配置，这部分内容留给读者自己学习，如果您不知道如何搞，可以看看这里的官方文档。

那么我们今天具体讲什么呢？先思考一个场景，当我们使用了EhCache，在缓存过期之前可以有效的减少对数据库的访问，但是通常我们将应用部署在生产环境的时候，为了实现应用的高可用（有一台机器挂了，应用还需要可用），肯定是会部署多个不同的进程去运行的，那么这种情况下，当有数据更新的时候，每个进程中的缓存都是独立维护的，如果这些进程缓存同步机制，那么就存在因缓存没有更新，而一直都用已经失效的缓存返回给用户，这样的逻辑显然是会有问题的。所以，本文就来说说当使用EhCache的时候，如果来组建进程内缓存EnCache的集群以及配置配置他们的同步策略。

由于下面是组建集群的过程，务必采用多机的方式调试，避免不必要的错误发生。

动手试试

本篇的实现将基于上一篇的基础工程来进行。先来回顾下上一篇中的程序要素：

User实体的定义

@Entity
@Data
@NoArgsConstructor
public class User {

    @Id
    @GeneratedValue
    private Long id;

    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
}

User实体的数据访问实现（涵盖了缓存注解）

@CacheConfig(cacheNames = "users")
public interface UserRepository extends JpaRepository<User, Long> {

    @Cacheable
    User findByName(String name);

}

下面开始改造这个项目：

第一步：为需要同步的缓存对象实现Serializable接口

@Entity
@Data
@NoArgsConstructor
public class User implements Serializable {

    @Id
    @GeneratedValue
    private Long id;

    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
}

注意：如果没有做这一步，后续缓存集群通过过程中，因为要传输User对象，会导致序列化与反序列化相关的异常

第二步：重新组织ehcache的配置文件。我们尝试手工组建集群的方式，不同实例在网络相关配置上会产生不同的配置信息，所以我们建立不同的配置文件给不同的实例使用。比如下面这样：

实例1，使用ehcache-1.xml

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="ehcache.xsd">

    <cache name="users"
           maxEntriesLocalHeap="200"
           timeToLiveSeconds="600">
        <cacheEventListenerFactory
                class="net.sf.ehcache.distribution.RMICacheReplicatorFactory"
                properties="replicateAsynchronously=true,
            replicatePuts=true,
            replicateUpdates=true,
            replicateUpdatesViaCopy=false,
            replicateRemovals=true "/>
    </cache>

    <cacheManagerPeerProviderFactory
            class="net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory"
            properties="hostName=10.10.0.100,
                        port=40001,
                        socketTimeoutMillis=2000,
                        peerDiscovery=manual,
                        rmiUrls=//10.10.0.101:40001/users" />

</ehcache>

实例2，使用ehcache-2.xml

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="ehcache.xsd">

    <cache name="users"
           maxEntriesLocalHeap="200"
           timeToLiveSeconds="600">
        <cacheEventListenerFactory
                class="net.sf.ehcache.distribution.RMICacheReplicatorFactory"
                properties="replicateAsynchronously=true,
            replicatePuts=true,
            replicateUpdates=true,
            replicateUpdatesViaCopy=false,
            replicateRemovals=true "/>
    </cache>

    <cacheManagerPeerProviderFactory
            class="net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory"
            properties="hostName=10.10.0.101,
                        port=40001,
                        socketTimeoutMillis=2000,
                        peerDiscovery=manual,
                        rmiUrls=//10.10.0.100:40001/users" />

</ehcache>

配置说明：

cache标签中定义名为users的缓存，这里我们增加了一个子标签定义cacheEventListenerFactory，这个标签主要用来定义缓存事件监听的处理策略，它有以下这些参数用来设置缓存的同步策略：
replicatePuts：当一个新元素增加到缓存中的时候是否要复制到其他的peers。默认是true。
replicateUpdates：当一个已经在缓存中存在的元素被覆盖时是否要进行复制。默认是true。
replicateRemovals：当元素移除的时候是否进行复制。默认是true。
replicateAsynchronously：复制方式是异步的指定为true时，还是同步的，指定为false时。默认是true。
replicatePutsViaCopy：当一个新增元素被拷贝到其他的cache中时是否进行复制指定为true时为复制，默认是true。
replicateUpdatesViaCopy：当一个元素被拷贝到其他的cache中时是否进行复制指定为true时为复制，默认是true。
新增了一个cacheManagerPeerProviderFactory标签的配置，用来指定组建的集群信息和要同步的缓存信息，其中：
hostName：是当前实例的主机名
port：当前实例用来同步缓存的端口号
socketTimeoutMillis：同步缓存的Socket超时时间
peerDiscovery：集群节点的发现模式，有手工与自动两种，这里采用了手工指定的方式
rmiUrls：当peerDiscovery设置为manual的时候，用来指定需要同步的缓存节点，如果存在多个用|连接

第三步：打包部署与启动。打包没啥大问题，主要缓存配置内容存在一定差异，所以在指定节点的模式下，需要单独拿出来，然后使用启动参数来控制读取不同的配置文件。比如这样：

-Dspring.cache.ehcache.config=classpath:ehcache-1.xml
-Dspring.cache.ehcache.config=classpath:ehcache-2.xml

第四步：实现几个接口用来验证缓存的同步效果

@RestController
static class HelloController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping("/create")    
    public void create() {
        userRepository.save(new User("AAA", 10));
    }

    @GetMapping("/find")
    public User find() {
        User u1 = userRepository.findByName("AAA");
        System.out.println("查询AAA用户：" + u1.getAge());
        return u1;
    }

}

验证逻辑：

启动通过第三步说的命令参数，启动两个实例调用实例1的/create接口，创建一条数据调用实例1的/find接口，实例1缓存User，同时同步缓存信息给实例2，在实例1中会存在SQL查询语句调用实例2的/find接口，由于缓存集群同步了User的信息，所以在实例2中的这次查询也不会出现SQL语句

进一步思考

上一篇发布的时候，公众号上有网友留言问，数据更新之后怎么办？

其实当构建了缓存集群之后，就比较好办了。比如这里的例子，需要做两件事：

save操作增加@CachePut注解，让更新操作完成之后将结果再put到缓存中保证缓存事件监听的replicateUpdates=true，这样数据在更新之后可以保证复制到其他节点这样就可以防止缓存的脏数据了，但是这种方法还并不是很好，因为缓存集群的同步依然需要时间，会存在短暂的不一致。同时进程内的缓存要在每个实例上都占用，如果大量存储的话始终不那么经济。所以，很多时候进程内缓存不会作为主要的缓存手段。下一篇将具体说说，另一个更重要的缓存使用！

欢迎关注本系列教程《Spring Boot 2.x基础教程》http://blog.didispace.com/spring-boot-learning-2x/

参考资料

EhCache 分布式缓存/缓存集群 https://www.cnblogs.com/hoojo/archive/2012/07/19/2599534.html
Java RMI:rmi Connection refused to host: 127.0.0.1异常解决 https://blog.csdn.net/chenchaofuck1/article/details/51558995

往期推荐尝鲜刚发布的 SpringFox 3.0.0，以前造的轮子可以不用了... 赠书：一本书揭开 Spring Boot 技术内幕开源：推荐一个不错的离线IP地址定位库 Spring Boot 2.x基础教程：EhCache缓存的使用厉害了，程序员的高考试卷，你能拿几分？面试：从volatile说到i++的线程安全问题

扫一扫，关注我一起学习，一起进步阅读原文