Spring+Mybatis 通过databaseIdProvi

概述

本人最近接到一个任务，就是将原来的一个可自配置信息管理系统升级成可同时兼容oracle数据库版本(原来是仅支持mysql的)。即便大部分的sql语句通用，但是还有许多语法存在差异，所以我们可以通过mybatis自身提供的databaseIdProvider解决这个问题，这里记录一下过程。

官方描述

databaseId 如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。

配置

1.配置文件目录结构

image.png

2.config.properties

image.png

把两个jdbc的信息整合在一起。

3.datasource.xml

 <bean id="mysql" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
        <property name="driverClassName" value="${mysql.driver}"/>
        <!-- 基本属性 url、passwordInfo、password -->
        <property name="url" value="${mysql.url}"/>
        <property name="username" value="${mysql.username}"/>
        <property name="password" value="${mysql.password}"/>

        <!-- 配置初始化大小、最小、最大 -->
        <property name="initialSize" value="${mysql.initialSize}"/>
        <property name="minIdle" value="${mysql.initialSize}"/>
        <property name="maxActive" value="${mysql.maxActive}"/>

        <property name="filters" value="config"/>
        <property name="connectionProperties"
                  value="config.decrypt=${mysql.password.decrypt};config.decrypt.key=${mysql.publickey}"/>

        <!-- 配置获取连接等待超时的时间 -->
        <!--<property name="maxWait" value="60000" />-->

        <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
        <property name="timeBetweenEvictionRunsMillis" value="60000"/>

        <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
        <property name="minEvictableIdleTimeMillis" value="300000"/>

        <property name="validationQuery" value="SELECT 'x'"/>
        <property name="testWhileIdle" value="true"/>
        <property name="testOnBorrow" value="false"/>
        <property name="testOnReturn" value="false"/>

        <!-- 打开PSCache，并且指定每个连接上PSCache的大小 -->
        <property name="poolPreparedStatements" value="false"/>
        <property name="maxPoolPreparedStatementPerConnectionSize" value="-1"/>


    </bean>

    <bean id="oracle" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
        <property name="driverClassName" value="${oracle.driver}"/>
        <!-- 基本属性 url、passwordInfo、password -->
        <property name="url" value="${oracle.url}"/>
        <property name="username" value="${oracle.username}"/>
        <property name="password" value="${oracle.password}"/>
        <!-- 配置初始化大小、最小、最大 -->
        <property name="initialSize" value="${oracle.initialSize}"/>
        <property name="minIdle" value="${oracle.initialSize}"/>
        <property name="maxActive" value="${oracle.maxActive}"/>
        <property name="filters" value="config"/>
        <property name="connectionProperties"
                  value="config.decrypt=${oracle.password.decrypt};config.decrypt.key=${oracle.publickey}"/>
        <!-- 配置获取连接等待超时的时间 -->
        <!--<property name="maxWait" value="60000" />-->
        <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
        <property name="timeBetweenEvictionRunsMillis" value="60000"/>
        <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
        <property name="minEvictableIdleTimeMillis" value="300000"/>
        <property name="validationQuery" value="SELECT 'x' from dual"/>
        <property name="testWhileIdle" value="true"/>
        <property name="testOnBorrow" value="false"/>
        <property name="testOnReturn" value="false"/>
        <!-- 打开PSCache，并且指定每个连接上PSCache的大小 -->
        <property name="poolPreparedStatements" value="false"/>
        <property name="maxPoolPreparedStatementPerConnectionSize" value="-1"/>
    </bean>
    <bean id="vendorProperties"
          class="org.springframework.beans.factory.config.PropertiesFactoryBean">
        <property name="properties">
            <props>
                <prop key="Oracle">oracle</prop>
                <prop key="MySQL">mysql</prop>
            </props>
        </property>
    </bean>
    <bean id="databaseIdProvider" class="org.apache.ibatis.mapping.VendorDatabaseIdProvider">
        <property name="properties" ref="vendorProperties"/>
    </bean>

这里两个数据源的bean对象大同小异，主要是下方增加了databseIdProvider的配置。

4.spring-mybatis.xml

<bean id="sqlSessionFactoryManager" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="${dataSource}"/>
    <property name="configLocation" value="classpath:mybatis.xml"/>
    <property name="mapperLocations" value="classpath*:com/hengzhe/hz/manager/data/biz/dao/*Mapper.xml"/>
    <property name="databaseIdProvider" ref="databaseIdProvider" />
    <property name="typeAliasesPackage" value="com.hengzhe.hz.manager.data.biz.dao"/>
    <property name="plugins">
        <list>
            <ref bean="paginationInterceptor"/>
        </list>
    </property>
</bean>

<bean id="dataMapperScannerConfigureManager" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.hengzhe.hz.manager.data.biz.dao" />
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryManager" />
</bean>

<bean id="transactionManagerManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="${dataSource}"/>
</bean>

增加sqlSessionFactory对databaseProvider的引入。

测试

至此，配置的工作已经结束，我们来进行一下本地测试。
1.DAO

public interface TestDBMapper {
    String selectTime();
}

2.mapper

<mapper namespace="com.hengzhe.hz.manager.data.biz.dao.TestDBMapper">
 <!--   <select id="selectTime"  resultType="String" databaseId="mysql">
        select now() from dual
    </select>
    <select id="selectTime"  resultType="String" databaseId="oracle">
        select sysdate from dual
    </select>-->
    <select id="selectTime"  resultType="String">
        select
        <if test="_databaseId == 'mysql'">
          now()
        </if>
        <if test="_databaseId == 'oracle'">
          sysdate
        </if>
        from dual
    </select>
</mapper>

此处注释掉的是第一种方法，就是一开始mybatis官方文档上说的，增加databaId就可以在运行时选择执行那一句sql。
第二种方法更为方便，可以节省很多重复性的代码。
3.JUnit测试用例

public class TestDBMapperTest extends AbstractTestBase {
    @Autowired TestDBMapper testDBMapper;
    @Test
    public void testSelectTime () {
        String time = testDBMapper.selectTime();
        System.out.println(time);
    }
}

输出结果:

image.png

由于目前配置的是mysql数据库，所以输出sql语句用的是now()函数。