AutoLoadCache

<dependency>
 <groupId>com.github.qiujiayu</groupId>
 <artifactId>autoload-cache</artifactId>
 <version>${version}</version>
</dependency>

<!-- Jedis 连接池配置 -->
<bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
 <property name="maxTotal" value="2000" />
 <property name="maxIdle" value="100" />
 <property name="minIdle" value="50" />
 <property name="maxWaitMillis" value="2000" />
 <property name="testOnBorrow" value="false" />
 <property name="testOnReturn" value="false" />
 <property name="testWhileIdle" value="false" />
</bean>
<bean id="shardedJedisPool" class="redis.clients.jedis.ShardedJedisPool">
 <constructor-arg ref="jedisPoolConfig" />
 <constructor-arg>
 <list>
 <bean class="redis.clients.jedis.JedisShardInfo">
 <constructor-arg value="${redis1.host}" />
 <constructor-arg type="int" value="${redis1.port}" />
 <constructor-arg value="instance:01" />
 </bean>
 <bean class="redis.clients.jedis.JedisShardInfo">
 <constructor-arg value="${redis2.host}" />
 <constructor-arg type="int" value="${redis2.port}" />
 <constructor-arg value="instance:02" />
 </bean>
 <bean class="redis.clients.jedis.JedisShardInfo">
 <constructor-arg value="${redis3.host}" />
 <constructor-arg type="int" value="${redis3.port}" />
 <constructor-arg value="instance:03" />
 </bean>
 </list>
 </constructor-arg>
</bean>
<bean id="autoLoadConfig" class="com.jarvis.cache.to.AutoLoadConfig">
 <property name="threadCnt" value="10" />
 <property name="maxElement" value="20000" />
 <property name="printSlowLog" value="true" />
 <property name="slowLoadTime" value="500" />
 <property name="sortType" value="1" />
 <property name="checkFromCacheBeforeLoad" value="true" />
 <property name="autoLoadPeriod" value="50" />
</bean>
<!-- 可以通过implements com.jarvis.cache.serializer.ISerializer<Object> 实现 Kryo 和 FST Serializer 工具,框架的核对不在这里,所以不提供过多的实现 -->
<bean id="hessianSerializer" class="com.jarvis.cache.serializer.HessianSerializer" />
<bean id="cacheManager" class="com.jarvis.cache.redis.ShardedCachePointCut" destroy-method="destroy">
 <constructor-arg ref="autoLoadConfig" />
 <property name="serializer" ref="hessianSerializer" />
 <property name="shardedJedisPool" ref="shardedJedisPool" />
 <property name="namespace" value="test_hessian" />
</bean>

<bean id="memcachedClient" class="net.spy.memcached.spring.MemcachedClientFactoryBean">
 <property name="servers" value="192.138.11.165:11211,192.138.11.166:11211" />
 <property name="protocol" value="BINARY" />
 <property name="transcoder">
 <bean class="net.spy.memcached.transcoders.SerializingTranscoder">
 <property name="compressionThreshold" value="1024" />
 </bean>
 </property>
 <property name="opTimeout" value="2000" />
 <property name="timeoutExceptionThreshold" value="1998" />
 <property name="hashAlg">
 <value type="net.spy.memcached.DefaultHashAlgorithm">KETAMA_HASH</value>
 </property>
 <property name="locatorType" value="CONSISTENT" />
 <property name="failureMode" value="Redistribute" />
 <property name="useNagleAlgorithm" value="false" />
</bean>
<bean id="hessianSerializer" class="com.jarvis.cache.serializer.HessianSerializer" />
<bean id="cacheManager" class="com.jarvis.cache.memcache.CachePointCut" destroy-method="destroy">
 <constructor-arg ref="autoLoadConfig" />
 <property name="serializer" ref="hessianSerializer" />
 <property name="memcachedClient", ref="memcachedClient" />
 <property name="namespace" value="test" />
</bean>

<bean id="cacheInterceptor" class="com.jarvis.cache.aop.aspectj.AspectjAopInterceptor">
 <property name="cacheManager" ref="cacheManager" />
</bean>
<aop:config proxy-target-class="true">
 <aop:aspect ref="cacheInterceptor">
 <aop:pointcut id="daoCachePointcut" expression="execution(public !void com.jarvis.cache_example.common.dao..*.*(..)) &amp;&amp; @annotation(cache)" />
 <aop:around pointcut-ref="daoCachePointcut" method="proceed" />
 </aop:aspect>
 <aop:aspect ref="cacheInterceptor" order="1000"><!-- order 参数控制 aop通知的优先级,值越小,优先级越高 ,在事务提交后删除缓存 -->
 <aop:pointcut id="deleteCachePointcut" expression="execution(* com.jarvis.cache_example.common.dao..*.*(..)) &amp;&amp; @annotation(cacheDelete)" />
 <aop:after-returning pointcut-ref="deleteCachePointcut" method="deleteCache" returning="retVal"/>
 </aop:aspect>
