Mybatis查詢延遲加載詳解及實(shí)例

更新時(shí)間：2017年01月03日 11:37:59 投稿：lqh

這篇文章主要介紹了Mybatis查詢延遲加載詳解及實(shí)例的相關(guān)資料,Mybatis的延遲加載默認(rèn)是關(guān)閉的，即默認(rèn)是一次就將所有的嵌套SQL一并查了將對(duì)象所有的信息都查詢出來。開啟延遲加載有兩種方式，需要的朋友可以參考下

Mybatis查詢延遲加載詳解及實(shí)例

1.1 啟用延遲加載

Mybatis的延遲加載是針對(duì)嵌套查詢而言的，是指在進(jìn)行查詢的時(shí)候先只查詢最外層的SQL，對(duì)于內(nèi)層SQL將在需要使用的時(shí)候才查詢出來。Mybatis的延遲加載默認(rèn)是關(guān)閉的，即默認(rèn)是一次就將所有的嵌套SQL一并查了將對(duì)象所有的信息都查詢出來。開啟延遲加載有兩種方式。

第一種是在對(duì)應(yīng)的<collection>或<association>標(biāo)簽上指定fetchType屬性值為“l(fā)azy”。如下示例中我們?cè)诓樵僫d為selectByPrimaryKey的查詢時(shí)會(huì)返回BaseResultMap，在BaseResultMap中，我們指定了屬性“nodes”是一個(gè)集合類型的，而且是需要通過id為selectNodes的查詢進(jìn)行查詢的，我們指定了該查詢的fetchType為lazy，即延遲加載。

  <resultMap id="BaseResultMap" type="com.elim.learn.mybatis.model.SysWfProcess">

   <id column="id" jdbcType="INTEGER" property="id" />

   <result column="template_id" jdbcType="INTEGER" property="templateId" />

   <result column="creator" jdbcType="INTEGER" property="creator" />

   <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />

   <collection property="nodes" column="id"

    ofType="com.elim.learn.mybatis.model.SysWfNode" select="selectNodes" fetchType="lazy"/>

  </resultMap>

  <resultMap id="SysWfNodeResult" type="com.elim.learn.mybatis.model.SysWfNode">

   <id column="id" jdbcType="INTEGER" property="nodeId" />

   <result column="process_id" jdbcType="INTEGER" property="processId" />

   <result column="node_code" jdbcType="VARCHAR" property="nodeCode" />

   <result column="node_name" jdbcType="VARCHAR" property="nodeName" />

  </resultMap>

  <select id="selectByPrimaryKey" parameterType="java.lang.Integer"

   resultMap="BaseResultMap">

   select

   <include refid="Base_Column_List" />

   from sys_wf_process

   where id = #{id,jdbcType=INTEGER}

  </select>

  <select id="selectNodes"

   resultMap="SysWfNodeResult">

   select id, process_id, node_code, node_name from sys_wf_node

   where process_id=#{id}

  </select>

第二種是開啟全局的延遲加載。通過在Mybatis的配置文件的<settings>標(biāo)簽下加上如下配置可開啟全局的延遲加載。開啟了全局的延遲加載后我們就無需再在各個(gè)嵌套的子查詢上配置延遲加載了，如果有某一個(gè)嵌套的子查詢是不需要延遲加載的，可以設(shè)置其fetchType=”eager”。設(shè)置在嵌套查詢上的fetchType可以覆蓋全局的延遲加載設(shè)置。

   <setting name="lazyLoadingEnabled" value="true"/>

1.2 分析

