Spring Boot 2.x基礎教程：使用EhCache緩存集群

先思考一個場景，當我們使用了EhCache，在緩存過期之前可以有效的減少對數據庫的訪問，但是通常我們將應用部署在生產環境的時候，為了實現應用的高可用（有一臺機器掛了，應用還需要可用），肯定是會部署多個不同的進程去運行的，那么這種情況下，當有數據更新的時候，每個進程中的緩存都是獨立維護的，如果這些進程緩存同步機制，那么就存在因緩存沒有更新，而一直都用已經失效的緩存返回給用戶，這樣的邏輯顯然是會有問題的。所以，本文就來說說當使用EhCache的時候，如果來組建進程內緩存EnCache的集群以及配置配置他們的同步策略。

由于下面是組建集群的過程，務必采用多機的方式調試，避免不必要的錯誤發生。

#動手試試

本篇的實現將基于上一篇open in new window的基礎工程來進行。先來回顧下上一篇中的程序要素：

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，這個標簽主要用來定義緩存事件監聽的處理策略，它有以下這些參數用來設置緩存的同步策略：
• 新增了一個cacheManagerPeerProviderFactory標簽的配置，用來指定組建的集群信息和要同步的緩存信息，其中：

第三步：打包部署與啟動。打包沒啥大問題，主要緩存配置內容存在一定差異，所以在指定節點的模式下，需要單獨拿出來，然后使用啟動參數來控制讀取不同的配置文件。比如這樣：

-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. 啟動通過第三步說的命令參數，啟動兩個實例
2. 調用實例1的/create接口，創建一條數據
3. 調用實例1的/find接口，實例1緩存User，同時同步緩存信息給實例2，在實例1中會存在SQL查詢語句
4. 調用實例2的/find接口，由于緩存集群同步了User的信息，所以在實例2中的這次查詢也不會出現SQL語句

#進一步思考

上一篇open in new window發布的時候，公眾號上有網友留言問，數據更新之后怎么辦？

其實當構建了緩存集群之后，就比較好辦了。比如這里的例子，需要做兩件事：

1. save操作增加@CachePut注解，讓更新操作完成之后將結果再put到緩存中
2. 保證緩存事件監聽的replicateUpdates=true，這樣數據在更新之后可以保證復制到其他節點

這樣就可以防止緩存的臟數據了，但是這種方法還并不是很好，因為緩存集群的同步依然需要時間，會存在短暫的不一致。同時進程內的緩存要在每個實例上都占用，如果大量存儲的話始終不那么經濟。所以，很多時候進程內緩存不會作為主要的緩存手段。下一篇將具體說說，另一個更重要的緩存使用！

歡迎關注本系列教程：《Spring Boot 2.x基礎教程》

#參考資料

• EhCache 分布式緩存/緩存集群open in new window
• Java RMI:rmi Connection refused to host: 127.0.0.1異常解決open in new window

#代碼示例

本文的相關例子可以查看下面倉庫中的chapter5-3目錄：

• Github：https://github.com/dyc87112/SpringBoot-Learning/open in new window
• Gitee：https://gitee.com/didispace/SpringBoot-Learning/