Spring AOP实现Redis缓存数据库查询源码

应用场景

我们希望能够将数据库查询结果缓存到redis中，这样在第二次做同样的查询时便可以直接从redis取结果，从而减少数据库读写次数。

需要解决的问题

操作缓存的代码写在哪？必须要做到与业务逻辑代码完全分离。

如何避免脏读？ 从缓存中读出的数据必须与数据库中的数据一致。

如何为一个数据库查询结果生成一个唯一的标识？即通过该标识(redis中为key)，能唯一确定一个查询结果，同一个查询结果，一定能映射到同一个key。只有这样才能保证缓存内容的正确性

如何序列化查询结果？查询结果可能是单个实体对象，也可能是一个list。

解决方案

避免脏读

我们缓存了查询结果，那么一旦数据库中的数据发生变化，缓存的结果就不可用了。为了实现这一保证，可以在执行相关表的更新查询(update, delete, insert)查询前，让相关的缓存过期。这样下一次查询时程序就会重新从数据库中读取新数据缓存到redis中。那么问题来了，在执行一条insert前我怎么知道应该让哪些缓存过期呢？对于redis，我们可以使用hash set数据结构，让一张表对应一个hash set，所有在这张表上的查询都保存到该set下。这样当表数据发生变动时，直接让set过期即可。我们可以自定义一个注解，在数据库查询方法上通过注解的属性注明这个操作与哪些表相关，这样在执行过期操作时，就能直接从注解中得知应该让哪些set过期了。

为查询生成唯一标识

对于mybatis，我们可以直接使用sql字符串做为key。但是这样就必须编写基于mybatis的拦截器，从而使你的缓存代码与mybatis紧紧耦合在一起。如果哪天更换了持久层的框架，你的缓存代码就白写了，所以这个方案并不完美。

仔细想一想，其实如果两次查询调用的类名、方法名和参数值相同，我们就可以确定这两次查询结果一定是相同的（在数据没有变动的前提下）。因此，我们可以将这三个元素组合成一个字符串做为key, 就解决了标识问题。

序列化查询结果

最方便的序列化方式就是使用jdk自带的objectoutputstream和objectinputstream。优点是几乎任何一个对象，只要实现了serializable接口，都用同一套代码能被序列化和反序列化。但缺点也很致命，那就是序列化的结果容量偏大，在redis中会消耗大量内存（是对应json格式的3倍左右）。那么我们只剩下json这一个选择了。

json的优点是结构紧凑，可读性强，但美中不足的是，反序列化对象时必须提供具体的类型参数(class对象)，如果是list对象，还必须提供list和list中的元素类型两种信息，才能被正确反序列化。这样就增加了代码的复杂度。不过这些困难都是可以克服的，所以我们还是选择json作为序列化存储方式。

代码写在哪

毫无疑问，该aop上场了。在我们的例子中，持久化框架使用的是mybatis，因此我们的任务就是拦截mapper接口方法的调用，通过around(环绕通知)编写以下逻辑：

方法被调用之前，根据类名、方法名和参数值生成key

通过key向redis发起查询

如果缓存命中，则将缓存结果反序列化作为方法调用的返回值 ，并阻止被代理方法的调用。

如果缓存未命中，则执行代理方法，得到查询结果，序列化，用当前的key将序列化结果放入redis中。

代码实现

因为我们要拦截的是mapper接口方法，因此必须命令spring使用jdk的动态代理而不是cglib的代理。为此，我们需要做以下配置：

<!-- 当proxy-target-class为false时使用jdk动态代理 -->
<!-- 为true时使用cglib -->
<!-- cglib无法拦截接口方法 -->
<aop:aspectj-autoproxy proxy-target-class="false" />

然后定义两个标注在接口方法上的注解，用于传递类型参数：

@retention(retentionpolicy.runtime)
@target(elementtype.method)
@documented
public @interface rediscache {
  class type();
}

@retention(retentionpolicy.runtime)
@target(elementtype.method)
public @interface redisevict {
  class type();
}

注解的使用方式如下：

// 表示该方法需要执行 (缓存是否命中 ? 返回缓存并阻止方法调用 : 执行方法并缓存结果)的缓存逻辑
@rediscache(type = jobpostmodel.class)
jobpostmodel selectbyprimarykey(integer id);

// 表示该方法需要执行清除缓存逻辑
@redisevict(type = jobpostmodel.class)
int deletebyprimarykey(integer id);

aop的代码如下:

