强大的动态SQL

1 动态SQL#

那么，问题来了： 什么是动态SQL? 动态SQL有什么作用？

传统的使用JDBC的方法，相信大家在组合复杂的的SQL语句的时候，需要去拼接，稍不注意哪怕少了个空格，都会导致错误。Mybatis的动态SQL功能正是为了解决这种问题， 其通过 if, choose, when, otherwise, trim, where, set, foreach标签，可组合成非常灵活的SQL语句，从而提高开发人员的效率。下面就去感受Mybatis动态SQL的魅力吧。

2 if: 你们能判断，我也能判断！#

作为程序猿，谁不懂 if ! 在mybatis中也能用 if 啦：

<select id="findUserById" resultType="user">
    select * from user where
        <if test="id != null">
               id=#{id}
        </if>
    and deleteFlag=0;
</select>

上面例子： 如果传入的id 不为空， 那么才会SQL才拼接id = #{id}。 这个相信大家看一样就能明白，不多说。细心的人会发现一个问题：“你这不对啊！ 要是你传入的id为null, 那么你这最终的SQL语句不就成了 select * from user where and deleteFlag=0, 这语句有问题！”

是啊，这时候，mybatis的 where 标签就该隆重登场啦。

3 where, 有了我，SQL语句拼接条件神马的都是浮云！#

咱们通过where改造一下上面的例子：

<select id="findUserById" resultType="user">
    select * from user
        <where>
            <if test="id != null">
                id=#{id}
            </if>
            and deleteFlag=0;
        </where>
</select>

有些人就要问了： “你这都是些什么玩意儿！ 跟上面的相比， 不就是多了个where标签嘛！ 那这个还会不会出现 select * from user where and deleteFlag=0 ？”

的确，从表面上来看，就是多了个where标签而已， 不过实质上， mybatis是对它做了处理，当它遇到AND或者OR这些，它知道怎么处理。其实我们可以通过 trim 标签去自定义这种处理规则。

4 trim : 我的地盘，我做主！#

上面的where标签，其实用trim 可以表示如下：

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

它的意思就是：当WHERE后紧随AND或则OR的时候，就去除AND或者OR。 除了WHERE以外，其实还有一个比较经典的实现，那就是SET。

5 set: 信我，不出错！#

<update id="updateUser" parameterType="com.dy.entity.User">
    update user set
        <if test="name != null">
            name = #{name},
        </if>
        <if test="password != null">
            password = #{password},
        </if>
        <if test="age != null">
            age = #{age}
        </if>
        <where>
            <if test="id != null">
                id = #{id}
            </if>
            and deleteFlag = 0;
        </where>
</update>

问题又来了： “如果我只有name不为null, 那么这SQL不就成了 update set name = #{name}, where ........ ? 你那name后面那逗号会导致出错啊！”

是的，这时候，就可以用mybatis为我们提供的set 标签了。下面是通过set标签改造后：

<update id="updateUser" parameterType="com.dy.entity.User">
    update user
        <set>
            <if test="name != null">name = #{name},</if>
            <if test="password != null">password = #{password},</if>
            <if test="age != null">age = #{age},</if>
        </set>
        <where>
            <if test="id != null">
                id = #{id}
            </if>
            and deleteFlag = 0;
        </where>
</update>

这个用trim 可表示为：

<trim prefix="SET" suffixOverrides=",">
  ...
</trim>

WHERE是使用的 prefixOverrides（前缀）， SET是使用的 suffixOverrides （后缀）， 看明白了吧！

6 foreach: 你有for, 我有foreach, 不要以为就你才屌！#

java中有for, 可通过for循环， 同样， mybatis中有foreach, 可通过它实现循环，循环的对象当然主要是java容器和数组。

<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>

将一个 List 实例或者数组作为参数对象传给 MyBatis：当这么做的时候，MyBatis 会自动将它包装在一个 Map 中并以名称为键。List 实例将会以“list”作为键，而数组实例的键将是“array”。

