Spring Ehcache详解

向右看齐 2022-04-03 08:38 203阅读 0赞

## springBoot 集成ehcache ##

### 1.配置CacheConfig.java ###

import org.springframework.cache.CacheManager;
    import org.springframework.cache.annotation.EnableCaching;
    import org.springframework.cache.ehcache.EhCacheCacheManager;
    import org.springframework.cache.ehcache.EhCacheManagerFactoryBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.io.ClassPathResource;
    
    /** * 启用ehcache缓存 * * @author test * @version 创建时间：2017年11月21日 下午12:24:01 * @email */
    @Configuration
    @EnableCaching
    public class CacheConfig { 
    	@Bean
    	public CacheManager cacheManager() { 
    		return new EhCacheCacheManager(ehCacheCacheManager().getObject());
    	}
    
    	@Bean
    	public EhCacheManagerFactoryBean ehCacheCacheManager() { 
    		EhCacheManagerFactoryBean cmfb = new EhCacheManagerFactoryBean();
    		cmfb.setConfigLocation(new ClassPathResource("ehcache.xml"));
    		cmfb.setShared(true);
    		return cmfb;
    	}
    }

### 2.配置ehcache.xml ###

<?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">
        <defaultCache eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />
         
    
        
        <cache name="userCache" eternal="false" maxElementsInMemory="500" overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" />
    
        
        <cache name="captchaCache" eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0" timeToLiveSeconds="60" memoryStoreEvictionPolicy="FIFO" />
    
        
        <cache name="userAllPermsCache" eternal="false" maxElementsInMemory="2000" overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0" timeToLiveSeconds="86400" memoryStoreEvictionPolicy="LRU" />
    </ehcache>

### 3.通过@Cacheable，@CacheEvict，@CachePut使用cache ###

3.1 @Cacheable  
  可以标记在一个方法上，也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的，当标记在一个类上时则表示该类所有的方法都是支持缓存的。对于一个支持缓存的方法，Spring会在其被调用后将其返回值缓存起来，以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果，而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的，值就是方法的返回结果，至于键的话，Spring又支持两种策略，默认策略和自定义策略，这个稍后会进行说明。需要注意的是当一个支持缓存的方法在对象内部被调用时是不会触发缓存功能的。@Cacheable可以指定三个属性，value、key和condition。  
@Cacheable 支持如下几个参数：  
value：缓存位置名称，不能为空，如果使用EHCache，就是ehcache.xml中声明的cache的name  
key：缓存的key，默认为空，既表示使用方法的参数类型及参数值作为key，支持SpEL  
condition：触发条件，只有满足条件的情况才会加入缓存，默认为空，既表示全部都加入缓存，支持SpEL

@Cacheable(value="andCache",key="#userId + 'findById'")    
    public SystemUser findById(String userId) {     
        SystemUser user = (SystemUser) dao.findById(SystemUser.class, userId);          
        return user ;           
    }    
    //将缓存保存进andCache，并当参数userId的长度小于32时才保存进缓存，默认使用参数值及类型作为缓存的key 
    @Cacheable(value="andCache",condition="#userId.length < 32")    
    public boolean isReserved(String userId) {     
        System.out.println("hello andCache"+userId);    
        return false;    
    }

3.2 在支持Spring Cache的环境下，对于使用@Cacheable标注的方法，Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素，如果存在就不再执行该方法，而是直接从缓存中获取结果进行返回，否则才会执行并将返回结果存入指定的缓存中。@CachePut也可以声明一个方法支持缓存功能。与@Cacheable不同的是使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。  
@CachePut也可以标注在类上和方法上。使用@CachePut时我们可以指定的属性跟@Cacheable是一样的。

@CachePut("users")//每次都会执行方法，并将结果存入指定的缓存中
       public User find(Integer id) { 
          returnnull;
       }

3.3 @CacheEvict是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的语义与@Cacheable对应的属性类似。即value表示清除操作是发生在哪些Cache上的（对应Cache的名称）；key表示需要清除的是哪个key，如未指定则会使用默认策略生成的key；condition表示清除操作发生的条件。  
@CacheEvict 支持如下几个参数：  
value：缓存位置名称，不能为空，同上  
key：缓存的key，默认为空，同上  
condition：触发条件，只有满足条件的情况才会清除缓存，默认为空，支持SpEL  
allEntries：true表示清除value中的全部缓存，默认为false

