详解Java的MyBatis框架中的缓存与缓存的使用改进

  • Z时代
  • 2024-01-10
  • 分类：IT

一级缓存与二级缓存

MyBatis将数据缓存设计成两级结构，分为一级缓存、二级缓存：

一级缓存是Session会话级别的缓存，位于表示一次数据库会话的SqlSession对象之中，又被称之为本地缓存。一级缓存是MyBatis内部实现的一个特性，用户不能配置，默认情况下自动支持的缓存，用户没有定制它的权利（不过这也不是绝对的，可以通过开发插件对它进行修改）；

二级缓存是Application应用级别的缓存，它的是生命周期很长，跟Application的声明周期一样，也就是说它的作用范围是整个Application应用。

MyBatis中一级缓存和二级缓存的组织如下图所示：

一级缓存的工作机制：

一级缓存是Session会话级别的，一般而言，一个SqlSession对象会使用一个Executor对象来完成会话操作，Executor对象会维护一个Cache缓存，以提高查询性能。

二级缓存的工作机制：

如上所言，一个SqlSession对象会使用一个Executor对象来完成会话操作，MyBatis的二级缓存机制的关键就是对这个Executor对象做文章。如果用户配置了"cacheEnabled=true"，那么MyBatis在为SqlSession对象创建Executor对象时，会对Executor对象加上一个装饰者：CachingExecutor，这时SqlSession使用CachingExecutor对象来完成操作请求。CachingExecutor对于查询请求，会先判断该查询请求在Application级别的二级缓存中是否有缓存结果，如果有查询结果，则直接返回缓存结果；如果缓存中没有，再交给真正的Executor对象来完成查询操作，之后CachingExecutor会将真正Executor返回的查询结果放置到缓存中，然后在返回给用户。

MyBatis的二级缓存设计得比较灵活，你可以使用MyBatis自己定义的二级缓存实现；你也可以通过实现org.apache.ibatis.cache.Cache接口自定义缓存；也可以使用第三方内存缓存库，如Memcached等。

缓存的改造

问题：

最容易出现的问题是开启cache后，分页查询时无论查询哪一页都返回第一页的数据。另外，使用sql自动生成插件生成get方法的sql时，传入的参数不起作用，无论传入的参数是多少，都返回第一个参数的查询结果。

为什么出现这些问题：

在之前讲解Mybatis的执行流程的时候提到，在开启cache的前提下，Mybatis的executor会先从缓存里读取数据，读取不到才去数据库查询。问题就出在这里，sql自动生成插件和分页插件执行的时机是在statementhandler里，而statementhandler是在executor之后执行的，无论sql自动生成插件和分页插件都是通过改写sql来实现的，executor在生成读取cache的key（key由sql以及对应的参数值构成）时使用都是原始的sql，这样当然就出问题了。

解决问题：

找到问题的原因后，解决起来就方便了。只要通过拦截器改写executor里生成key的方法，在生成可以时使用自动生成的sql（对应sql自动生成插件）或加入分页信息（对应分页插件）就可以了。

拦截器签名：

@Intercepts({@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})}) 
public class CacheInterceptor implements Interceptor { 
... 
}

从签名里可以看出，要拦截的目标类型是Executor（注意：type只能配置成接口类型），拦截的方法是名称为query的方法。

intercept的实现：