同样，当循环的对象为map的时候，index其实就是map的key。

7 choose: 我选择了你，你选择了我！#

Java中有switch, mybatis有choose。

<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>

以上例子中：当title和author都不为null的时候， 那么选择二选一（前者优先）， 如果都为null, 那么就选择 otherwise中的， 如果tilte和author只有一个不为null, 那么就选择不为null的那个。

8 动态SQL解析原理#

我们在使用mybatis的时候，会在xml中编写sql语句。比如这段动态sql代码：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

mybatis底层是如何构造这段sql的？下面带着这个疑问，我们一步一步分析。

8.1 关于动态SQL的接口和类##

1. SqlNode接口，简单理解就是xml中的每个标签，比如上述sql的update,trim,if标签：

public interface SqlNode {
      boolean apply(DynamicContext context);
}

 

SqlNode相关类图

1. SqlSource Sql源接口，代表从xml文件或注解映射的sql内容，主要就是用于创建BoundSql，有实现类DynamicSqlSource(动态Sql源)，StaticSqlSource(静态Sql源)等：

public interface SqlSource {
      BoundSql getBoundSql(Object parameterObject);
}

 

SqlSource相关类图

1. BoundSql类，封装mybatis最终产生sql的类，包括sql语句，参数，参数源数据等参数：

 

BoundSql类

1. XNode，一个Dom API中的Node接口的扩展类：

 

XNode类

1. BaseBuilder接口及其实现类(属性，方法省略了，大家有兴趣的自己看),这些Builder的作用就是用于构造sql：

 

BaseBuilder相关类图

下面我们简单分析下其中4个Builder：

XMLConfigBuilder：解析mybatis中configLocation属性中的全局xml文件，内部会使用XMLMapperBuilder解析各个xml文件。

XMLMapperBuilder：遍历mybatis中mapperLocations属性中的xml文件中每个节点的Builder，比如user.xml，内部会使用XMLStatementBuilder处理xml中的每个节点。

XMLStatementBuilder：解析xml文件中各个节点，比如select,insert,update,delete节点，内部会使用XMLScriptBuilder处理节点的sql部分，遍历产生的数据会丢到Configuration的mappedStatements中。

XMLScriptBuilder：解析xml中各个节点sql部分的Builder。

1. LanguageDriver接口及其实现类(属性，方法省略了，大家有兴趣的自己看)，该接口主要的作用就是构造sql:

 

LanguageDriver相关类图

简单分析下XMLLanguageDriver(处理xml中的sql，RawLanguageDriver处理静态sql)：XMLLanguageDriver内部会使用XMLScriptBuilder解析xml中的sql部分。

8.2 源码分析走起##

Spring与Mybatis整合的时候需要配置SqlSessionFactoryBean，该配置会加入数据源和mybatis xml配置文件路径等信息：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatisConfig.xml"/>
    <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
</bean>

我们就分析这一段配置背后的细节：