@CacheEvict(value="andCache",key="#user.userId + 'findById'")    
       public void modifyUserRole(SystemUser user) {     
                System.out.println("hello andCache delete"+user.getUserId());    
       }      
       //清除掉全部缓存 
       @CacheEvict(value="andCache",allEntries=true)    
       public final void setReservedUsers(String[] reservedUsers) {     
           System.out.println("hello andCache deleteall");    
       }

3.31 allEntries属性  
  allEntries是boolean类型，表示是否需要清除缓存中的所有元素。默认为false，表示不需要。当指定了allEntries为true时，Spring Cache将忽略指定的key。有的时候我们需要Cache一下清除所有的元素，这比一个一个清除元素更有效率。

@CacheEvict(value="users", allEntries=true)
      public void delete(Integer id) { 
         System.out.println("delete user by id: " + id);
      }

3.31 beforeInvocation属性  
  清除操作默认是在对应方法成功执行之后触发的，即方法如果因为抛出异常而未能成功返回时也不会触发清除操作。使用beforeInvocation可以改变触发清除操作的时间，当我们指定该属性值为true时，Spring会在调用该方法之前清除缓存中的指定元素。

@CacheEvict(value="users", beforeInvocation=true)
      public void delete(Integer id) { 
         System.out.println("delete user by id: " + id);
      }

### 4.@Caching ###

&emps;@Caching注解可以让我们在一个方法或者类上同时指定多个Spring Cache相关的注解。其拥有三个属性：cacheable、put和evict，分别用于指定@Cacheable、@CachePut和@CacheEvict。

@Caching(cacheable = @Cacheable("users"), evict = {  @CacheEvict("cache2"),
       @CacheEvict(value = "cache3", allEntries = true) })
       public User find(Integer id) { 
          returnnull;
       }

### 5.使用自定义注解 ###

Spring允许我们在配置可缓存的方法时使用自定义的注解，前提是自定义的注解上必须使用对应的注解进行标注。如我们有如下这么一个使用@Cacheable进行标注的自定义注解。

@Target({ ElementType.TYPE, ElementType.METHOD})
    	@Retention(RetentionPolicy.RUNTIME)
    	@Cacheable(value="users")
    	public @interface MyCacheable { 
    	}

那么在我们需要缓存的方法上使用@MyCacheable进行标注也可以达到同样的效果。

@MyCacheable
       public User findById(Integer id) { 
          System.out.println("find user by id: " + id);
          User user = new User();
          user.setId(id);
          user.setName("Name" + id);
          return user;
       }

一般来说，我们的更新操作只需要刷新缓存中某一个值，所以定义缓存的key值的方式就很重要，最好是能够唯一，因为这样可以准确的清除掉特定的缓存，而不会影响到其它缓存值 ，比如我这里针对用户的操作，使用(userId+方法名称)的方式设定key值 ，当然，你也可以找到更适合自己的方式去设定。

EhCache 是一个纯Java的进程内缓存框架，具有快速、精干等特点，是Hibernate中默认的CacheProvider。

Ehcache是一种广泛使用的开源Java分布式缓存。主要面向通用缓存,Java EE和轻量级容器。它具有内存和磁盘存储，缓存加载器,缓存扩展,缓存异常处理程序,一个gzip缓存servlet过滤器,支持REST和SOAP api等特点。  
Ehcache最初是由Greg Luck于2003年开始开发。2009年,该项目被Terracotta购买。软件仍然是开源,但一些新的主要功能(例如，快速可重启性之间的一致性的)只能在商业产品中使用，例如Enterprise EHCache and BigMemory。,维基媒体Foundationannounced目前使用的就是Ehcache技术。

主要的特性有：

1.  快速
2.  简单
3.  多种缓存策略
4.  缓存数据有两级：内存和磁盘，因此无需担心容量问题
5.  缓存数据会在虚拟机重启的过程中写入磁盘
6.  可以通过RMI、可插入API等方式进行分布式缓存
7.  具有缓存和缓存管理器的侦听接口
8.  支持多缓存管理器实例，以及一个实例的多个缓存区域
9.  提供Hibernate的缓存实现