使用SSM注解做缓存操作

之前自己写过一个通过注解和AOP来实现缓存的代码，最早的原型来自于在淘宝工作时的一个项目。当时这段代码写得比较差，之后重构时发现之前的功能实现有很大的局限。主要问题在于：

1. key的生成规则
2. update 与 query 的参数不一样，如何让其生成一样的key
3. 列表缓存如何定义key及失效

最近同事推荐了一个开源项目：Simple-Spring-Memcached（简称ssm），它也是一个通过Annatation与AOP来完成缓存数据操作的开源项目。仔细看了一下代码，基本上把我之前碰到的问题都解决了，而且MultiCache这一块的实现超出我的预期。该项目主要优点如下：

1. 与Spring完善集成
2. 支持两种Memcached Java Client (spymemcached,Xmemcached)
3. 基于Annotation方式实现缓存操作，对代码侵入性小
4. annotation丰富，可以满足绝大部分需求

下面介绍一下其中各annotation的使用。ssm项目中的Annotation主要分成以下几类

• SingleCache类 操作单个POJO的Cache数据，由ParameterValueKeyProvider和CacheKeyMethod来标识组装key
• MultiCache类 操作List型的Cache数据，由ParameterValueKeyProvider和CacheKeyMethod来标识组装key
• AssignCache类 指定key操作Cache数据，由annotation中的 assignedKey 指定key

各Annotation的详细说明

• ReadThroughSingleCache
  作用：读取Cache中数据，如果不存在，则将读取的数据存入Cache
  key生成规则：ParameterValueKeyProvider指定的参数，如果该参数对象中包含CacheKeyMethod注解的方法，则调用其方法，否则调用toString方法
  代码示例：

   

      @ReadThroughSingleCache(namespace = "Alpha", expiration = 30)
      public String getDateString(@ParameterValueKeyProvider final String key) {
          final Date now = new Date();
          try {
              Thread.sleep(1500);
          } catch (InterruptedException ex) {
          }
          return now.toString() + ":" + now.getTime();
      }

• InvalidateSingleCache
  作用：失效Cache中的数据
  key生成规则：

   

  • 使用 ParameterValueKeyProvider注解时，与ReadThroughSingleCache一致
  • 使用 ReturnValueKeyProvider 注解时，key为返回的对象的CacheKeyMethod或toString方法生成

    @InvalidateSingleCache(namespace = "Charlie")
    public void updateRandomString(@ParameterValueKeyProvider final Long key) {
        // Nothing really to do here.
    }

    @InvalidateSingleCache(namespace = "Charlie")
    @ReturnValueKeyProvider
    public Long updateRandomStringAgain(final Long key) {
        return key;
    }

• UpdateSingleCache
  作用：更新Cache中的数据
  key生成规则：ParameterValueKeyProvider指定
  ParameterDataUpdateContent：方法参数中的数据，作为更新缓存的数据
  ReturnDataUpdateContent：方法调用后生成的数据，作为更新缓存的数据
  注：上述两个注解，必须与Update*系列的注解一起使用

   

      @UpdateSingleCache(namespace = "Alpha", expiration = 30)
      public void overrideDateString(final int trash, @ParameterValueKeyProvider final String key,
              @ParameterDataUpdateContent final String overrideData) {
      }
  
      @UpdateSingleCache(namespace = "Bravo", expiration = 300)
      @ReturnDataUpdateContent
      public String updateTimestampValue(@ParameterValueKeyProvider final Long key) {
          try {
              Thread.sleep(100);
          } catch (InterruptedException ex) {
          }
          final Long now = new Date().getTime();
          final String result = now.toString() + "-U-" + key.toString();
          return result;
      }

• ReadThroughAssignCache
  作用：读取Cache中数据，如果不存在，则将读取的数据存入Cache
  key生成规则： ReadThroughAssignCache 注解中的 assignedKey 字段指定

   

      @ReadThroughAssignCache(assignedKey = "SomePhatKey", namespace = "Echo", expiration = 3000)
      public List<String> getAssignStrings() {
          try {
              Thread.sleep(500);
          } catch (InterruptedException ex) {
          }
          final List<String> results = new ArrayList<String>();
          final long extra = System.currentTimeMillis() % 20;
          final String base = System.currentTimeMillis() + "";
          for (int ix = 0; ix < 20 + extra; ix++) {
              results.add(ix + "-" + base);
          }
          return results;
      }

• InvalidateAssignCache
  作用：失效缓存中指定key的数据
  key生成规则：assignedKey 字段指定

   

      @InvalidateAssignCache(assignedKey = "SomePhatKey", namespace = "Echo")
      public void invalidateAssignStrings() {
      }

• UpdateAssignCache
  作用：更新指定缓存
  key生成规则：assignedKey 字段指定

   

      @UpdateAssignCache(assignedKey = "SomePhatKey", namespace = "Echo", expiration = 3000)
      public void updateAssignStrings(int bubpkus, @ParameterDataUpdateContent final List<String> newData) {
      }

  http://www.colorfuldays.org/program/java/ssm_memcache/

 

评论

4 楼 luxianping 2013-05-06  

怎么根据命名空间来删除缓存?  比如说用户对应的菜单,当有用户修改了这个菜单  要把菜单这个命名空间下的缓存都删除

3 楼 vemacitri_b 2012-10-12  

mowengaobo 写道

你可以这样理解key。为什么不单独放个参数出来
如   @ReadThroughSingleCache(namespace = "Charlie", expiration = 1000)
    public String getRandomString(@ParameterValueKeyProvider final Long key) {
如果是集合

    @ReadThroughMultiCache(namespace = "Delta", expiration = 1000)
    public List<String> getRandomStrings(@ParameterValueKeyProvider final List<Long> keys) {

这样key怎么命名由你自己决定。

请问你这个keys具体要写什么呢？Entity里面需要用 @CacheKeyMethod这个么？
我现在想直接返回一个集合，但是不需要数据任何的参数，就是直接拿回所有集合，那我这个keys该写什么？能举例么？还有那个namespace 我该怎么写？看了网上的资料说的不是很理解，我现在配置好了已经，用的就是SSM+mybatis，但是我发现每次查询，还都是走数据库了，顺便请教一下log4j的日志该怎么配，才能在控制台输出每次memcached的get或者set信息呢？
非常感谢

2 楼 mowengaobo 2012-05-17  

你可以这样理解key。为什么不单独放个参数出来
如   @ReadThroughSingleCache(namespace = "Charlie", expiration = 1000)
    public String getRandomString(@ParameterValueKeyProvider final Long key) {
如果是集合

    @ReadThroughMultiCache(namespace = "Delta", expiration = 1000)
    public List<String> getRandomStrings(@ParameterValueKeyProvider final List<Long> keys) {

这样key怎么命名由你自己决定。

1 楼 夜神月 2012-05-16  

目前我在dao曾有如下的注解配置：
@ReadThroughSingleCache(namespace="com.test.user",expiration=50000)
public User getUserById(@ParameterValueKeyProvider(order=1) Long id, @ParameterValueKeyProvider(order=2) String name) throws SQLException

查看了下源码 cacheKey是这个com.test.user:1/dfgdfg  也就是说命名空间+两个被注解的参数。这样在实际应用中肯定的是不行的，至少把方法名这个点也得生成到key中。网上资料对这个框架的介绍比较匮乏，不知道是我配置有问题，还是有其他的方法，实现我这一目的