spring + ehcache 配置

需要使用Spring來實作一個Cache簡單的解決方案，具體需求如下：使用任意一個現有開源Cache Framework，要求可以Cache系統中Service或則DAO層的get/find等方法傳回結果，如果資料更新（使用Create/update/delete方法），則重新整理cache中相應的内容。

根據需求，計劃使用Spring AOP + ehCache來實作這個功能，采用ehCache原因之一是Spring提供了ehCache的支援，至于為何僅僅支援ehCache而不支援osCache和JBossCache無從得知(Hibernate???)，但畢竟Spring提供了支援，可以減少一部分工作量：)。二是後來實作了OSCache和JBoss Cache的方式後，經過簡單測試發現幾個Cache在效率上沒有太大的差別(不考慮叢集)，決定采用ehCahce。

AOP嘛，少不了攔截器,先建立一個實作了MethodInterceptor接口的攔截器,用來攔截Service/DAO的方法調用，攔截到方法後，搜尋該方法的結果在cache中是否存在，如果存在，傳回cache中的緩存結果，如果不存在，傳回查詢資料庫的結果，并将結果緩存到cache中。

MethodCacheInterceptor.java

spring + ehcache 配置

package com.co.cache.ehcache;

import java.io.Serializable;

import net.sf.ehcache.Cache;

import net.sf.ehcache.Element;

import org.aopalliance.intercept.MethodInterceptor;

import org.aopalliance.intercept.MethodInvocation;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.InitializingBean;

import org.springframework.util.Assert;

public class MethodCacheInterceptor implements MethodInterceptor, InitializingBean

