Ehcache 整合Spring 使用页面、对象缓存
Ehcache在很多项目中都出现过，用法也比较简单。一般的加些配置就可以了，而且Ehcache可以对页面、对象、数据进行缓存，同时支持集群/分布式缓存。如果整合Spring、Hibernate也非常的简单，Spring对Ehcache的支持也非常好。EHCache支持内存和磁盘的缓存，支持LRU、LFU和FIFO多种淘汰算法，支持分布式的Cache，可以作为Hibernate的缓存插件。同时它也能提供基于Filter的Cache，该Filter可以缓存响应的内容并采用Gzip压缩提高响应速度。
Email：[email protected]
一、准备工作
如果你的系统中已经成功加入Spring、Hibernate；那么你就可以进入下面Ehcache的准备工作。
1、 下载jar包
2、 需要添加如下jar包到lib目录下
ehcache-core-2.5.2.jar
ehcache-web-2.0.4.jar 主要针对页面缓存
3、 当前工程的src目录中加入配置文件
ehcache.xml
ehcache.xsd
这些配置文件在ehcache-core这个jar包中可以找到
二、Ehcache基本用法
CacheManager cacheManager = CacheManager.create();<!--CRLF-->
// 或者 <!--CRLF-->
cacheManager = CacheManager.getInstance();<!--CRLF-->
// 或者 <!--CRLF-->
cacheManager = CacheManager.create("/config/ehcache.xml"); <!--CRLF-->
// 或者 <!--CRLF-->
cacheManager = CacheManager.create("http://localhost:8080/test/ehcache.xml"); <!--CRLF-->
cacheManager = CacheManager.newInstance("/config/ehcache.xml"); <!--CRLF-->
// ....... <!--CRLF-->
<!--CRLF-->
// 获取ehcache配置文件中的一个cache <!--CRLF-->
Cache sample = cacheManager.getCache("sample"); <!--CRLF-->
// 获取页面缓存 <!--CRLF-->
BlockingCache cache = new BlockingCache(cacheManager.getEhcache("SimplePageCachingFilter"));<!--CRLF-->
// 添加数据到缓存中 <!--CRLF-->
Element element = new Element("key", "val");<!--CRLF-->
sample.put(element);<!--CRLF-->
// 获取缓存中的对象，注意添加到cache中对象要序列化 实现Serializable接口 <!--CRLF-->
Element result = sample.get("key"); <!--CRLF-->
// 删除缓存 <!--CRLF-->
sample.remove("key"); <!--CRLF-->
sample.removeAll();<!--CRLF-->
<!--CRLF-->
// 获取缓存管理器中的缓存配置名称 <!--CRLF-->
for (String cacheName : cacheManager.getCacheNames()) { <!--CRLF-->
System.out.println(cacheName);<!--CRLF-->
}<!--CRLF-->
// 获取所有的缓存对象 <!--CRLF-->
for (Object key : cache.getKeys()) { <!--CRLF-->
System.out.println(key);<!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
// 得到缓存中的对象数 <!--CRLF-->
cache.getSize();<!--CRLF-->
// 得到缓存对象占用内存的大小 <!--CRLF-->
cache.getMemoryStoreSize();<!--CRLF-->
// 得到缓存读取的命中次数 <!--CRLF-->
cache.getStatistics().getCacheHits();<!--CRLF-->
// 得到缓存读取的错失次数 <!--CRLF-->
cache.getStatistics().getCacheMisses();<!--CRLF-->
三、页面缓存
页面缓存主要用Filter过滤器对请求的url进行过滤，如果该url在缓存中出现。那么页面数据就从缓存对象中获取，并以gzip压缩后返回。其速度是没有压缩缓存时速度的3-5倍，效率相当之高！其中页面缓存的过滤器有CachingFilter，一般要扩展filter或是自定义Filter都继承该CachingFilter。
CachingFilter功能可以对HTTP响应的内容进行缓存。这种方式缓存数据的粒度比较粗，例如缓存整张页面。它的优点是使用简单、效率高，缺点是不够灵活，可重用程度不高。
EHCache使用SimplePageCachingFilter类实现Filter缓存。该类继承自CachingFilter，有默认产生cache key的calculateKey()方法，该方法使用HTTP请求的URI和查询条件来组成key。也可以自己实现一个Filter，同样继承CachingFilter类,然后覆写calculateKey()方法，生成自定义的key。
CachingFilter输出的数据会根据浏览器发送的Accept-Encoding头信息进行Gzip压缩。
在使用Gzip压缩时，需注意两个问题：
1. Filter在进行Gzip压缩时，采用系统默认编码，对于使用GBK编码的中文网页来说，需要将操作系统的语言设置为：zh_CN.GBK，否则会出现乱码的问题。
2. 默认情况下CachingFilter会根据浏览器发送的请求头部所包含的Accept-Encoding参数值来判断是否进行Gzip压缩。虽然IE6/7浏览器是支持Gzip压缩的，但是在发送请求的时候却不带该参数。为了对IE6/7也能进行Gzip压缩，可以通过继承CachingFilter，实现自己的Filter，然后在具体的实现中覆写方法acceptsGzipEncoding。
具体实现参考：
protected boolean acceptsGzipEncoding(HttpServletRequest request) {
boolean ie6 = headerContains(request, "User-Agent", "MSIE 6.0");
boolean ie7 = headerContains(request, "User-Agent", "MSIE 7.0");
return acceptsEncoding(request, "gzip") || ie6 || ie7;
}
在ehcache.xml中加入如下配置
<?xml version="1.0" encoding="gbk"?><!--CRLF-->
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ehcache.xsd"><!--CRLF-->
<diskStore path="java.io.tmpdir"/><!--CRLF-->
<!--CRLF-->
<defaultCache maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="30" timeToLiveSeconds="30" overflowToDisk="false"/><!--CRLF-->
<!-- <!--CRLF-->
配置自定义缓存 <!--CRLF-->
maxElementsInMemory：缓存中允许创建的最大对象数 <!--CRLF-->
eternal：缓存中对象是否为永久的，如果是，超时设置将被忽略，对象从不过期。 <!--CRLF-->
timeToIdleSeconds：缓存数据的钝化时间，也就是在一个元素消亡之前， <!--CRLF-->
两次访问时间的最大时间间隔值，这只能在元素不是永久驻留时有效， <!--CRLF-->
如果该值是 0 就意味着元素可以停顿无穷长的时间。 <!--CRLF-->
timeToLiveSeconds：缓存数据的生存时间，也就是一个元素从构建到消亡的最大时间间隔值， <!--CRLF-->
这只能在元素不是永久驻留时有效，如果该值是0就意味着元素可以停顿无穷长的时间。 <!--CRLF-->
overflowToDisk：内存不足时，是否启用磁盘缓存。 <!--CRLF-->
memoryStoreEvictionPolicy：缓存满了之后的淘汰算法。 <!--CRLF-->
<!--CRLF-->
--> <!--CRLF-->
<cache name="SimplePageCachingFilter"<!--CRLF-->
maxElementsInMemory="10000"<!--CRLF-->
eternal="false"<!--CRLF-->
overflowToDisk="false"<!--CRLF-->
timeToIdleSeconds="900"<!--CRLF-->
timeToLiveSeconds="1800"<!--CRLF-->
memoryStoreEvictionPolicy="LFU" /><!--CRLF-->
<!--CRLF-->
</ehcache><!--CRLF-->
具体代码：
package com.hoo.ehcache.filter; <!--CRLF-->
<!--CRLF-->
import java.util.Enumeration; <!--CRLF-->
import javax.servlet.FilterChain; <!--CRLF-->
import javax.servlet.http.HttpServletRequest; <!--CRLF-->
import javax.servlet.http.HttpServletResponse; <!--CRLF-->
import net.sf.ehcache.CacheException; <!--CRLF-->
import net.sf.ehcache.constructs.blocking.LockTimeoutException; <!--CRLF-->
import net.sf.ehcache.constructs.web.AlreadyCommittedException; <!--CRLF-->
import net.sf.ehcache.constructs.web.AlreadyGzippedException; <!--CRLF-->
import net.sf.ehcache.constructs.web.filter.FilterNonReentrantException; <!--CRLF-->
import net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter; <!--CRLF-->
import org.apache.commons.lang.StringUtils; <!--CRLF-->
import org.apache.log4j.Logger; <!--CRLF-->
<!--CRLF-->
/** <!--CRLF-->
* <b>function:</b> mobile 页面缓存过滤器 <!--CRLF-->
* @author hoojo <!--CRLF-->
* @createDate 2012-7-4 上午09:34:30 <!--CRLF-->
* @file PageEhCacheFilter.java <!--CRLF-->
* @package com.hoo.ehcache.filter <!--CRLF-->
* @project Ehcache <!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo <!--CRLF-->
* @email [email protected] <!--CRLF-->
* @version 1.0 <!--CRLF-->
*/ <!--CRLF-->
public class PageEhCacheFilter extends SimplePageCachingFilter {<!--CRLF-->
<!--CRLF-->
private final static Logger log = Logger.getLogger(PageEhCacheFilter.class);<!--CRLF-->
<!--CRLF-->
private final static String FILTER_URL_PATTERNS = "patterns";<!--CRLF-->
private static String[] cacheURLs;<!--CRLF-->
<!--CRLF-->
private void init() throws CacheException {<!--CRLF-->
String patterns = filterConfig.getInitParameter(FILTER_URL_PATTERNS);<!--CRLF-->
cacheURLs = StringUtils.split(patterns, ","); <!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
@Override<!--CRLF-->
protected void doFilter(final HttpServletRequest request,<!--CRLF-->
final HttpServletResponse response, final FilterChain chain)<!--CRLF-->
throws AlreadyGzippedException, AlreadyCommittedException, <!--CRLF-->
FilterNonReentrantException, LockTimeoutException, Exception { <!--CRLF-->
if (cacheURLs == null) { <!--CRLF-->
init();<!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
String url = request.getRequestURI();<!--CRLF-->
boolean flag = false; <!--CRLF-->
if (cacheURLs != null && cacheURLs.length > 0) { <!--CRLF-->
for (String cacheURL : cacheURLs) { <!--CRLF-->
if (url.contains(cacheURL.trim())) { <!--CRLF-->
flag = true;<!--CRLF-->
break; <!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
// 如果包含我们要缓存的url 就缓存该页面，否则执行正常的页面转向 <!--CRLF-->
if (flag) { <!--CRLF-->
String query = request.getQueryString();<!--CRLF-->
if (query != null) { <!--CRLF-->
query = "?" + query; <!--CRLF-->
}<!--CRLF-->
log.info("当前请求被缓存：" + url + query); <!--CRLF-->
super.doFilter(request, response, chain); <!--CRLF-->
} else { <!--CRLF-->
chain.doFilter(request, response);<!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
@SuppressWarnings("unchecked") <!--CRLF-->
private boolean headerContains(final HttpServletRequest request, final String header, final String value) {<!--CRLF-->
logRequestHeaders(request);<!--CRLF-->
final Enumeration accepted = request.getHeaders(header); <!--CRLF-->
while (accepted.hasMoreElements()) { <!--CRLF-->
final String headerValue = (String) accepted.nextElement(); <!--CRLF-->
if (headerValue.indexOf(value) != -1) { <!--CRLF-->
return true; <!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
return false; <!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
/** <!--CRLF-->
* @see net.sf.ehcache.constructs.web.filter.Filter#acceptsGzipEncoding(javax.servlet.http.HttpServletRequest) <!--CRLF-->
* <b>function:</b> 兼容ie6/7 gzip压缩 <!--CRLF-->
* @author hoojo <!--CRLF-->
* @createDate 2012-7-4 上午11:07:11 <!--CRLF-->
*/ <!--CRLF-->
@Override<!--CRLF-->
protected boolean acceptsGzipEncoding(HttpServletRequest request) {<!--CRLF-->
boolean ie6 = headerContains(request, "User-Agent", "MSIE 6.0");<!--CRLF-->
boolean ie7 = headerContains(request, "User-Agent", "MSIE 7.0");<!--CRLF-->
return acceptsEncoding(request, "gzip") || ie6 || ie7;<!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
这里的PageEhCacheFilter继承了SimplePageCachingFilter，一般情况下SimplePageCachingFilter就够用了，这里是为了满足当前系统需求才做了覆盖操作。使用SimplePageCachingFilter需要在web.xml中配置cacheName，cacheName默认是SimplePageCachingFilter，对应ehcache.xml中的cache配置。
在web.xml中加入如下配置
<!-- 缓存、gzip压缩核心过滤器 --> <!--CRLF-->
<filter><!--CRLF-->
<filter-name>PageEhCacheFilter</filter-name><!--CRLF-->
<filter-class>com.hoo.ehcache.filter.PageEhCacheFilter</filter-class><!--CRLF-->
<init-param><!--CRLF-->
<param-name>patterns</param-name><!--CRLF-->
<!-- 配置你需要缓存的url --> <!--CRLF-->
<param-value>/cache.jsp, product.action, market.action </param-value><!--CRLF-->
</init-param><!--CRLF-->
</filter><!--CRLF-->
<filter-mapping><!--CRLF-->
<filter-name>PageEhCacheFilter</filter-name><!--CRLF-->
<url-pattern>*.action</url-pattern><!--CRLF-->
</filter-mapping><!--CRLF-->
<filter-mapping><!--CRLF-->
<filter-name>PageEhCacheFilter</filter-name><!--CRLF-->
<url-pattern>*.jsp</url-pattern><!--CRLF-->
</filter-mapping><!--CRLF-->
当第一次请求这些页面后，这些页面就会被添加到缓存中，以后请求这些页面将会从缓存中获取。你可以在cache.jsp页面中用小脚本来测试该页面是否被缓存。<%=new Date()%>如果时间是变动的，则表示该页面没有被缓存或是缓存已经过期，否则则是在缓存状态了。
四、对象缓存
对象缓存就是将查询的数据，添加到缓存中，下次再次查询的时候直接从缓存中获取，而不去数据库中查询。
对象缓存一般是针对方法、类而来的，结合Spring的Aop对象、方法缓存就很简单。这里需要用到切面编程，用到了Spring的MethodInterceptor或是用@Aspect。
代码如下：
package com.hoo.common.ehcache; <!--CRLF-->
<!--CRLF-->
import java.io.Serializable; <!--CRLF-->
import net.sf.ehcache.Cache; <!--CRLF-->
import net.sf.ehcache.Element; <!--CRLF-->
import org.aopalliance.intercept.MethodInterceptor; <!--CRLF-->
import org.aopalliance.intercept.MethodInvocation; <!--CRLF-->
import org.apache.log4j.Logger; <!--CRLF-->
import org.springframework.beans.factory.InitializingBean; <!--CRLF-->
<!--CRLF-->
/** <!--CRLF-->
* <b>function:</b> 缓存方法拦截器核心代码 <!--CRLF-->
* @author hoojo <!--CRLF-->
* @createDate 2012-7-2 下午06:05:34 <!--CRLF-->
* @file MethodCacheInterceptor.java <!--CRLF-->
* @package com.hoo.common.ehcache <!--CRLF-->
* @project Ehcache <!--CRLF-->
* @blog http://blog.csdn.net/IBM_hoojo <!--CRLF-->
* @email [email protected] <!--CRLF-->
* @version 1.0 <!--CRLF-->
*/ <!--CRLF-->
public class MethodCacheInterceptor implements MethodInterceptor, InitializingBean {<!--CRLF-->
<!--CRLF-->
private static final Logger log = Logger.getLogger(MethodCacheInterceptor.class);<!--CRLF-->
<!--CRLF-->
private Cache cache; <!--CRLF-->
<!--CRLF-->
public void setCache(Cache cache) {<!--CRLF-->
this.cache = cache; <!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
public void afterPropertiesSet() throws Exception {<!--CRLF-->
log.info(cache + " A cache is required. Use setCache(Cache) to provide one."); <!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
public Object invoke(MethodInvocation invocation) throws Throwable {<!--CRLF-->
String targetName = invocation.getThis().getClass().getName();<!--CRLF-->
String methodName = invocation.getMethod().getName();<!--CRLF-->
Object[] arguments = invocation.getArguments();<!--CRLF-->
Object result;<!--CRLF-->
<!--CRLF-->
String cacheKey = getCacheKey(targetName, methodName, arguments);<!--CRLF-->
Element element = null;<!--CRLF-->
synchronized (this) {<!--CRLF-->
element = cache.get(cacheKey);<!--CRLF-->
if (element == null) { <!--CRLF-->
log.info(cacheKey + "加入到缓存： " + cache.getName()); <!--CRLF-->
// 调用实际的方法 <!--CRLF-->
result = invocation.proceed();<!--CRLF-->
element = new Element(cacheKey, (Serializable) result); <!--CRLF-->
cache.put(element);<!--CRLF-->
} else { <!--CRLF-->
log.info(cacheKey + "使用缓存： " + cache.getName()); <!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
return element.getValue(); <!--CRLF-->
}<!--CRLF-->
<!--CRLF-->
/** <!--CRLF-->
* <b>function:</b> 返回具体的方法全路径名称 参数 <!--CRLF-->
* @author hoojo <!--CRLF-->
* @createDate 2012-7-2 下午06:12:39 <!--CRLF-->
* @param targetName 全路径 <!--CRLF-->
* @param methodName 方法名称 <!--CRLF-->
* @param arguments 参数 <!--CRLF-->
* @return 完整方法名称 <!--CRLF-->
*/ <!--CRLF-->
private String getCacheKey(String targetName, String methodName, Object[] arguments) { <!--CRLF-->
StringBuffer sb = new StringBuffer(); <!--CRLF-->
sb.append(targetName).append(".").append(methodName); <!--CRLF-->
if ((arguments != null) && (arguments.length != 0)) { <!--CRLF-->
for (int i = 0; i < arguments.length; i++) {<!--CRLF-->
sb.append(".").append(arguments[i]); <!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
return sb.toString(); <!--CRLF-->
}<!--CRLF-->
}<!--CRLF-->
这里的方法拦截器主要是对你要拦截的类的方法进行拦截，然后判断该方法的类路径+方法名称+参数值组合的cache key在缓存cache中是否存在。如果存在就从缓存中取出该对象，转换成我们要的返回类型。没有的话就把该方法返回的对象添加到缓存中即可。值得主意的是当前方法的参数和返回值的对象类型需要序列化。
我们需要在src目录下添加applicationContext.xml完成对MethodCacheInterceptor拦截器的配置，该配置主意是注入我们的cache对象，哪个cache来管理对象缓存，然后哪些类、方法参与该拦截器的扫描。
添加配置如下：
<context:component-scan base-package="com.hoo.common.interceptor"/><!--CRLF-->
<!--CRLF-->
<!-- 配置eh缓存管理器 --> <!--CRLF-->
<bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean"/><!--CRLF-->
<!--CRLF-->
<!-- 配置一个简单的缓存工厂bean对象 --> <!--CRLF-->
<bean id="simpleCache" class="org.springframework.cache.ehcache.EhCacheFactoryBean"><!--CRLF-->
<property name="cacheManager" ref="cacheManager" /><!--CRLF-->
<!-- 使用缓存 关联ehcache.xml中的缓存配置 --> <!--CRLF-->
<property name="cacheName" value="mobileCache" /><!--CRLF-->
</bean><!--CRLF-->
<!--CRLF-->
<!-- 配置一个缓存拦截器对象，处理具体的缓存业务 --> <!--CRLF-->
<bean id="methodCacheInterceptor" class="com. hoo.common.interceptor.MethodCacheInterceptor"><!--CRLF-->
<property name="cache" ref="simpleCache"/><!--CRLF-->
</bean><!--CRLF-->
<!--CRLF-->
<!-- 参与缓存的切入点对象 (切入点对象，确定何时何地调用拦截器) --> <!--CRLF-->
<bean id="methodCachePointCut" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor"><!--CRLF-->
<!-- 配置缓存aop切面 --> <!--CRLF-->
<property name="advice" ref="methodCacheInterceptor" /><!--CRLF-->
<!-- 配置哪些方法参与缓存策略 --> <!--CRLF-->
<!-- <!--CRLF-->
.表示符合任何单一字元 <!--CRLF-->
### +表示符合前一个字元一次或多次 <!--CRLF-->
### *表示符合前一个字元零次或多次 <!--CRLF-->
### \Escape任何Regular expression使用到的符号 <!--CRLF-->
--> <!--CRLF-->
<!-- .*表示前面的前缀(包括包名) 表示print方法--> <!--CRLF-->
<property name="patterns"><!--CRLF-->
<list><!--CRLF-->
<value>com.hoo.rest.*RestService*\.*get.*</value><!--CRLF-->
<value>com.hoo.rest.*RestService*\.*search.*</value><!--CRLF-->
</list><!--CRLF-->
</property><!--CRLF-->
</bean><!--CRLF-->
在ehcache.xml中添加如下cache配置
<cache name="mobileCache"<!--CRLF-->
maxElementsInMemory="10000"<!--CRLF-->
eternal="false"<!--CRLF-->
overflowToDisk="true"<!--CRLF-->
timeToIdleSeconds="1800"<!--CRLF-->
timeToLiveSeconds="3600"<!--CRLF-->
memoryStoreEvictionPolicy="LFU" /><!--CRLF-->