SqlSessionFactoryBean实现了Spring的InitializingBean接口，InitializingBean接口的afterPropertiesSet方法中会调用buildSqlSessionFactory方法，该方法内部会使用XMLConfigBuilder解析属性configLocation中配置的路径，还会使用XMLMapperBuilder属性解析mapperLocations属性中的各个xml文件。部分源码如下：

  protected SqlSessionFactory buildSqlSessionFactory() throws IOException {

      Configuration configuration;

      XMLConfigBuilder xmlConfigBuilder = null;
      if (this.configLocation != null) {
          // 1. 构建XMLConfigBuilder
          xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
          configuration = xmlConfigBuilder.getConfiguration();
      } else {
          if (logger.isDebugEnabled()) {
              logger.debug("Property 'configLocation' not specified, using default MyBatis Configuration");
          }
          configuration = new Configuration();
          configuration.setVariables(this.configurationProperties);
      }

      if (this.objectFactory != null) {
          configuration.setObjectFactory(this.objectFactory);
      }

      if (this.objectWrapperFactory != null) {
          configuration.setObjectWrapperFactory(this.objectWrapperFactory);
      }

      if (hasLength(this.typeAliasesPackage)) {
          String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage,
          ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
          for (String packageToScan : typeAliasPackageArray) {
              configuration.getTypeAliasRegistry().registerAliases(packageToScan,
                typeAliasesSuperType == null ? Object.class : typeAliasesSuperType);
              if (logger.isDebugEnabled()) {
                  logger.debug("Scanned package: '" + packageToScan + "' for aliases");
              }
          }
      }

      if (!isEmpty(this.typeAliases)) {
          for (Class<?> typeAlias : this.typeAliases) {
              configuration.getTypeAliasRegistry().registerAlias(typeAlias);
              if (logger.isDebugEnabled()) {
                  logger.debug("Registered type alias: '" + typeAlias + "'");
              }
          }
      }

      if (!isEmpty(this.plugins)) {
          for (Interceptor plugin : this.plugins) {
              configuration.addInterceptor(plugin);
              if (logger.isDebugEnabled()) {
                  logger.debug("Registered plugin: '" + plugin + "'");
              }
          }
      }

      if (hasLength(this.typeHandlersPackage)) {
          String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage,
          ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
          for (String packageToScan : typeHandlersPackageArray) {
              configuration.getTypeHandlerRegistry().register(packageToScan);
              if (logger.isDebugEnabled()) {
                  logger.debug("Scanned package: '" + packageToScan + "' for type handlers");
              }
          }
      }

      if (!isEmpty(this.typeHandlers)) {
          for (TypeHandler<?> typeHandler : this.typeHandlers) {
              configuration.getTypeHandlerRegistry().register(typeHandler);
              if (logger.isDebugEnabled()) {
                  logger.debug("Registered type handler: '" + typeHandler + "'");
              }
          }
      }

      if (xmlConfigBuilder != null) {
          try {
              // 2. 解析xmlConfigBuilder
              xmlConfigBuilder.parse();

              if (logger.isDebugEnabled()) {
                  logger.debug("Parsed configuration file: '" + this.configLocation + "'");
              }
          } catch (Exception ex) {
              throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex);
          } finally {
              ErrorContext.instance().reset();
          }
      }

      if (this.transactionFactory == null) {
          this.transactionFactory = new SpringManagedTransactionFactory();
      }

      Environment environment = new Environment(this.environment, this.transactionFactory, this.dataSource);
      configuration.setEnvironment(environment);

      if (this.databaseIdProvider != null) {
          try {
              configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
          } catch (SQLException e) {
              throw new NestedIOException("Failed getting a databaseId", e);
          }
      }

      if (!isEmpty(this.mapperLocations)) {
          for (Resource mapperLocation : this.mapperLocations) {
              if (mapperLocation == null) {
                  continue;
              }

              try {
                  // 3. 构建XMLMapperBuilder，并解析Mapper文件
                  XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
              configuration, mapperLocation.toString(), configuration.getSqlFragments());
                  xmlMapperBuilder.parse();
              } catch (Exception e) {
                  throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
              } finally {
                  ErrorContext.instance().reset();
              }

              if (logger.isDebugEnabled()) {
                  logger.debug("Parsed mapper file: '" + mapperLocation + "'");
              }
          }
      } else {
          if (logger.isDebugEnabled()) {
              logger.debug("Property 'mapperLocations' was not specified or no matching resources found");
          }
      }

      return this.sqlSessionFactoryBuilder.build(configuration);
  }

