Spring整合Ehcache管理緩存

<!-- 默認緩存 --> <defaultCache

   maxEntriesLocalHeap="10000"
   eternal="false"
   timeToIdleSeconds="120"
   timeToLiveSeconds="120"
   maxEntriesLocalDisk="10000000"
   diskExpiryThreadIntervalSeconds="120"
   memoryStoreEvictionPolicy="LRU">

<persistence strategy="localTempSwap"/> </defaultCache>

<cache name="userCache"

  maxElementsInMemory="1000"
  eternal="false"
  timeToIdleSeconds="3"
  timeToLiveSeconds="3"
  maxEntriesLocalDisk="10000000"
  overflowToDisk="false"
  memoryStoreEvictionPolicy="LRU"/>

</ehcache></code></pre>

API方式

xml配置的參數也可以直接通過編程方式來動態的進行配置（dynamicConfig沒有設為false）。

Cache cache = manager.getCache("sampleCache"); 
CacheConfiguration config = cache.getCacheConfiguration(); 
config.setTimeToIdleSeconds(60); 
config.setTimeToLiveSeconds(120); 
config.setmaxEntriesLocalHeap(10000); 
config.setmaxEntriesLocalDisk(1000000);

也可以通過 disableDynamicFeatures() 方式關閉動態配置開關。配置以后你將無法再以編程方式配置參數。

Cache cache = manager.getCache("sampleCache"); 
cache.disableDynamicFeatures();

Spring整合Ehcache

Spring3.1開始添加了對緩存的支持。和事務功能的支持方式類似，緩存抽象允許底層使用不同的緩存解決方案來進行整合。

Spring4.1開始支持JSR-107注解。

注：我本人使用的Spring版本為4.1.4.RELEASE，目前Spring版本僅支持Ehcache2.5以上版本，但不支持Ehcache3。

綁定Ehcache

org.springframework.cache.ehcache.EhCacheManagerFactoryBean 這個類的作用是加載Ehcache配置文件。

org.springframework.cache.ehcache.EhCacheCacheManager 這個類的作用是支持net.sf.ehcache.CacheManager。

spring-ehcache.xml 的配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:cache="http://www.springframework.org/schema/cache"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
     http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
     http://www.springframework.org/schema/cache
     http://www.springframework.org/schema/cache/spring-cache-3.2.xsd">

<description>ehcache緩存配置管理文件</description>

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

<bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">
 <property name="cacheManager" ref="ehcache"/>
</bean>

<!-- 啟用緩存注解開關 -->
<cache:annotation-driven cache-manager="cacheManager"/>
</beans>

使用Spring的緩存注解

開啟注解

Spring為緩存功能提供了注解功能，但是你必須啟動注解。

你有兩個選擇：

(1) 在xml中聲明

像上一節spring-ehcache.xml中的做法一樣，使用 <cache:annotation-driven/>

<cache:annotation-driven cache-manager="cacheManager"/>

(2) 使用標記注解

你也可以通過對一個類進行注解修飾的方式在這個類中使用緩存注解。

范例如下：

@Configuration
@EnableCaching
public class AppConfig {
}

注解基本使用方法

Spring對緩存的支持類似于對事務的支持。

首先使用注解標記方法，相當于定義了切點，然后使用Aop技術在這個方法的調用前、調用后獲取方法的入參和返回值，進而實現了緩存的邏輯。

下面三個注解都是方法級別：

@Cacheable

表明所修飾的方法是可以緩存的：當第一次調用這個方法時，它的結果會被緩存下來，在緩存的有效時間內，以后訪問這個方法都直接返回緩存結果，不再執行方法中的代碼段。

這個注解可以用 condition 屬性來設置條件，如果不滿足條件，就不使用緩存能力，直接執行方法。

可以使用 key 屬性來指定key的生成規則。

@CachePut

與 @Cacheable 不同， @CachePut 不僅會緩存方法的結果，還會執行方法的代碼段。

它支持的屬性和用法都與 @Cacheable 一致。

@CacheEvict

與 @Cacheable 功能相反， @CacheEvict 表明所修飾的方法是用來刪除失效或無用的緩存數據。

下面是 @Cacheable 、 @CacheEvict 和 @CachePut 基本使用方法的一個集中展示：

@Service
public class UserService {
 // @Cacheable可以設置多個緩存，形式如：@Cacheable({"books", "isbns"})
 @Cacheable({"users"})
 public User findUser(User user) {
     return findUserInDB(user.getId());
 }

 @Cacheable(value = "users", condition = "#user.getId() <= 2")
 public User findUserInLimit(User user) {
     return findUserInDB(user.getId());
 }

 @CachePut(value = "users", key = "#user.getId()")
 public void updateUser(User user) {
     updateUserInDB(user);
 }

 @CacheEvict(value = "users")
 public void removeUser(User user) {
     removeUserInDB(user.getId());
 }

 @CacheEvict(value = "users", allEntries = true)
 public void clear() {
     removeAllInDB();
 }
}

@Caching

如果需要使用同一個緩存注解（ @Cacheable 、 @CacheEvict 或 @CachePut ）多次修飾一個方法，就需要用到 @Caching 。

@Caching(evict = { @CacheEvict("primary"), @CacheEvict(cacheNames="secondary", key="#p0") })
public Book importBooks(String deposit, Date date)

@CacheConfig

與前面的緩存注解不同，這是一個類級別的注解。

如果類的所有操作都是緩存操作，你可以使用 @CacheConfig 來指定類，省去一些配置。

@CacheConfig("books")
public class BookRepositoryImpl implements BookRepository {
 @Cacheable
 public Book findBook(ISBN isbn) {...}
}

參考