{

private static final Log logger = LogFactory.getLog(MethodCacheInterceptor.class);

private Cache cache;

public void setCache(Cache cache) {

this.cache = cache;

}

public MethodCacheInterceptor() {

super();

/**

* 攔截Service/DAO的方法，并查找該結果是否存在，如果存在就傳回cache中的值，

* 否則，傳回資料庫查詢結果，并将查詢結果放入cache

public Object invoke(MethodInvocation invocation) throws Throwable {

String targetName = invocation.getThis().getClass().getName();

String methodName = invocation.getMethod().getName();

Object[] arguments = invocation.getArguments();

Object result;

logger.debug("Find object from cache is " + cache.getName());

String cacheKey = getCacheKey(targetName, methodName, arguments);

Element element = cache.get(cacheKey);

if (element == null) {

logger.debug("Hold up method , Get method result and create cache........!");

result = invocation.proceed();

element = new Element(cacheKey, (Serializable) result);

cache.put(element);

}

return element.getValue();

* 獲得cache key的方法，cache key是Cache中一個Element的唯一辨別

* cache key包括包名+類名+方法名，如com.co.cache.service.UserServiceImpl.getAllUser

private String getCacheKey(String targetName, String methodName, Object[] arguments) {

StringBuffer sb = new StringBuffer();

sb.append(targetName).append(".").append(methodName);

if ((arguments != null) && (arguments.length != 0)) {

for (int i = 0; i < arguments.length; i++) {

sb.append(".").append(arguments[i]);

}

return sb.toString();

* implement InitializingBean，檢查cache是否為空

public void afterPropertiesSet() throws Exception {

Assert.notNull(cache, "Need a cache. Please use setCache(Cache) create it.");

}

package com.co.cache.ehcache;

import java.io.Serializable;

import net.sf.ehcache.Cache;

import net.sf.ehcache.Element;

import org.aopalliance.intercept.MethodInterceptor;

import org.aopalliance.intercept.MethodInvocation;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.InitializingBean;

import org.springframework.util.Assert;

public class MethodCacheInterceptor implements MethodInterceptor, InitializingBean

{

private static final Log logger = LogFactory.getLog(MethodCacheInterceptor.class);

private Cache cache;

public void setCache(Cache cache) {

this.cache = cache;

}

public MethodCacheInterceptor() {

super();

/**

* 攔截Service/DAO的方法，并查找該結果是否存在，如果存在就傳回cache中的值，

* 否則，傳回資料庫查詢結果，并将查詢結果放入cache

public Object invoke(MethodInvocation invocation) throws Throwable {

String targetName = invocation.getThis().getClass().getName();

String methodName = invocation.getMethod().getName();

Object[] arguments = invocation.getArguments();

Object result;

logger.debug("Find object from cache is " + cache.getName());

String cacheKey = getCacheKey(targetName, methodName, arguments);

Element element = cache.get(cacheKey);

if (element == null) {

logger.debug("Hold up method , Get method result and create cache........!");

result = invocation.proceed();

element = new Element(cacheKey, (Serializable) result);

cache.put(element);

}

return element.getValue();

* 獲得cache key的方法，cache key是Cache中一個Element的唯一辨別

* cache key包括包名+類名+方法名，如com.co.cache.service.UserServiceImpl.getAllUser

private String getCacheKey(String targetName, String methodName, Object[] arguments) {

StringBuffer sb = new StringBuffer();

sb.append(targetName).append(".").append(methodName);

if ((arguments != null) && (arguments.length != 0)) {

for (int i = 0; i < arguments.length; i++) {

sb.append(".").append(arguments[i]);

}

return sb.toString();

* implement InitializingBean，檢查cache是否為空

public void afterPropertiesSet() throws Exception {

Assert.notNull(cache, "Need a cache. Please use setCache(Cache) create it.");

上面的代碼中可以看到，在方法public Object invoke(MethodInvocation invocation) 中，完成了搜尋Cache/建立cache的功能。

spring + ehcache 配置

Element element = cache.get(cacheKey);

這句代碼的作用是擷取cache中的element，如果cacheKey所對應的element不存在，将會傳回一個null值

spring + ehcache 配置

result = invocation.proceed();

這句代碼的作用是擷取所攔截方法的傳回值，詳細請查閱AOP相關文檔。

随後，再建立一個攔截器MethodCacheAfterAdvice，作用是在使用者進行create/update/delete操作時來重新整理/remove相關cache内容，這個攔截器實作了AfterReturningAdvice接口，将會在所攔截的方法執行後執行在public void afterReturning(Object arg0, Method arg1, Object[] arg2, Object arg3)方法中所預定的操作

spring + ehcache 配置

import java.lang.reflect.Method;

import java.util.List;

import org.springframework.aop.AfterReturningAdvice;

public class MethodCacheAfterAdvice implements AfterReturningAdvice, InitializingBean

private static final Log logger = LogFactory.getLog(MethodCacheAfterAdvice.class);

public MethodCacheAfterAdvice() {

public void afterReturning(Object arg0, Method arg1, Object[] arg2, Object arg3) throws Throwable {

String className = arg3.getClass().getName();

List list = cache.getKeys();

for(int i = 0;i<list.size();i++){

String cacheKey = String.valueOf(list.get(i));

if(cacheKey.startsWith(className)){

cache.remove(cacheKey);

logger.debug("remove cache " + cacheKey);

import java.lang.reflect.Method;

import java.util.List;

import org.springframework.aop.AfterReturningAdvice;

public class MethodCacheAfterAdvice implements AfterReturningAdvice, InitializingBean

private static final Log logger = LogFactory.getLog(MethodCacheAfterAdvice.class);

public MethodCacheAfterAdvice() {

public void afterReturning(Object arg0, Method arg1, Object[] arg2, Object arg3) throws Throwable {

String className = arg3.getClass().getName();

List list = cache.getKeys();

for(int i = 0;i<list.size();i++){

String cacheKey = String.valueOf(list.get(i));

if(cacheKey.startsWith(className)){

cache.remove(cacheKey);

logger.debug("remove cache " + cacheKey);

上面的代碼很簡單，實作了afterReturning方法實作自AfterReturningAdvice接口，方法中所定義的内容将會在目标方法執行後執行，在該方法中

spring + ehcache 配置

String className = arg3.getClass().getName();

的作用是擷取目标class的全名，如：com.co.cache.test.TestServiceImpl，然後循環cache的key list，remove cache中所有和該class相關的element。

随後，開始配置ehCache的屬性，ehCache需要一個xml檔案來設定ehCache相關的一些屬性，如最大緩存數量、cache重新整理的時間等等.

ehcache.xml

spring + ehcache 配置

<defaultCache

maxElementsInMemory="1000"

eternal="false"

timeToIdleSeconds="120"

timeToLiveSeconds="120"

overflowToDisk="true"

<cache name="DEFAULT_CACHE"

maxElementsInMemory="10000"

timeToIdleSeconds="300000"

timeToLiveSeconds="600000"

</ehcache>

<defaultCache

配置每一項的詳細作用不再詳細解釋，有興趣的請google下，這裡需要注意一點defaultCache标簽定義了一個預設的Cache，這個Cache是不能删除的，否則會抛出No default cache is configured異常。另外，由于使用攔截器來重新整理Cache内容，是以在定義cache生命周期時可以定義較大的數值，timeToIdleSeconds="300000" timeToLiveSeconds="600000"，好像還不夠大？

然後，在将Cache和兩個攔截器配置到Spring，這裡沒有使用2.0裡面AOP的标簽。

cacheContext.xml

spring + ehcache 配置

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<value>ehcache.xml</value>

</property>

</bean>

<value>DEFAULT_CACHE</value>

<list>

</list>

<value>.*create.*</value>

<value>.*update.*</value>

<value>.*delete.*</value>

</beans>

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<value>ehcache.xml</value>

</property>

</bean>

<value>DEFAULT_CACHE</value>

<list>

</list>

<value>.*create.*</value>

<value>.*update.*</value>

<value>.*delete.*</value>

上面的代碼最終建立了兩個"切入點"，methodCachePointCut和methodCachePointCutAdvice，分别用于攔截不同方法名的方法，可以根據需要任意增加所需要攔截方法的名稱。

需要注意的是

spring + ehcache 配置

如果cacheName屬性内設定的name在ehCache.xml中無法找到，那麼将使用預設的cache(defaultCache标簽定義).

事實上到了這裡，一個簡單的Spring + ehCache Framework基本完成了，為了測試效果，舉一個實際應用的例子，定義一個TestService和它的實作類TestServiceImpl，裡面包含

兩個方法getAllObject()和updateObject(Object Object)，具體代碼如下

TestService.java

spring + ehcache 配置

package com.co.cache.test;

public interface TestService {

public List getAllObject();

public void updateObject(Object Object);

package com.co.cache.test;

public interface TestService {

public List getAllObject();

public void updateObject(Object Object);

TestServiceImpl.java

spring + ehcache 配置

public class TestServiceImpl implements TestService

public List getAllObject() {

System.out.println("---TestService：Cache内不存在該element，查找并放入Cache！");

return null;

public void updateObject(Object Object) {

System.out.println("---TestService：更新了對象，這個Class産生的cache都将被remove！");

public class TestServiceImpl implements TestService

public List getAllObject() {

System.out.println("---TestService：Cache内不存在該element，查找并放入Cache！");

return null;

public void updateObject(Object Object) {

System.out.println("---TestService：更新了對象，這個Class産生的cache都将被remove！");

使用Spring提供的AOP進行配置

applicationContext.xml

spring + ehcache 配置

<value>methodCachePointCut</value>

<value>methodCachePointCutAdvice</value>

<value>methodCachePointCut</value>

<value>methodCachePointCutAdvice</value>

這裡一定不能忘記import cacheContext.xml檔案，不然定義的兩個攔截器就沒辦法使用了。

最後，寫一個測試的代碼

MainTest.java

spring + ehcache 配置

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainTest{

public static void main(String args[]){

String DEFAULT_CONTEXT_FILE = "/applicationContext.xml";

ApplicationContext context = new ClassPathXmlApplicationContext(DEFAULT_CONTEXT_FILE);

TestService testService = (TestService)context.getBean("testService");

System.out.println("1--第一次查找并建立cache");

testService.getAllObject();

System.out.println("2--在cache中查找");

System.out.println("3--remove cache");

testService.updateObject(null);

System.out.println("4--需要重新查找并建立cache");

}

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainTest{

public static void main(String args[]){

String DEFAULT_CONTEXT_FILE = "/applicationContext.xml";

ApplicationContext context = new ClassPathXmlApplicationContext(DEFAULT_CONTEXT_FILE);

TestService testService = (TestService)context.getBean("testService");

System.out.println("1--第一次查找并建立cache");

testService.getAllObject();

System.out.println("2--在cache中查找");

System.out.println("3--remove cache");

testService.updateObject(null);

System.out.println("4--需要重新查找并建立cache");

}

運作，結果如下

spring + ehcache 配置

1--第一次查找并建立cache

---TestService：Cache内不存在該element，查找并放入Cache！

2--在cache中查找

3--remove cache

---TestService：更新了對象，這個Class産生的cache都将被remove！

4--需要重新查找并建立cache

---TestService：Cache内不存在該element，查找并放入Cache！

1--第一次查找并建立cache

2--在cache中查找

3--remove cache

---TestService：更新了對象，這個Class産生的cache都将被remove！

4--需要重新查找并建立cache

大功告成 .可以看到，第一步執行getAllObject()，執行TestServiceImpl内的方法，并建立了cache，在第二次執行getAllObject()方法時，由于cache有該方法的緩存，直接從cache中get出方法的結果，是以沒有列印出TestServiceImpl中的内容，而第三步，調用了updateObject方法，和TestServiceImpl相關的cache被remove，是以在第四步執行時，又執行TestServiceImpl中的方法，建立Cache。

網上也有不少類似的例子，但是很多都不是很完備，自己參考了一些例子的代碼，其實在spring-modules中也提供了對幾種cache的支援，ehCache，OSCache，JBossCache這些，看了一下，基本上都是采用類似的方式，隻不過封裝的更完善一些，主要思路也還是Spring的AOP，有興趣的可以研究一下。

spring + ehcache 配置

繼續閱讀

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

登入plsql 報錯 the account is locked --使用者被鎖

Effective Java 8:通用程式設計

SequoiaDB巨杉資料庫C++驅動概述

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method