再来看下，XMLConfigBudiler.parse()方法源码细节：

  public Configuration parse() {
      if (parsed) {
          throw new BuilderException("Each XMLConfigBuilder can only be used once.");
      }
      parsed = true;
      parseConfiguration(parser.evalNode("/configuration"));
      return configuration;
  }

  private void parseConfiguration(XNode root) {
      try {
          propertiesElement(root.evalNode("properties")); //issue #117 read properties first
          typeAliasesElement(root.evalNode("typeAliases"));
          pluginElement(root.evalNode("plugins"));
          objectFactoryElement(root.evalNode("objectFactory"));
          objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
          settingsElement(root.evalNode("settings"));
          environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
          databaseIdProviderElement(root.evalNode("databaseIdProvider"));
          typeHandlerElement(root.evalNode("typeHandlers"));
          // 解析Mapper映射文件
          mapperElement(root.evalNode("mappers"));
      } catch (Exception e) {
          throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
      }
  }

  private void mapperElement(XNode parent) throws Exception {
      if (parent != null) {
          for (XNode child : parent.getChildren()) {
              if ("package".equals(child.getName())) {
                  String mapperPackage = child.getStringAttribute("name");
                  configuration.addMappers(mapperPackage);
              } else {
                  String resource = child.getStringAttribute("resource");
                  String url = child.getStringAttribute("url");
                  String mapperClass = child.getStringAttribute("class");
                  if (resource != null && url == null && mapperClass == null) {
                      ErrorContext.instance().resource(resource);
                      InputStream inputStream = Resources.getResourceAsStream(resource);
                      // 构建XMLMapperBuilder对象
                      XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
                      mapperParser.parse();
                  } else if (resource == null && url != null && mapperClass == null) {
                      ErrorContext.instance().resource(url);
                      InputStream inputStream = Resources.getUrlAsStream(url);
                      // 构建XMLMapperBuilder对象
                      XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
                      mapperParser.parse();
                  } else if (resource == null && url == null && mapperClass != null) {
                      Class<?> mapperInterface = Resources.classForName(mapperClass);
                      configuration.addMapper(mapperInterface);
                  } else {
                      throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
                  }
              }
          }
      }
  }

由于XMLConfigBuilder内部也是使用XMLMapperBuilder，我们就看看XMLMapperBuilder的解析细节：

 

XMLMapperBuilder.parse()源码

 

XMLMapperBuilder.configurationElement()源码

我们关注一下，增删改查节点的解析：

 

增删改查节点的解析

XMLStatementBuilder的解析：

 

XMLStatementBuilder的解析

默认会使用XMLLanguageDriver创建SqlSource（Configuration构造函数中设置）。

XMLLanguageDriver创建SqlSource：

 

XMLLanguageDriver创建SqlSource

XMLScriptBuilder解析sql：

 

XMLScriptBuilder解析sql

得到SqlSource之后，会放到Configuration中，有了SqlSource，就能拿BoundSql了，BoundSql可以得到最终的sql。

8.3 实例分析##

以下面的xml解析大概说下parseDynamicTags的解析过程：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

parseDynamicTags方法的返回值是一个List，也就是一个Sql节点集合。SqlNode本文一开始已经介绍，分析完解析过程之后会说一下各个SqlNode类型的作用。

1. 首先根据update节点(Node)得到所有的子节点，分别是3个子节点：

(1) 文本节点 \n UPDATE users；

(2) trim子节点 ...；

(3) 文本节点 \n where id = #{id}；

1. 遍历各个子节点：

(1) 如果节点类型是文本或者CDATA，构造一个TextSqlNode或StaticTextSqlNode；

(2) 如果节点类型是元素，说明该update节点是个动态sql，然后会使用NodeHandler处理各个类型的子节点。这里的NodeHandler是XMLScriptBuilder的一个内部接口，其实现类包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看类名也就明白了这个Handler的作用，比如我们分析的trim节点，对应的是TrimHandler；if节点，对应的是IfHandler...这里子节点trim被TrimHandler处理，TrimHandler内部也使用parseDynamicTags方法解析节点。