public Object intercept(Invocation invocation) throws Throwable { 
    Executor executorProxy = (Executor) invocation.getTarget(); 
    MetaObject metaExecutor = MetaObject.forObject(executorProxy, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY); 
    // 分离代理对象链 
    while (metaExecutor.hasGetter("h")) { 
      Object object = metaExecutor.getValue("h"); 
      metaExecutor = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY); 
    } 
    // 分离最后一个代理对象的目标类 
    while (metaExecutor.hasGetter("target")) { 
      Object object = metaExecutor.getValue("target"); 
      metaExecutor = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY); 
    } 
    Object[] args = invocation.getArgs(); 
    return this.query(metaExecutor, args); 
  } 
  public <E> List<E> query(MetaObject metaExecutor, Object[] args) throws SQLException { 
    MappedStatement ms = (MappedStatement) args[0]; 
    Object parameterObject = args[1]; 
    RowBounds rowBounds = (RowBounds) args[2]; 
    ResultHandler resultHandler = (ResultHandler) args[3]; 
    BoundSql boundSql = ms.getBoundSql(parameterObject); 
    // 改写key的生成 
    CacheKey cacheKey = createCacheKey(ms, parameterObject, rowBounds, boundSql); 
    Executor executor = (Executor) metaExecutor.getOriginalObject(); 
    return executor.query(ms, parameterObject, rowBounds, resultHandler, cacheKey, boundSql); 
  } 
  private CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) { 
    Configuration configuration = ms.getConfiguration(); 
    pageSqlId = configuration.getVariables().getProperty("pageSqlId"); 
    if (null == pageSqlId || "".equals(pageSqlId)) { 
      logger.warn("Property pageSqlId is not setted,use default '.*Page$' "); 
      pageSqlId = defaultPageSqlId; 
    } 
    CacheKey cacheKey = new CacheKey(); 
    cacheKey.update(ms.getId()); 
    cacheKey.update(rowBounds.getOffset()); 
    cacheKey.update(rowBounds.getLimit()); 
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings(); 
    // 解决自动生成SQL，SQL语句为空导致key生成错误的bug 
    if (null == boundSql.getSql() || "".equals(boundSql.getSql())) { 
      String id = ms.getId(); 
      id = id.substring(id.lastIndexOf(".") + 1); 
      String newSql = null; 
      try { 
        if ("select".equals(id)) { 
          newSql = SqlBuilder.buildSelectSql(parameterObject); 
        } 
        SqlSource sqlSource = buildSqlSource(configuration, newSql, parameterObject.getClass()); 
        parameterMappings = sqlSource.getBoundSql(parameterObject).getParameterMappings(); 
        cacheKey.update(newSql); 
      } catch (Exception e) { 
        logger.error("Update cacheKey error.", e); 
      } 
    } else { 
      cacheKey.update(boundSql.getSql()); 
    } 
    MetaObject metaObject = MetaObject.forObject(parameterObject, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY); 
    if (parameterMappings.size() > 0 && parameterObject != null) { 
      TypeHandlerRegistry typeHandlerRegistry = ms.getConfiguration().getTypeHandlerRegistry(); 
      if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) { 
        cacheKey.update(parameterObject); 
      } else { 
        for (ParameterMapping parameterMapping : parameterMappings) { 
          String propertyName = parameterMapping.getProperty(); 
          if (metaObject.hasGetter(propertyName)) { 
            cacheKey.update(metaObject.getValue(propertyName)); 
          } else if (boundSql.hasAdditionalParameter(propertyName)) { 
            cacheKey.update(boundSql.getAdditionalParameter(propertyName)); 
          } 
        } 
      } 
    } 
    // 当需要分页查询时，将page参数里的当前页和每页数加到cachekey里 
    if (ms.getId().matches(pageSqlId) && metaObject.hasGetter("page")) { 
      PageParameter page = (PageParameter) metaObject.getValue("page"); 
      if (null != page) { 
        cacheKey.update(page.getCurrentPage()); 
        cacheKey.update(page.getPageSize()); 
      } 
    } 
    return cacheKey; 
}

plugin的实现：

public Object plugin(Object target) { 
  // 当目标类是CachingExecutor类型时，才包装目标类，否者直接返回目标本身,减少目标被代理的 
  // 次数 
  if (target instanceof CachingExecutor) { 
    return Plugin.wrap(target, this); 
  } else { 
    return target; 
  } 
}

以上是 详解Java的MyBatis框架中的缓存与缓存的使用改进 的全部内容， 来源链接： utcz.com/p/209816.html

回到顶部