Ehcache 使用详解

Ehcache 使用
fantasylgd 发表于2010-11-17 16:34 浏览(29) 评论(0) 分类：技术文档      举报

自从Ehcache 到了1.2+的版本，就支持分布式缓存了

Spring + Hibernate的结构 ，ehcache的对这几个框架的支持较好，就采用这个缓存方案

下面是配置文件：

<ehcache>
<diskStore path="java.io.tmpdir" />

<defaultCache maxElementsInMemory="10000"
     eternal="false"
   timeToIdleSeconds="120"
   timeToLiveSeconds="120"
   overflowToDisk="true"
   maxElementsOnDisk="10000000"
   diskPersistent="false"
   diskExpiryThreadIntervalSeconds="120"
   memoryStoreEvictionPolicy="LRU" >
   </defaultCache>
<cache name="smapCache"
     maxElementsInMemory="10000"
     eternal="false"
   timeToIdleSeconds="3600"
   timeToLiveSeconds="3600"
   overflowToDisk="true"
   maxElementsOnDisk="10000000"
   diskPersistent="false"
   diskExpiryThreadIntervalSeconds="120"
   memoryStoreEvictionPolicy="LRU">
    </cache>

</ehcache>

下面是分布式缓存配置

<ehcache>
<diskStore path="java.io.tmpdir" />

<!——自动查找局域网中分布式的peer 。也可手工指定节点的地址的,如：peerDiscovery=manual,rmiUrls=//server1:40000/sampleCache1 ——>
<cacheManagerPeerProviderFactory
   class="net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory"
   properties="peerDiscovery=automatic, multicastGroupAddress=230.0.0.1, multicastGroupPort=4446" />

<cacheManagerPeerListenerFactory
   class="net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory" />

<defaultCache maxElementsInMemory="10000"
     eternal="false"
   timeToIdleSeconds="120"
   timeToLiveSeconds="120"
   overflowToDisk="true"
   maxElementsOnDisk="10000000"
   diskPersistent="false"
   diskExpiryThreadIntervalSeconds="120"
   memoryStoreEvictionPolicy="LRU" >
   </defaultCache>
<cache name="smapCache"
     maxElementsInMemory="10000"
     eternal="false"
   timeToIdleSeconds="3600"
   timeToLiveSeconds="3600"
   overflowToDisk="true"
   maxElementsOnDisk="10000000"
   diskPersistent="false"
   diskExpiryThreadIntervalSeconds="120"
   memoryStoreEvictionPolicy="LRU">
  <cacheEventListenerFactory
        class="net.sf.ehcache.distribution.RMICacheReplicatorFactory"/>
   </cache>

</ehcache>

必须属性：
name:设置缓存的名称，用于标志缓存,惟一
maxElementsInMemory:在内存中最大的对象数量
maxElementsOnDisk：在DiskStore中的最大对象数量，如为0，则没有限制
eternal：设置元素是否永久的，如果为永久，则timeout忽略
overflowToDisk：是否当memory中的数量达到限制后，保存到Disk

可选的属性：
timeToIdleSeconds：设置元素过期前的空闲时间
timeToLiveSeconds：设置元素过期前的活动时间
diskPersistent：是否disk store在虚拟机启动时持久化。默认为false
diskExpiryThreadIntervalSeconds:运行disk终结线程的时间，默认为120秒
memoryStoreEvictionPolicy：策略关于Eviction

缓存子元素：
cacheEventListenerFactory：注册相应的的缓存监听类，用于处理缓存事件，如put,remove,update,和expire
bootstrapCacheLoaderFactory:指定相应的BootstrapCacheLoader，用于在初始化缓存，以及自动设置。

spring配置：

    <!—— ehcache ——>
<bean id="cacheManager"
        class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
        <property name="configLocation"
            value="classpath:ehcache.xml">
        </property>
    </bean>

    <bean id="smapCacheBean" class="org.springframework.cache.ehcache.EhCacheFactoryBean">
        <property name="cacheManager" ref="cacheManager"></property>
        <property name="cacheName" value="smapCache"></property>
    </bean>

==============================================================================================

EHCache配置文件

<ehcache>

    <!--设置缓存文件 .data 的创建路径。如果该路径是 Java 系统参数，当前虚拟机会重新赋值。

          下面的参数这样解释：
user.home – 用户主目录
user.dir      – 用户当前工作目录
java.io.tmpdir – 默认临时文件路径

    -->
<diskStore path="java.io.tmpdir"/>

    <cache name="org.taha.cache.METHOD_CACHE"
maxElementsInMemory="300"             //设定内存中创建对象的最大值
                  eternal="false"                                                //设置元素（译注：内存中对象）是否永久驻留。如果是，将忽略超时限制且元素永不消亡
                  timeToIdleSeconds="500"                   //设置某个元素消亡前的停顿时间,也就是在一个元素消亡之前，两次访问时间的最大时间间隔值。这只能在元素不是永久驻留时有效（译注：如果对象永恒不灭，则设置该属性也无用）
                  timeToLiveSeconds="500"             //为元素设置消亡前的生存时间。也就是一个元素从构建到消亡的最大时间间隔值。这只能在元素不是永久驻留时有效
overflowToDisk="true"                  //设置当内存中缓存达到 maxInMemory 限制时元素是否可写到磁盘
/>
</ehcache>

参数详解：

maxElementsInMemory ：cache 中最多可以存放的元素的数量。如果放入cache中的元素超过这个数值，有两种情况：
1、若overflowToDisk的属性值为true，会将cache中多出的元素放入磁盘文件中。
2、若overflowToDisk的属性值为false，会根据memoryStoreEvictionPolicy的策略替换cache中原有的元素。
eternal ：意思是是否永驻内存。如果值是true，cache中的元素将一直保存在内存中，不会因为时间超时而丢失，所以在这个值为true的时候，timeToIdleSeconds和timeToLiveSeconds两个属性的值就不起作用了。
timeToIdleSeconds ：就是访问这个cache中元素的最大间隔时间。如果超过这个时间没有访问这个cache中的某个元素，那么这个元素将被从cache中清除。
timeToLiveSeconds : 这是cache中元素的生存时间。意思是从cache中的某个元素从创建到消亡的时间，从创建开始计时，当超过这个时间，这个元素将被从cache中清除。
overflowToDisk ：溢出是否写入磁盘。系统会根据标签<diskStore path="java.io.tmpdir"/> 中path的值查找对应的属性值，如果系统的java.io.tmpdir的值是 D:\temp，写入磁盘的文件就会放在这个文件夹下。文件的名称是cache的名称，后缀名的data。如：CACHE_FUNC.data。这个属性在解释maxElementsInMemory的时候也已经说过了。
diskExpiryThreadIntervalSeconds ：磁盘缓存的清理线程运行间隔
memoryStoreEvictionPolicy ：内存存储与释放策略。有三个值：
LRU －least recently used
LFU －least frequently used
FIFO－first in first out, the oldest element by creation time
diskPersistent ： 是否持久化磁盘缓存。当这个属性的值为true时，系统在初始化的时候会在磁盘中查找文件名为cache名称，后缀名为index的的文件，如 CACHE_FUNC.index 。这个文件中存放了已经持久化在磁盘中的cache的index，找到后把cache加载到内存。要想把cache真正持久化到磁盘，写程序时必须注意，在是用net.sf.ehcache.Cache的void put (Element element)方法后要使用void flush()方法。
以上时间值都是以秒作为单位的