详解springboot整合ehcache实现缓存机制

ehcache 是一个纯java的进程内缓存框架，具有快速、精干等特点，是hibernate中默认的cacheprovider。

ehcache提供了多种缓存策略，主要分为内存和磁盘两级，所以无需担心容量问题。

spring-boot是一个快速的集成框架，其设计目的是用来简化新spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。

由于spring-boot无需任何样板化的配置文件，所以spring-boot集成一些其他框架时会有略微的不同。

1.spring-boot是一个通过maven管理的jar包的框架，集成ehcache需要的依赖如下

 <dependency>
  <groupid>org.springframework</groupid>
   <artifactid>spring-context-support</artifactid>
</dependency>
<dependency>
     <groupid>net.sf.ehcache</groupid>
   <artifactid>ehcache</artifactid>
     <version>2.8.3</version>
</dependency> 

具体pom.xml文件如下

<?xml version="1.0" encoding="utf-8"?>
<project xmlns="http://maven.apache.org/pom/4.0.0" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
  xsi:schemalocation="http://maven.apache.org/pom/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelversion>4.0.0</modelversion>

  <groupid>com.lclc.boot</groupid>
  <artifactid>boot-cache</artifactid>
  <version>0.0.1-snapshot</version>
  <!-- inherit defaults from spring boot -->
  <parent>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-parent</artifactid>
    <version>1.1.3.release</version>
  </parent>
  <dependencies>
    <dependency>
      <groupid>org.springframework.boot</groupid>
      <artifactid>spring-boot-starter-web</artifactid>
    </dependency>
    <dependency>
      <groupid>org.springframework.boot</groupid>
      <artifactid>spring-boot-starter-data-jpa</artifactid>
    </dependency>
    <dependency>
      <groupid>org.springframework.boot</groupid>
      <artifactid>spring-boot-starter-thymeleaf</artifactid>
    </dependency>
    
    <dependency>
      <groupid>mysql</groupid>
      <artifactid>mysql-connector-java</artifactid>
    </dependency>

    <dependency>
      <groupid>com.google.guava</groupid>
      <artifactid>guava</artifactid>
      <version>17.0</version>
    </dependency>
    
    <dependency>
      <groupid>org.springframework</groupid>
      <artifactid>spring-context-support</artifactid>
    </dependency>
    <dependency>
      <groupid>net.sf.ehcache</groupid>
      <artifactid>ehcache</artifactid>
      <version>2.8.3</version>
    </dependency>
  </dependencies>

  <dependencymanagement>
    <dependencies>
    </dependencies>
  </dependencymanagement>

  <build>
    <plugins>
      <plugin>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-maven-plugin</artifactid>
      </plugin>
    </plugins>
  </build>

  <repositories>
    <repository>
      <id>spring-snapshots</id>
      <url>http://repo.spring.io/snapshot</url>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
    </repository>
    <repository>
      <id>spring-milestones</id>
      <url>http://repo.spring.io/milestone</url>
    </repository>
  </repositories>
  <pluginrepositories>
    <pluginrepository>
      <id>spring-snapshots</id>
      <url>http://repo.spring.io/snapshot</url>
    </pluginrepository>
    <pluginrepository>
      <id>spring-milestones</id>
      <url>http://repo.spring.io/milestone</url>
    </pluginrepository>
  </pluginrepositories>
</project>

2.使用ehcache，我们需要一个ehcache.xml来定义一些cache的属性。

<?xml version="1.0" encoding="utf-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xsi:nonamespaceschemalocation="http://ehcache.org/ehcache.xsd"
 updatecheck="false">
     <diskstore path="java.io.tmpdir/tmp_ehcache" />
      <defaultcache eternal="false" maxelementsinmemory="1000" overflowtodisk="false" diskpersistent="false"
  timetoidleseconds="0" timetoliveseconds="600" memorystoreevictionpolicy="lru" />

      <cache name="demo" eternal="false" maxelementsinmemory="100" overflowtodisk="false" diskpersistent="false"
  timetoidleseconds="0" timetoliveseconds="300" memorystoreevictionpolicy="lru" />

</ehcache>

解释下这个xml文件中的标签。

(1).diskstore： 为缓存路径，ehcache分为内存和磁盘两级，此属性定义磁盘的缓存位置。参数解释如下：　　　　

1. user.home – 用户主目录
2. user.dir  – 用户当前工作目录
3. java.io.tmpdir – 默认临时文件路径

