spring中配置缓存—ehcache

常用的缓存工具有ehcache、memcache和redis，这里介绍spring中ehcache的配置。

1.在pom添加依赖：

　　　　  <!-- ehcache 相关依赖 -->
        <dependency>
            <groupId>net.sf.ehcache</groupId>
            <artifactId>ehcache</artifactId>
            <version>2.8.2</version>
        </dependency>
 
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>

2.在applicationContext.xml添加命名空间：

xmlns:cache="http://www.springframework.org/schema/cache
 
http://www.springframework.org/schema/cache
http://www.springframework.org/schema/cache/spring-cache-3.1.xsd

3.在applicationContext.xml中配置ehcache：

　　 <!-- 缓存注解驱动(请将其配置在Spring主配置文件中) -->
    <cache:annotation-driven cache-manager="cacheManager" />  
 
    <!-- Spring提供的基于的Ehcache实现的缓存管理器 -->
    <bean id="ehCacheManagerFactory" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
        <!-- 指定配置文件的位置 -->
        <property name="configLocation" value="classpath:ehcache-setting.xml"></property>
    </bean>
    <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">
        <property name="cacheManager" ref="ehCacheManagerFactory"></property>
    </bean>

4.创建ehcache的配置文件ehcache-setting.xml：

<?xml version="1.0" encoding="UTF-8"?>
<ehcache>
    <!-- 指定一个文件目录，当EhCache把数据写到硬盘上时，将把数据写到这个文件目录下 -->
    <diskStore path="java.io.tmpdir"/>
 
    <!-- 默认缓存 -->
    <defaultCache
            maxElementsInMemory="10000"
            eternal="false"
            overflowToDisk="true"
            timeToIdleSeconds="10"
            timeToLiveSeconds="20"
            diskPersistent="false"
            diskExpiryThreadIntervalSeconds="120"/>
 
    <!-- 自定义缓存 -->
    <cache name="cacheTest"
        maxElementsInMemory="1000"
        eternal="false"
        overflowToDisk="true"
        timeToIdleSeconds="10"
        timeToLiveSeconds="20"/>
 
</ehcache>

这里我们配置了自定义缓存cacheTest，10秒过期。

cache元素的属性：

• name：缓存名称
• maxElementsInMemory：内存中最大缓存对象数
• maxElementsOnDisk：硬盘中最大缓存对象数，若是0表示无穷大
• eternal：true表示对象永不过期，此时会忽略timeToIdleSeconds和timeToLiveSeconds属性，默认为false
• overflowToDisk：true表示当内存缓存的对象数目达到了
• maxElementsInMemory界限后，会把溢出的对象写到硬盘缓存中。注意：如果缓存的对象要写入到硬盘中的话，则该对象必须实现了Serializable接口才行。
• diskSpoolBufferSizeMB：磁盘缓存区大小，默认为30MB。每个Cache都应该有自己的一个缓存区。
• diskPersistent：是否缓存虚拟机重启期数据，是否持久化磁盘缓存,当这个属性的值为true时,系统在初始化时会在磁盘中查找文件名 为cache名称,后缀名为index的文件，这个文件中存放了已经持久化在磁盘中的cache的index,找到后会把cache加载到内存，要想把 cache真正持久化到磁盘,写程序时注意执行net.sf.ehcache.Cache.put(Element element)后要调用flush()方法。
• diskExpiryThreadIntervalSeconds：磁盘失效线程运行时间间隔，默认为120秒
• timeToIdleSeconds： 设定允许对象处于空闲状态的最长时间，以秒为单位。当对象自从最近一次被访问后，如果处于空闲状态的时间超过了timeToIdleSeconds属性 值，这个对象就会过期，EHCache将把它从缓存中清空。只有当eternal属性为false，该属性才有效。如果该属性值为0，则表示对象可以无限 期地处于空闲状态
• timeToLiveSeconds：设定对象允许存在于缓存中的最长时间，以秒为单位。当对象自从被存放到缓存中后，如果处于缓存中的时间超过了 timeToLiveSeconds属性值，这个对象就会过期，EHCache将把它从缓存中清除。只有当eternal属性为false，该属性才有 效。如果该属性值为0，则表示对象可以无限期地存在于缓存中。timeToLiveSeconds必须大于timeToIdleSeconds属性，才有意义
• memoryStoreEvictionPolicy：当达到maxElementsInMemory限制时，Ehcache将会根据指定的策略去清理内存。可选策略有：LRU（最近最少使用，默认策略）、FIFO（先进先出）、LFU（最少访问次数）。

5.在业务类wdSolrService中使用缓存注解@Cacheable：

    @Cacheable(value = "cacheTest", key = "#param")
    public String getTimestamp(String param) {
        Long timestamp = System.currentTimeMillis();
        return timestamp.toString();
    }

这里注解中value=”cacheTest”与ehcache-setting.xml中的cache名称属性值一致。

6.测试缓存效果：

    @Test
    public void main() throws InterruptedException {
        System.out.println("第一次调用：" + wdSolrService.getTimestamp("param"));
        Thread.sleep(2000);
        System.out.println("2秒之后调用：" + wdSolrService.getTimestamp("param"));
        Thread.sleep(11000);
        System.out.println("再过11秒缓存过期之后调用：" + wdSolrService.getTimestamp("param"));
    }

测试结果：

@Cacheable、@CachePut、@CacheEvict 注释介绍

主要作用：

• @Cacheable 主要针对方法配置，能够根据方法的请求参数对其结果进行缓存
• @CachePut 主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和 @Cacheable 不同的是，它每次都会触发真实方法的调用
• @CachEvict 主要针对方法配置，能够根据一定的条件对缓存进行清空

主要属性介绍：

• value：缓存的名称，在 spring 配置文件中定义，必须指定至少一个。例如：@Cacheable(value=”mycache”) 或者 @Cacheable(value={”cache1”,”cache2”}
• key：缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合。例如：@Cacheable(value=”testcache”,key=”#userName”)
• condition：缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存。例如：@Cacheable(value=”testcache”,condition=”#userName.length()>2”)
• allEntries：是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存。例如：@CachEvict(value=”testcache”,allEntries=true)
• beforeInvocation：是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存。例如：@CachEvict(value=”testcache”，beforeInvocation=true)

参考：

注释驱动的 Spring cache 缓存介绍

Spring+EhCache缓存实例