詳解Java的MyBatis框架中的快取與快取的使用改進

一級快取與二級快取
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 &#39;.*Page$&#39; ");
      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框架中的快取與中文的使用改良網相關網文章請注意PHPPHPPHP！