配置SpringBoot项目使用ehcache3并监听

在springboot中配置ehcache3，并开启Cache监听

一、在项目中启用ehcache3

1、在pom.xml中添加依赖

<dependency>
    <groupId>org.ehcache</groupId>
    <artifactId>ehcache</artifactId>
    <version>3.9.9</version>
</dependency>
<dependency>
    <groupId>javax.cache</groupId>
    <artifactId>cache-api</artifactId>
    <version>1.1.1</version>
</dependency>

添加starter-cache

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

2、添加配置文件ehcache3.xml

创建配置文件src\main\resources\ehcache3.xml，配置文件文件名可以改，此处命名为ehcache3.xml，并修改application.properties文件，加入缓存配置

spring.cache.jcache.config=classpath:/ehcache3.xml

3、完成配置文件配置项

修改ehcache3.xml文件内容，参考如下

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns='http://www.ehcache.org/v3'>
    <cache alias="foo">
        <key-type>java.lang.String</key-type>
        <resources>
            <heap unit="entries">2000</heap>
            <offheap unit="MB">500</offheap>
        </resources>
    </cache>

    <cache-template name="myDefaults">
        <key-type>java.lang.Long</key-type>
        <value-type>java.lang.String</value-type>
        <heap unit="entries">200</heap>
    </cache-template>

    <cache alias="bar" uses-template="myDefaults">
        <key-type>java.lang.Number</key-type>
    </cache>

    <cache alias="simpleCache" uses-template="myDefaults" />

    
    <cache alias="tasks">
        <key-type>java.lang.String</key-type>
        <value-type>java.lang.String</value-type>
        <expiry>
            <ttl unit="minutes">1</ttl>
        </expiry>
        <resources>
            <heap unit="kB">10</heap>
        </resources>
    </cache>
</config>

ehcache3采用了xml格式配置文件，可配置模板，可以为不同的key和value设置不同的cache，详情可参考官网配置

4、在项目中启用缓存

在启用的文件中加入@EnableCaching

@EnableCaching
@SpringBootApplication
public class Cache3Application {
    public static void main(String[] args) {
        SpringApplication.run(Cache3Application.class, args);
    }

}

二、在业务逻辑中使用缓存

可在业务逻辑中使用

• @Cacheable
• @CachePut
• @CacheEvict

等对缓存进行操作，如下代码所示

@GetMapping("/s/{key}")
@Cacheable(value="tasks",key="'s_' + #key")
public String search(@PathVariable String key){
    return "STR:" + key;
}

@GetMapping("/find")
@Cacheable(value="tasks",key="'findall_key'") // Add this
public String findAll() {
    log.info("findAll tasks");
    return "list";
}
@GetMapping("/put")
@CachePut(value="tasks",key="'findall_key'")
public String put() {
    log.info("put to cache");
    return "put()";
}

@GetMapping("/del")
@CacheEvict(value="tasks",key="'findall_key'")
public String delCache(){
    log.info("delCache...");
    return "delcache";
}

其中value为配置的缓存名称，key可以是一个字符串，也可以是参数变量，须放在key内部，注意其中引号的使用

三、配置缓存监听

1、实现一个监听类

在项目中添加一个监听器类，描述当事件发生时的处理，此处只是通过日志打印显示，代码如下

public class MyCacheListener implements CacheEventListener<String,String> {
    private static final Logger log = LoggerFactory.getLogger(MyCacheListener.class);

    public MyCacheListener() {
        log.info("MyCacheListener: init");
    }

    @Override
    public void onEvent(CacheEvent<extends String, extends String> cacheEvent) {
        log.info("'{}' : [{}] --> {}", cacheEvent.getType(), cacheEvent.getKey(), cacheEvent.getNewValue());
    }
}

2、配置监听

在ehcache3.xml中配置对缓存的监听，添加<listeners>部分，结果如下

<cache alias="tasks">
    <key-type>java.lang.String</key-type>
    <value-type>java.lang.String</value-type>
    <expiry>
        <ttl unit="minutes">1</ttl>
    </expiry>
    <listeners>
        <listener>
            <class>com.zhouf.cache3.listener.MyCacheListener</class>
            <event-firing-mode>ASYNCHRONOUS</event-firing-mode>
            <event-ordering-mode>ORDERED</event-ordering-mode>
            <events-to-fire-on>CREATED</events-to-fire-on>
            <events-to-fire-on>UPDATED</events-to-fire-on>
            <events-to-fire-on>EXPIRED</events-to-fire-on>
            <events-to-fire-on>REMOVED</events-to-fire-on>
        </listener>
    </listeners>
    <resources>
        <heap unit="kB">10</heap>
    </resources>
</cache>

其中描述了监听的配置，对哪些事件需要作响应，可参考官网文档