Mybatis的查詢結(jié)果是由ResultSetHandler接口的handleResultSets()方法處理的。ResultSetHandler接口只有一個(gè)實(shí)現(xiàn)，DefaultResultSetHandler。有興趣的朋友可以去看一下它的源碼，看一下它是如何處理結(jié)果集的。對(duì)于本文的主題，延遲加載相關(guān)的一個(gè)核心的方法就是如下這個(gè)創(chuàng)建返回結(jié)果對(duì)象的方法。

 private Object createResultObject(ResultSetWrapper rsw, ResultMap resultMap, ResultLoaderMap lazyLoader, String columnPrefix) throws SQLException {

  final List<Class<?>> constructorArgTypes = new ArrayList<Class<?>>();

  final List<Object> constructorArgs = new ArrayList<Object>();

  final Object resultObject = createResultObject(rsw, resultMap, constructorArgTypes, constructorArgs, columnPrefix);

  if (resultObject != null && !typeHandlerRegistry.hasTypeHandler(resultMap.getType())) {

   final List<ResultMapping> propertyMappings = resultMap.getPropertyResultMappings();

   for (ResultMapping propertyMapping : propertyMappings) {

    // issue gcode #109 && issue #149

    if (propertyMapping.getNestedQueryId() != null && propertyMapping.isLazy()) {

     return configuration.getProxyFactory().createProxy(resultObject, lazyLoader, configuration, objectFactory, constructorArgTypes, constructorArgs);

    }

   }

  }

  return resultObject;

 }

在上面方法中我們可以看到Mybatis先是根據(jù)正常情況創(chuàng)建一個(gè)返回類型對(duì)應(yīng)的對(duì)象。當(dāng)我們的ResultMap是包含子查詢的時(shí)候，其會(huì)在我們正常返回類型對(duì)象的基礎(chǔ)上創(chuàng)建對(duì)應(yīng)的代理對(duì)象。對(duì)，你沒有看錯(cuò)，就是我們的直接結(jié)果是代理對(duì)象，而不是子查詢對(duì)應(yīng)的屬性是代理對(duì)象。默認(rèn)是基于JavassistProxyFactory類創(chuàng)建的代理對(duì)象?？梢酝ㄟ^Mybatis的全局配置proxyFactory來更改，可選值是CGLIB和JAVASSIST，默認(rèn)是后者。需要使用CGLIB代理時(shí)注意加入CGLIB的包。

   <setting name="proxyFactory" value="CGLIB"/>

回過頭來看我們之前的那個(gè)延遲加載的配置，我們的一個(gè)查詢返回的是SysWfProcess類型的對(duì)象，其有一個(gè)SysWfNode集合類型的nodes屬性，nodes屬性是通過一個(gè)子查詢查出來的，而且是延遲加載。這個(gè)時(shí)候我們來進(jìn)行以下測(cè)試。

 @Test

  public void testLazyLoad1() {

   SysWfProcessMapper mapper = this.session.getMapper(SysWfProcessMapper.class);

   SysWfProcess process = mapper.selectByPrimaryKey(1);

   System.out.println(process.getClass());

  }

這個(gè)時(shí)候你會(huì)發(fā)現(xiàn)，上面的測(cè)試代碼的輸出結(jié)果是一個(gè)代理類，而不是我們自己的com.elim.learn.mybatis.model.SysWfProcess類型。另外如果你啟用了日志輸出，并且是打印的DEBUG日志，你會(huì)看到Mybatis是發(fā)了兩條SQL進(jìn)行查詢的。

2016-12-23 15:43:21,131 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Preparing: select id, template_id, creator, create_time from sys_wf_process where id = ?

2016-12-23 15:43:21,156 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: 1(Integer)

2016-12-23 15:43:21,269 DEBUG [main] (BaseJdbcLogger.java:145) - <==   Total: 1

class com.elim.learn.mybatis.model.SysWfProcess_$$_jvstc25_0

2016-12-23 15:43:21,271 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Preparing: select id, process_id, node_code, node_name from sys_wf_node where process_id=?

2016-12-23 15:43:21,272 DEBUG [main] (BaseJdbcLogger.java:145) - ==> Parameters: 1(Integer)

2016-12-23 15:43:21,274 DEBUG [main] (BaseJdbcLogger.java:145) - <==   Total: 2

但是如果我們把最后一個(gè)System.out.println()去掉，也就是說我們只是從數(shù)據(jù)庫中查詢出SysWfProcess對(duì)象，而不使用它的時(shí)候，通過查看日志輸出你會(huì)發(fā)現(xiàn)Mybatis又只會(huì)發(fā)送一條SQL，即只是查詢出SysWfProcess的信息。這是為什么呢？

1.3 aggressiveLazyLoading