</aop:config>

<!-- proxy-target-class=false为jdk代理,为true的话,会导致拦截不了mybatis的mapper -->
<aop:config proxy-target-class="false">
 <!-- 拦截mybatis的mapper -->
 <aop:aspect ref="cacheInterceptor">
 <aop:pointcut id="daoCachePointcut1" expression="execution(public !void com.jarvis.cache_example.common.mapper..*.*(..))" />
 <aop:around pointcut-ref="daoCachePointcut1" method="checkAndProceed" />
 </aop:aspect>
 <aop:aspect ref="cacheInterceptor" order="1000"><!-- order 参数控制 aop通知的优先级,值越小,优先级越高 ,在事务提交后删除缓存 -->
 <aop:pointcut id="deleteCachePointcut1" expression="execution(* com.jarvis.cache_example.common.mapper..*.*(..))" />
 <aop:after-returning pointcut-ref="deleteCachePointcut1" method="checkAndDeleteCache" returning="retVal" />
 </aop:aspect>
</aop:config>

public @interface Cache {
 /**
 * 缓存的过期时间,单位:秒,如果为0则表示永久缓存
 * @return 时间
 */
 int expire();
 /**
 * 动态获取缓存过期时间的Spring EL表达式
 * @return 时间
 */
 String expireExpression() default "";
 /**
 * 预警自动刷新时间(单位:秒),必须满足 0 < alarmTime < expire才有效
 * @return 时间
 */
 int alarmTime() default 0;
 /**
 * 自定义缓存Key,支持Spring EL表达式
 * @return String 自定义缓存Key
 */
 String key() default "";
 /**
 * 设置哈希表中的字段,如果设置此项,则用哈希表进行存储,支持Spring EL表达式
 * @return String
 */
 String hfield() default "";
 /**
 * 是否启用自动加载缓存, 缓存时间必须大于120秒时才有效
 * @return boolean
 */
 boolean autoload() default false;
 /**
 * 自动缓存的条件,可以为空,使用 SpEL 编写,返回 true 或者 false,如果设置了此值,autoload() 就失效,例如:null != #args[0].keyword,当第一个参数的keyword属性为null时设置为自动加载。
 * @return String SpEL表达式
 */
 String autoloadCondition() default "";
 /**
 * 当autoload为true时,缓存数据在 requestTimeout 秒之内没有使用了,就不进行自动加载数据,如果requestTimeout为0时,会一直自动加载
 * @return long 请求过期
 */
 long requestTimeout() default 36000L;
 /**
 * 缓存的条件,可以为空,使用 SpEL 编写,返回 true 或者 false,只有为 true 才进行缓存
 * @return String
 */
 String condition() default "";
 /**
 * 缓存的操作类型:默认是READ_WRITE,先缓存取数据,如果没有数据则从DAO中获取并写入缓存;如果是WRITE则从DAO取完数据后,写入缓存
 * @return CacheOpType
 */
 CacheOpType opType() default CacheOpType.READ_WRITE;
 /**
 * 并发等待时间(毫秒),等待正在DAO中加载数据的线程返回的等待时间。
 * @return 时间
 */
 int waitTimeOut() default 500;
 /**
 * 扩展缓存
 * @return
 */
 ExCache[] exCache() default @ExCache(expire=-1, key="");
}

@Cache(expire=600, key="'USER.getUserById'+#args[0]", exCache={@ExCache(expire=600, key="'USER.getUserByName'+#retVal.name")})
public User getUserById(Long id){... ...}
@Cache(expire=600, key="'USER.getUserByName'+#args[0]", exCache={@ExCache(expire=600, key="'USER.getUserById'+#retVal.id")})
public User getUserByName(Long id){... ...}

public @interface ExCache {
 /**
 * 缓存的过期时间,单位:秒,如果为0则表示永久缓存
 * @return 时间
 */
 int expire();
 /**
 * 动态获取缓存过期时间的Spring EL表达式
 * @return 时间
 */
 String expireExpression() default "";
 /**
 * 自定义缓存Key,支持Spring EL表达式
 * @return String 自定义缓存Key
 */
 String key();
 /**
 * 设置哈希表中的字段,如果设置此项,则用哈希表进行存储,支持Spring EL表达式
 * @return String
 */
 String hfield() default "";
 /**
 * 缓存的条件,可以为空,使用 SpEL 编写,返回 true 或者 false,只有为 true 才进行缓存
 * @return String
 */
 String condition() default "";
 /**
 * 通过SpringEL表达式获取需要缓存的数据,如果没有设置,则默认使用 #retVal
 * @return
 */
 String cacheObject() default "";
}

public @interface CacheDelete {
 CacheDeleteKey[] value();// 支持删除多个缓存
}

