Mybatis 源码解析(六) Mybatis方言支持

背景

现实中，我们经常会遇到使用oracle、mysql的客户，那么我们一般就需要工程同时支持这两种数据库。所以我们需要mybatis对方言进行支持，可以根据不同的数据源执行不同的sql语句。

实现

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。
比如

<select id="selectByExample"  databaseId="MySQL" parameterType="User" resultType="User">
        select
        <include refid="baseColumn"/>
        from user
        where
        1 = 1
        <include refid="whereClause"/>
    </select>

MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。
如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。

为支持多厂商特性只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

<databaseIdProvider type="DB_VENDOR" />

DB_VENDOR 对应的 databaseIdProvider 实现会将 databaseId 设置为 DatabaseMetaData#getDatabaseProductName() 返回的字符串,并且设置到全局设置之中。

    String databaseId = databaseIdProvider.getDatabaseId(environment.getDataSource());
    configuration.setDatabaseId(databaseId);

在提供了属性别名时，DB_VENDOR 的 databaseIdProvider 实现会将 databaseId 设置为第一个数据库产品名与属性中的名称相匹配的值，如果没有匹配的属性将会设置为 “null”。

VendorDatabaseIdProvider#getDatabaseName

 private String getDatabaseName(DataSource dataSource) throws SQLException {
    String productName = getDatabaseProductName(dataSource);
    if (this.properties != null) {
      for (Map.Entry<Object, Object> property : properties.entrySet()) {
        if (productName.contains((String) property.getKey())) {
          return (String) property.getValue();
        }
      }
      // no match, return null
      return null;
    }
    return productName;
  }

在这个例子中，如果 getDatabaseProductName() 返回“MySQL ”，databaseId 将被设置为“MySQL”，就会找到我们的第一个配置的XML。

---

所以我们就可以使用这个东西在我们的企业级开发应用中，通过配置不同的数据库源，它就会帮我们执行不同的XML。

以上就是Mybatis中方言的实现。

---

附录：

个性化type

由于通常情况下这些字符串都非常长而且相同产品的不同版本会返回不同的值，所以你可能想通过设置属性别名来使其变短，如下：

<databaseIdProvider type="DB_VENDOR">
  <property name="SQL Server" value="sqlserver"/>
  <property name="DB2" value="db2"/>
  <property name="Oracle" value="oracle" />
  <property name="MySQL" value="mysql" />
</databaseIdProvider>

spring集成

配置和上面稍微有些不同。

<bean name="databaseIdProvider" class="org.apache.ibatis.mapping.VendorDatabaseIdProvider">
        <property name="properties">
            <map>
                <entry key="MySQL" value="mysql"></entry>
                <entry key="ORACLE" value="oracle"></entry>
            </map>
        </property>
    </bean>

    <!-- 配置sqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <property name="dataSource" ref="dataSource"/>
        <property name="mapperLocations" value="classpath:com/wuhulala/**/*.xml"/>
        <property name="typeAliasesPackage" value="com.wuhulala.mybatis.entities"/>
        <property name="databaseIdProvider" ref="databaseIdProvider"/>
    </bean>