這是因?yàn)楫?dāng)我們啟用了延遲加載時(shí)，我們的查詢結(jié)果返回的是一個(gè)代理對(duì)象，當(dāng)我們?cè)L問該代理對(duì)象的方法時(shí)，都會(huì)觸發(fā)加載所有的延遲加載的對(duì)象信息。這也就可以很好的解釋上面的場(chǎng)景。但是如果是這樣的設(shè)計(jì)，貌似Mybatis的延遲加載作用不大。但事實(shí)并非如此，這只是Mybatis的一個(gè)默認(rèn)策略，我們可以通過Mybatis的全局配置aggressiveLazyLoading來改變它，默認(rèn)是true，表示延遲加載時(shí)將在第一次訪問代理對(duì)象的方法時(shí)就將全部的延遲加載對(duì)象加載出來。當(dāng)設(shè)置為false時(shí)則會(huì)在我們第一次訪問延遲加載的對(duì)象的時(shí)候才會(huì)從數(shù)據(jù)庫加載對(duì)應(yīng)的數(shù)據(jù)。注意在延遲對(duì)象未從數(shù)據(jù)庫加載出來前，我們對(duì)應(yīng)延遲對(duì)象的屬性將是null，因?yàn)槟銢]有對(duì)它賦值。

  <setting name="aggressiveLazyLoading" value="fasle"/>

1.4 lazyLoadTriggerMethods

那如果我們?cè)O(shè)置了aggressiveLazyLoading=”false”，但又希望在調(diào)用某些方法之前把所有的延遲對(duì)象都從數(shù)據(jù)庫加載出來，怎么辦呢？這個(gè)時(shí)候我們可以通過lazyLoadTriggerMethods參數(shù)來指定需要加載延遲對(duì)象的方法調(diào)用。默認(rèn)是equals、clone、hashCode和toString，也就是說我們?cè)谡{(diào)用代理對(duì)象的這些方法之前就會(huì)把延遲加載對(duì)象從數(shù)據(jù)庫加載出來。

   <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString" />

Mybatis延遲加載生成的代理對(duì)象的代理過程，可以參考ProxyFactory的創(chuàng)建代理對(duì)象的過程，以下是基于Javassist創(chuàng)建的代理對(duì)象的代理過程，基于CGLIB的代理也是類似的。從下面的代碼我們可以看到Mybatis的代理對(duì)象需要從數(shù)據(jù)庫加載延遲對(duì)象時(shí)是在目標(biāo)方法被調(diào)用以前發(fā)生的，這就可以保證我們的目標(biāo)方法被調(diào)用時(shí)延遲加載的對(duì)象已經(jīng)從數(shù)據(jù)庫中加載出來了。

@Override

  public Object invoke(Object enhanced, Method method, Method methodProxy, Object[] args) throws Throwable {

   final String methodName = method.getName();

   try {

    synchronized (lazyLoader) {

     if (WRITE_REPLACE_METHOD.equals(methodName)) {

      Object original = null;

      if (constructorArgTypes.isEmpty()) {

       original = objectFactory.create(type);

      } else {

       original = objectFactory.create(type, constructorArgTypes, constructorArgs);

      }

      PropertyCopier.copyBeanProperties(type, enhanced, original);

      if (lazyLoader.size() > 0) {

       return new JavassistSerialStateHolder(original, lazyLoader.getProperties(), objectFactory, constructorArgTypes, constructorArgs);

      } else {

       return original;

      }

     } else {

      if (lazyLoader.size() > 0 && !FINALIZE_METHOD.equals(methodName)) {

       if (aggressive || lazyLoadTriggerMethods.contains(methodName)) {

        lazyLoader.loadAll();

       } else if (PropertyNamer.isProperty(methodName)) {

        final String property = PropertyNamer.methodToProperty(methodName);

        if (lazyLoader.hasLoader(property)) {

         lazyLoader.load(property);

        }

       }

      }

     }

    }

    return methodProxy.invoke(enhanced, args);

   } catch (Throwable t) {

    throw ExceptionUtil.unwrapThrowable(t);

   }

  }

 }

本文是介紹的都是基于<collection>這種關(guān)聯(lián)，其實(shí)<association>關(guān)聯(lián)的對(duì)象的延遲加載也是一樣的，它們的默認(rèn)策略也是一樣的。

感謝閱讀，希望能幫助到大家，謝謝大家對(duì)本站的支持！

您可能感興趣的文章: