Spring mybatis源码篇章-XMLLanguageDriver解析sql包装为SqlSource

时间：2022-09-20 18:38:56

通过阅读源码对实现机制进行了解有利于陶冶情操，承接前文Spring mybatis源码篇章-Mybatis的XML文件加载

前话

前文通过Spring中配置mapperLocations属性来进行对mybatis的XML文件的解析，本文将在前文的基础上简单的来看下Mybatis的使用的基础语法以及解析原理

动态sql语法

具体的动态sql的使用可在官网查看Mybatis 3 | Dynamic SQL

1.if，条件判断

<select id="findActiveBlogWithTitleLike"

     resultType="Blog">

  SELECT * FROM BLOG

  WHERE state = ‘ACTIVE’

  <if test="title != null">

    AND title like #{title}

  </if>

</select>

与JAVA语意中的条件判断是类似的

2.choose/when/otherwise，类似于if/else语句判断

<select id="findActiveBlogLike"

     resultType="Blog">

  SELECT * FROM BLOG WHERE state = ‘ACTIVE’

  <choose>

    <when test="title != null">

      AND title like #{title}

    </when>

    <when test="author != null and author.name != null">

      AND author_name like #{author.name}

    </when>

    <otherwise>

      AND featured = 1

    </otherwise>

  </choose>

</select>

3.trim，多搭配where节点进行SQL语句拼装

<!--prefix/suffix属性均是由prefixOverrides/suffixOverrides的条件满足后实行的覆盖策略-->

<!--对开头有AND或者OR的值直接替换为WHERE-->

<trim prefix="WHERE" prefixOverrides="AND |OR ">

  ...

</trim>

trim节点使用偏广泛，可以与多个节点进行搭配使用

4.set，类比数据库的set关键字(其会消除多余的,分隔符)

<update id="updateAuthorIfNecessary">

  update Author

    <set>

      <if test="username != null">username=#{username},</if>

      <if test="password != null">password=#{password},</if>

      <if test="email != null">email=#{email},</if>

      <if test="bio != null">bio=#{bio}</if>

    </set>

  where id=#{id}

</update>

5.foreach，集合迭代输出

<select id="selectPostIn" resultType="domain.blog.Post">

  SELECT *

  FROM POST P

  WHERE ID in

  <foreach item="item" index="index" collection="list"

      open="(" separator="," close=")">

        #{item}

  </foreach>

</select>

6.bind，创建额外属性变量并应用

<select id="selectBlogsLike" resultType="Blog">

  <bind name="pattern" value="'%' + _parameter.getTitle() + '%'" />

  SELECT * FROM BLOG

  WHERE title LIKE #{pattern}

</select>

7._paramter和_databaseId是mybatis的内部属性。

前者代表方法参数类，多与bind节点搭配使用；

后者则为mybatis主文件中databaseIdProvider节点配置的

<databaseIdProvider type="VENDOR">

	<property name="Oracle" value="oracle"></property>

	<property name="Mysql" value="mysql"></property>

</databaseIdProvider>

抑或是可通过Spring来指定

<bean id="databaseIdProvider" class="org.apache.ibatis.mapping.VendorDatabaseIdProvider">

	<property name="properties">

		<props>

			<prop key="Oracle">oracle</prop>

			<prop key="Mysql">mysql</prop>

		</props>

	</property>

</bean>

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">

	<property name="databaseIdProvider" ref="databaseIdProvider" />

</bean>

值得注意的是，只有上述的样例有配置过，方可使用_databaseId属性

XMLLanguageDriver

现在笔者将从源码的角度来看下mybatis是如何去解析上述的节点

mybatis默认的XML驱动为XMLLanguageDriver。从这个类去深究一发

此处直接查看其主要方法createSqlSource()

  public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {

    XMLScriptBuilder builder = new XMLScriptBuilder(configuration, script, parameterType);

    return builder.parseScriptNode();

  }

引出XMLScriptBuilder#parseScriptNode()方法，我们再继续观察如何创建SqlSource对象(真实目的也是为了解析SQL节点)

  public SqlSource parseScriptNode() {

	//获取select/update/insert/delete节点下的Sql语句节点包装成相应的SqlNode对象

	//每个CRUD语句可能都有多个SqlNode对象

    List<SqlNode> contents = parseDynamicTags(context);

	//包装成混合型SqlNode对象，'Mixed'译为混合，很贴切的名字

    MixedSqlNode rootSqlNode = new MixedSqlNode(contents);

    SqlSource sqlSource = null;

	//是否为动态语句

    if (isDynamic) {

      sqlSource = new DynamicSqlSource(configuration, rootSqlNode);

    } else {

	  //否则生成普通版SqlSource

      sqlSource = new RawSqlSource(configuration, rootSqlNode, parameterType);

    }

    return sqlSource;

  }

笔者此处简单看下对各类节点的归类处理，也就是去看下XMLScriptBuilder#parseDynamicTags()方法

  private List<SqlNode> parseDynamicTags(XNode node) {

	//获取CRUD节点下所有子节点，包括文本内容<trim>等动态sql节点

    List<SqlNode> contents = new ArrayList<SqlNode>();

    NodeList children = node.getNode().getChildNodes();

    for (int i = 0; i < children.getLength(); i++) {

      XNode child = node.newXNode(children.item(i));

      if (child.getNode().getNodeType() == Node.CDATA_SECTION_NODE || child.getNode().getNodeType() == Node.TEXT_NODE) {

		//直接获取数据内容，类似"select * from .."纯文本语句

        String data = child.getStringBody("");

        TextSqlNode textSqlNode = new TextSqlNode(data);

		//TextSqlNode对象主要会去检查纯文本语句是否含有'${'和'}'字符串，有则为true

        if (textSqlNode.isDynamic()) {

          contents.add(textSqlNode);

          isDynamic = true;

        } else {

		//返回最普通的含有data的StaticTextSqlNode对象

          contents.add(new StaticTextSqlNode(data));

        }

      } else if (child.getNode().getNodeType() == Node.ELEMENT_NODE) { // issue #628

        String nodeName = child.getNode().getNodeName();

		//获取节点名对应的NodeHandler对象，无非就是TrimNodeHandler/WhereNodeHandler等等

        NodeHandler handler = nodeHandlers.get(nodeName);

        if (handler == null) {

          throw new BuilderException("Unknown element <" + nodeName + "> in SQL statement.");

        }

		//调用同一接口实现解析生成SqlNode对象并统一存入List<SqlNode>集合中

        handler.handleNode(child, contents);

        isDynamic = true;

      }

    }

    return contents;

  }

上述代码通过parseDynamicTags()方法获取的SqlNode集合是为了方便SqlSource类去真正的生成SQL语句

而org.apache.ibatis.scripting.xmltags.SqlNode是一个接口，内部只有一个apply()方法，其下有TrimSqlNode/IfSqlNode等实现类用于不同场景

小结

对上述的代码以及讲解作下简单的小结

1.mybatis默认的mapper解析驱动为org.apache.ibatis.scripting.xmltags.XMLLanguageDriver类，基本上使用此类即可

2.用户在使用_databaseId的时候，请确保相应的databaseIdProvider已配置

3.mybatis动态SQL节点的解析最终都会被包装成org.apache.ibatis.scripting.xmltags.MixedSqlSource类，里面包含了各种解析的SqlNode集合，其目的就是通过此接口来解析相应的动态SQL

4.最终保存在MappedStatement对象中的SqlSource类为org.apache.ibatis.scripting.xmltags.DynamicSqlSource，此类也比较关键，主要是用于返回String类型的SQL，后文会分析

相关文章