(2).defaultcache：默认缓存策略，当ehcache找不到定义的缓存时，则使用这个缓存策略。只能定义一个。

 (3).cache：自定缓存策略，为自定义的缓存策略。参数解释如下：

1. cache元素的属性：   
2. name：缓存名称                  
3. maxelementsinmemory：内存中最大缓存对象数                  
4. maxelementsondisk：硬盘中最大缓存对象数，若是0表示无穷大                  
5. eternal：true表示对象永不过期，此时会忽略timetoidleseconds和timetoliveseconds属性，默认为false                
6. overflowtodisk：true表示当内存缓存的对象数目达到了maxelementsinmemory界限后，会把溢出的对象写到硬盘缓存中。注意：如果缓存的对象要写入到硬盘中的话，则该对象必须实现了serializable接口才行。                  
7. diskspoolbuffersizemb：磁盘缓存区大小，默认为30mb。每个cache都应该有自己的一个缓存区。               
8. diskpersistent：是否缓存虚拟机重启期数据                  
9. diskexpirythreadintervalseconds：磁盘失效线程运行时间间隔，默认为120秒     
10. timetoidleseconds： 设定允许对象处于空闲状态的最长时间，以秒为单位。当对象自从最近一次被访问后，如果处于空闲状态的时间超过了timetoidleseconds属性值，这个对象就会过期，ehcache将把它从缓存中清空。只有当eternal属性为false，该属性才有效。如果该属性值为0，则表示对象可以无限期地处于空闲状态                  
11. timetoliveseconds：设定对象允许存在于缓存中的最长时间，以秒为单位。当对象自从被存放到缓存中后，如果处于缓存中的时间超过了 timetoliveseconds属性值，这个对象就会过期，ehcache将把它从缓存中清除。只有当eternal属性为false，该属性才有效。如果该属性值为0，则表示对象可以无限期地存在于缓存中。timetoliveseconds必须大于timetoidleseconds属性，才有意义     
12. memorystoreevictionpolicy：当达到maxelementsinmemory限制时，ehcache将会根据指定的策略去清理内存。可选策略有：lru（最近最少使用，默认策略）、fifo（先进先出）、lfu（最少访问次数）。  

springboot支持很多种缓存方式：redis、guava、ehcahe、jcache等等。

 说明下redis和ehcache的区别：

redis：属于独立的运行程序，需要单独安装后，使用java中的jedis来操纵。因为它是独立，所以如果你写个单元测试程序，放一些数据在redis中，然后又写一个程序去拿数据，那么是可以拿到这个数据的。，
ehcache：与redis明显不同，它与java程序是绑在一起的，java程序活着，它就活着。譬如，写一个独立程序放数据，再写一个独立程序拿数据，那么是拿不到数据的。只能在独立程序中才能拿到数据。

3.将ehcache的管理器暴露给spring的上下文容器，

@configuration
// 标注启动了缓存
@enablecaching
public class cacheconfiguration {

  /*
   * ehcache 主要的管理器
   */
  @bean(name = "appehcachecachemanager")
  public ehcachecachemanager ehcachecachemanager(ehcachemanagerfactorybean bean){
    return new ehcachecachemanager (bean.getobject ());
  }

  /*
   * 据shared与否的设置,spring分别通过cachemanager.create()或new cachemanager()方式来创建一个ehcache基地.
   */
  @bean
  public ehcachemanagerfactorybean ehcachemanagerfactorybean(){
    ehcachemanagerfactorybean cachemanagerfactorybean = new ehcachemanagerfactorybean ();
    cachemanagerfactorybean.setconfiglocation (new classpathresource ("conf/ehcache-app.xml"));
    cachemanagerfactorybean.setshared (true);
    return cachemanagerfactorybean;
  }
}

@configuration：为spring-boot注解，主要标注此为配置类，优先扫描。

@bean：向spring容器中加入bean。

至此所有的配置都做好了，通过spring-boot进行集成框架就是这么简单。

4.使用ehcache

使用ehcache主要通过spring的缓存机制，上面我们将spring的缓存机制使用了ehcache进行实现，所以使用方面就完全使用spring缓存机制就行了。

具体牵扯到几个注解：

@cacheable：负责将方法的返回值加入到缓存中，参数3
@cacheevict：负责清除缓存，参数4

参数解释：

1. value：缓存位置名称，不能为空，如果使用ehcache，就是ehcache.xml中声明的cache的name
2. key：缓存的key，默认为空，既表示使用方法的参数类型及参数值作为key，支持spel
3. condition：触发条件，只有满足条件的情况才会加入缓存，默认为空，既表示全部都加入缓存，支持spel
4. allentries：cacheevict参数，true表示清除value中的全部缓存，默认为false

不多说，直接上代码：

@service
public class cachedemoserviceimpl implements cachedemoservice {
  /**
   * 缓存的key
   */
  public static final string thing_all_key  = "\"thing_all\"";
  /**
   * value属性表示使用哪个缓存策略，缓存策略在ehcache.xml
   */
  public static final string demo_cache_name = "demo";  
  @cacheevict(value = demo_cache_name,key = thing_all_key)
  @override
  public void create(thing thing){
    long id = getnextid ();
    thing.setid (id);
    data.put (id, thing);
  } 
   
   @cacheable(value = demo_cache_name,key = "#thing.getid()+'thing'")
  @override
  public thing findbyid(long id){
    system.err.println ("没有走缓存！" + id);
    return data.get (id);
  }

  @cacheable(value = demo_cache_name,key = thing_all_key)
  @override
  public list<thing> findall(){
    return lists.newarraylist (data.values ());
  }
   
  @override
  @cacheput(value = demo_cache_name,key = "#thing.getid()+'thing'")
  @cacheevict(value = demo_cache_name,key = thing_all_key)
  public thing update(thing thing){
    system.out.println (thing);
    data.put (thing.getid (), thing);
    return thing;
  }

  @cacheevict(value = demo_cache_name)
  @override
  public void delete(long id){
    data.remove (id);
  }  
}

 5.只需要通过注解在service层方法上打注解便可以使用缓存，在find**上存入缓存，在delete**,update**上清除缓存。

cache注解详解

@cacheconfig：主要用于配置该类中会用到的一些共用的缓存配置。在这里@cacheconfig(cachenames = "users")：配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中，我们也可以不使用该注解，直接通过@cacheable自己配置缓存集的名字来定义。

@cacheable：配置了findbyname函数的返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问。该注解主要有下面几个参数：

1. value、cachenames：两个等同的参数（cachenames为spring 4新增，作为value的别名），用于指定缓存存储的集合名。由于spring 4中新增了@cacheconfig，因此在spring 3中原本必须有的value属性，也成为非必需项了
2. key：缓存对象存储在map集合中的key值，非必需，缺省按照函数的所有参数组合作为key值，若自己配置需使用spel表达式，比如：@cacheable(key = "#p0")：使用函数第一个参数作为缓存的key值，更多关于spel表达式的详细内容可参考
3. condition：缓存对象的条件，非必需，也需使用spel表达式，只有满足表达式条件的内容才会被缓存，比如：@cacheable(key = "#p0", condition = "#p0.length() < 3")，表示只有当第一个参数的长度小于3的时候才会被缓存，若做此配置上面的aaa用户就不会被缓存，读者可自行实验尝试。
4. unless：另外一个缓存条件参数，非必需，需使用spel表达式。它不同于condition参数的地方在于它的判断时机，该条件是在函数被调用之后才做判断的，所以它可以通过对result进行判断。
5. keygenerator：用于指定key生成器，非必需。若需要指定一个自定义的key生成器，我们需要去实现org.springframework.cache.interceptor.keygenerator接口，并使用该参数来指定。需要注意的是：该参数与key是互斥的
6. cachemanager：用于指定使用哪个缓存管理器，非必需。只有当有多个时才需要使用
7. cacheresolver：用于指定使用那个缓存解析器，非必需。需通过org.springframework.cache.interceptor.cacheresolver接口来实现自己的缓存解析器，并用该参数指定。

除了这里用到的两个注解之外，还有下面几个核心注解：

@cacheput：配置于函数上，能够根据参数定义条件来进行缓存，它与@cacheable不同的是，它每次都会真是调用函数，所以主要用于数据新增和修改操作上。它的参数与@cacheable类似，具体功能可参考上面对@cacheable参数的解析

@cacheevict：配置于函数上，通常用在删除方法上，用来从缓存中移除相应数据。除了同@cacheable一样的参数之外，它还有下面两个参数：

1.  allentries：非必需，默认为false。当为true时，会移除所有数据
2. beforeinvocation：非必需，默认为false，会在调用方法之后移除数据。当为true时，会在调用方法之前移除数据。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。