@aspect
@component
public class rediscacheaspect {
  public static final logger infolog = logutils.getinfologger();
  @qualifier("redistemplateforstring")
  @autowired
  stringredistemplate rt;
  /**
   * 方法调用前，先查询缓存。如果存在缓存，则返回缓存数据，阻止方法调用;
   * 如果没有缓存，则调用业务方法，然后将结果放到缓存中
   * @param jp
   * @return
   * @throws throwable
   */
  @around("execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.select*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.get*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.find*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.search*(..))")
  public object cache(proceedingjoinpoint jp) throws throwable {
    // 得到类名、方法名和参数
    string clazzname = jp.gettarget().getclass().getname();
    string methodname = jp.getsignature().getname();
    object[] args = jp.getargs();

    // 根据类名，方法名和参数生成key
    string key = genkey(clazzname, methodname, args);
    if (infolog.isdebugenabled()) {
      infolog.debug("生成key:{}", key);
    }
    // 得到被代理的方法
    method me = ((methodsignature) jp.getsignature()).getmethod();
    // 得到被代理的方法上的注解
    class modeltype = me.getannotation(rediscache.class).type();

    // 检查redis中是否有缓存
    string value = (string)rt.opsforhash().get(modeltype.getname(), key);
    // result是方法的最终返回结果
    object result = null;
    if (null == value) {
      // 缓存未命中
      if (infolog.isdebugenabled()) {
        infolog.debug("缓存未命中");
      }
      // 调用数据库查询方法
      result = jp.proceed(args);

      // 序列化查询结果
      string json = serialize(result);
      // 序列化结果放入缓存
      rt.opsforhash().put(modeltype.getname(), key, json);
    } else {
      // 缓存命中
      if (infolog.isdebugenabled()) {
        infolog.debug("缓存命中, value = {}", value);
      }
      // 得到被代理方法的返回值类型
      class returntype = ((methodsignature) jp.getsignature()).getreturntype();

      // 反序列化从缓存中拿到的json
      result = deserialize(value, returntype, modeltype);

      if (infolog.isdebugenabled()) {
        infolog.debug("反序列化结果 = {}", result);
      }
    }
    return result;
  }
  /**
   * 在方法调用前清除缓存，然后调用业务方法
   * @param jp
   * @return
   * @throws throwable
   */
  @around("execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.insert*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.update*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.delete*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.increase*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.decrease*(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.complaint(..))" +
      "|| execution(* com.fh.taolijie.dao.mapper.jobpostmodelmapper.set*(..))")
  public object evictcache(proceedingjoinpoint jp) throws throwable {
    // 得到被代理的方法
    method me = ((methodsignature) jp.getsignature()).getmethod();
    // 得到被代理的方法上的注解
    class modeltype = me.getannotation(redisevict.class).type();
    if (infolog.isdebugenabled()) {
      infolog.debug("清空缓存:{}", modeltype.getname());
    }
    // 清除对应缓存
    rt.delete(modeltype.getname());
    return jp.proceed(jp.getargs());
  }
  /**
   * 根据类名、方法名和参数生成key
   * @param clazzname
   * @param methodname
   * @param args 方法参数
   * @return
   */
  protected string genkey(string clazzname, string methodname, object[] args) {
    stringbuilder sb = new stringbuilder(clazzname);
    sb.append(constants.delimiter);
    sb.append(methodname);
    sb.append(constants.delimiter);

    for (object obj : args) {
      sb.append(obj.tostring());
      sb.append(constants.delimiter);
    }
    return sb.tostring();
  }
  protected string serialize(object target) {
    return json.tojsonstring(target);
  }
  protected object deserialize(string jsonstring, class clazz, class modeltype) {
    // 序列化结果应该是list对象
    if (clazz.isassignablefrom(list.class)) {
      return json.parsearray(jsonstring, modeltype);
    }
    // 序列化结果是普通对象
    return json.parseobject(jsonstring, clazz);
  }
}

这样我们就完成了数据库查询缓存的实现。

update:

最好为hash set设置一个过期时间，这样即使缓存策略有误（导致读出脏数据），过期时间到了以后依然可以与数据库保持同步：

// 序列化结果放入缓存
      rt.execute(new rediscallback<object>() {
        @override
        public object doinredis(redisconnection redisconn) throws dataaccessexception {
          // 配置文件中指定了这是一个string类型的连接
          // 所以这里向下强制转换一定是安全的
          stringredisconnection conn = (stringredisconnection) redisconn;
          // 判断hash名是否存在
          // 如果不存在，创建该hash并设置过期时间
          if (false == conn.exists(hashname) ){
            conn.hset(hashname, key, json);
            conn.expire(hashname, constants.hash_expire_time);
          } else {
            conn.hset(hashname, key, json);
          }
          return null;
        }
      });

总结

本文关于spring aop实现redis缓存数据库查询源码的介绍就到这里，希望对大家有所帮助。感兴趣的朋友可以参阅本站其他相关专题，在此非常感谢大家对的支持！