public @interface CacheDeleteKey {
 /**
 * 缓存的条件,可以为空,使用 SpEL 编写,返回 true 或者 false,只有为 true 才进行缓存
 * @return String
 */
 String condition() default "";
 /**
 * 删除缓存的Key,支持使用SpEL表达式, 当value有值时,是自定义缓存key。
 * @return String
 */
 String value();
 /**
 * 哈希表中的字段,支持使用SpEL表达式
 * @return String
 */
 String hfield() default "";
}

例如: 
 @Cache(expire=600, key="'goods.getGoodsById'+#args[0]")
 public GoodsTO getGoodsById(Long id){...}
为了使用方便,调用hash 函数可以将任何Object转为字符串,使用方法如下:
 
 @Cache(expire=720, key="'GOODS.getGoods:'+#hash(#args)")
 public List<GoodsTO> getGoods(GoodsCriteriaTO goodsCriteria){...}
生成的缓存Key为"GOODS.getGoods:xxx",xxx为args,的转在的字符串。
在拼缓存Key时,各项数据最好都用特殊字符进行分隔,否则缓存的Key有可能会乱的。比如:a,b 两个变量a=1,b=11,如果a=11,b=1,两个变量中间不加特殊字符,拼在一块,值是一样的。

<bean id="autoLoadConfig" class="com.jarvis.cache.to.AutoLoadConfig">
 <property name="functions">
 <map>
 <entry key="isEmpty" value="com.jarvis.cache.CacheUtil" />
 <!--#isEmpty(#args[0]) 表示调com.jarvis.cache.CacheUtil中的isEmpty方法-->
 </map>
 </property>
</bean>

package com.jarvis.example.dao;
import ... ...
public class GoodsCommentDAO{
 @Cache(expire=600, key="'goods_comment_list_'+#args[0]", hfield = "#args[1]+'_'+#args[2]", autoload=true, requestTimeout=18000)
 // goodsId=1, pageNo=2, pageSize=3 时相当于Redis命令:HSET goods_comment_list_1 2_3 List
 public List<CommentTO> getCommentListByGoodsId(Long goodsId, int pageNo, int pageSize) {
 ... ...
 }
 @CacheDelete({@CacheDeleteKey(value="'goods_comment_list_'+#args[0].goodsId")}) // 删除当前所属商品的所有评论,不删除其它商品评论
 // #args[0].goodsId = 1时,相当于Redis命令: DEL goods_comment_list_1
 public void addComment(Comment comment) {
 ... ...// 省略添加评论代码
 }
 @CacheDelete({@CacheDeleteKey(value="'goods_comment_list_'+#args[0]", hfield = "#args[1]+'_'+#args[2]")}) 
 // goodsId=1, pageNo=2, pageSize=3 时相当于Redis命令:DEL goods_comment_list_1 2_3 
 public void removeCache(Long goodsId, int pageNo, int pageSize) {
 ... ...// 使用空方法来删除缓存
 }
}

 public CollectionTO<AccountTO> getAccountByCriteria(AccountCriteriaTO criteria) {
 List<AccountTO> list=null;
 PaginationTO paging=criteria.getPaging();
 if(null != paging && paging.getPageNo() > 0 && paging.getPageSize() > 0) {// 如果需要分页查询,先查询总数
 criteria.setPaging(null);// 减少缓存KEY的变化,在查询记录总数据时,不用设置分页相关的属性值
 Integer recordCnt=accountDAO.getAccountCntByCriteria(criteria);
 if(recordCnt > 0) {
 criteria.setPaging(paging);
 paging.setRecordCnt(recordCnt);
 list=accountDAO.getAccountByCriteria(criteria);
 }
 return new CollectionTO<AccountTO>(list, recordCnt, criteria.getPaging().getPageSize());
 } else {
 list=accountDAO.getAccountByCriteria(criteria);
 return new CollectionTO<AccountTO>(list, null != list ? list.size() : 0, 0);
 }
 }

 TempDAO {
 public Object a() {
 return b().get(0);
 }
 @Cache(expire=600)
 public List<Object> b(){
 return ... ...;
 }
 }

 @Cache(expire=600, autoload=true, key="'myKey'+#hash(#args[0])")
 public List<AccountTO> getDistinctAccountByPlayerGet(AccountCriteriaTO criteria) {
 List<AccountTO> list;
 int count=criteria.getPaging().getThreshold() ;
 // 查预设查询数量的10倍
 criteria.getPaging().setThreshold(count * 10);
 ... ...
 }

<servlet>
 <servlet-name>cacheadmin</servlet-name>
 <servlet-class>com.jarvis.cache.admin.servlet.AdminServlet</servlet-class>
 <init-param>
 <param-name>cacheManagerNames</param-name>
 <param-value>cachePointCut</param-value>
 </init-param>
 <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
 <servlet-name>cacheadmin</servlet-name>
 <url-pattern>/cacheadmin</url-pattern>
</servlet-mapping>

更新日志