EhCache

Posted 2021-03-13 loveer

介绍

EhCache 是一个纯 Java 的进程内缓存框架，具有快速、精干等特点，是 Hibernate 中默认 CacheProvider。
Ehcache 是一种广泛使用的开源 Java 分布式缓存。主要面向通用缓存，Java EE 和轻量级容器。
它具有内存和磁盘存储，缓存加载器，缓存扩展，缓存异常处理程序，一个gzip缓存servlet过滤器，支持 REST 和 SOAP api 等特点。

ehcache 和 redis 比较

ehcache 直接在 jvm 虚拟机中缓存，速度快，效率高；但是缓存共享麻烦，集群分布式应用不方便。

redis 是通过 socket 访问到缓存服务，效率比 ehcache 低，比数据库要快很多，处理集群和分布式缓存方便，有成熟的方案。

如果是单个应用或者对缓存访问要求很高的应用，用 ehcache。

如果是大型系统，存在缓存共享、分布式部署、缓存内容很大的，建议用 redis。

配置文件

<?xml version="1.0" encoding="UTF-8"?>
<ehcache updateCheck="false" name="Cache">

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

    <defaultCache maxElementsInMemory="100"
                  eternal="false"
                  timeToIdleSeconds="180"
                  timeToLiveSeconds="360"
                  overflowToDisk="false"/>

    <cache name="postCaches"
           eternal="false"
           maxElementsOnDisk="999"
           maxElementsInMemory="50"
           overflowToDisk="true"
           timeToIdleSeconds="60"
           timeToLiveSeconds="120"
           memoryStoreEvictionPolicy="LRU"/>

    <cache name="userCaches"
           eternal="false"
           maxElementsOnDisk="999"
           maxElementsInMemory="50"
           overflowToDisk="true"
           timeToIdleSeconds="60"
           timeToLiveSeconds="120"
           memoryStoreEvictionPolicy="LRU"/>

</ehcache>

配置文件说明

diskStore

    path：指定磁盘存储的位置

defaultCache

    默认的缓存

cache

    自定的缓存，当自定的配置不满足实际情况时可以通过自定义（可以包含多个cache节点）。

    name：
        缓存的名称，可以通过指定名称获取指定的某个Cache对象。
    
    maxElementsInMemory：
        内存中允许存储的最大的元素个数，0代表无限个。
    
    clearOnFlush：
        内存数量最大时是否清除。
    
    eternal：
        设置缓存中对象是否为永久的，如果是，超时设置将被忽略，对象从不过期。
        根据存储数据的不同，例如一些静态不变的数据如省市区等可以设置为永不过时。
    
    timeToIdleSeconds：
        设置对象在失效前的允许闲置时间（单位：秒）。
        仅当eternal=false对象不是永久有效时使用，可选属性，默认值是0，也就是可闲置时间无穷大。
    
    timeToLiveSeconds：
        缓存数据的 生存时间（TTL），也就是一个元素从构建到消亡的最大时间间隔值，
        这只能在元素不是永久驻留时有效，如果该值是0就意味着元素可以停顿无穷长的时间。(和上面的两者取最小值)
    
    overflowToDisk：
        内存不足时，是否启用磁盘缓存。
    
    maxEntriesLocalDisk：
        当内存中对象数量达到maxElementsInMemory时，Ehcache将会对象写到磁盘中。
    
    maxElementsOnDisk：
        硬盘最大缓存个数。
    
    diskSpoolBufferSizeMB：
        这个参数设置DiskStore（磁盘缓存）的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区。
    
    diskPersistent：
        是否在VM重启时存储硬盘的缓存数据。默认值是false。
    
    diskExpiryThreadIntervalSeconds：
        磁盘失效线程运行时间间隔，默认是120秒。
    
    memoryStoreEvictionPolicy：
        当达到maxElementsInMemory限制时，Ehcache将会根据指定的策略去清理内存。默认策略是LRU（最近最少使用）。
        你可以设置为FIFO（先进先出）或是LFU（较少使用）。
        这里比较遗憾，Ehcache并没有提供一个用户定制策略的接口，仅仅支持三种指定策略，感觉做的不够理想。

Spring整合

<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
</dependency>


spring.xml

  <context:component-scan base-package="com.service"/>

  <!-- 启用缓存注解开关 -->
  <cache:annotation-driven cache-manager="cacheManager"/>

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


@Cacheable

@CachePut

@CacheEvict

Spring Boot整合

<!-- 开启 cache 缓存 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

<!-- ehcache 缓存 -->
<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
</dependency>


在Springboot配置文件中把ehcache.xml配置进去：

    spring:
      cache:
        #ehcache配置文件路径
        ehcache:
          config: classpath:/ehcache/ehcache.xml
        #指定缓存类型，可加可不加
        #type: ehcache


@EnableCaching

    高速缓存抽象不提供实际存储，并且依赖于由 org.springframework.cache.Cache 和 org.springframework.cache.CacheManager 接口实现的抽象。

    Spring Boot 根据实现自动配置合适的 CacheManager，只要缓存支持通过 @EnableCaching 注释启用即可。


用户操作 service 层

    一般情况下，我们在 Sercive 层进行对缓存的操作。

    @Cacheable : 
        Spring 在每次执行前都会检查 Cache 中是否存在相同 key 的缓存元素。
        如果存在就不再执行该方法，而是直接从缓存中获取结果进行返回，否则才会执行并将返回结果存入指定的缓存中。
    
    @CacheEvict : 
        清除缓存。
    
    @CachePut : 
        @CachePut 也可以声明一个方法支持缓存功能。
        使用 @CachePut 标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，
        而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。
    
    这三个方法中都有两个主要的属性：
        value 指的是 ehcache.xml 中的缓存策略空间。
        key 指的是缓存的标识，同时可以用 # 来引用参数。