MyBatis配置多資料來源

RebeccaZhong發表於2019-04-28

分類

MyBatis的多資料來源配置分2種，

多資料來源配置：兩個庫業務互不相干，a方法使用a庫的資料，b方法使用b庫的資料；
動態資料來源配置：兩個庫業務有關聯，如讀寫分離庫。

第一種直接配置2個單獨的資料來源，不同模組引入不同的sqlSessionFactory即可；第二種需要配置可動態切換的資料來源。

準備工作

兩種方式都需要在pom.xml檔案引入不同資料庫需要的jar包，此處以MySQL和Oracle為例：

<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.40</version>
</dependency>
<dependency>
  <groupId>com.oracle</groupId>
  <artifactId>ojdbc</artifactId>
  <version>7</version>
</dependency>
複製程式碼

此處Oracle的jar包因為版權問題，在maven中央倉庫中沒有，需要手動安裝。安裝教程

多資料來源配置

在applicationContext.xml中配置兩套資料來源即可

<!-- ===============第一個資料來源的配置開始=============== -->
<!--MySQL的資料庫配置-->
<bean id="mysqlDtaSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    <property name="driverClassName" value="${mysql.driverClassName}"/>
    <property name="url" value="${mysql.url}"/>
    <property name="username" value="${mysql.username}"/>
    <property name="password" value="${mysql.password}"/>
    <!-- 初始化連線大小 -->
    <property name="initialSize" value="${mysql.druid.initialSize}"></property>
    <!-- 連線池最大數量 -->
    <property name="maxActive" value="${mysql.druid.maxActive}"></property>
    <!-- 連線池最大空閒 -->
    <property name="maxIdle" value="${mysql.druid.maxIdle}"></property>
    <!-- 連線池最小空閒 -->
    <property name="minIdle" value="${mysql.druid.minIdle}"></property>
    <!-- 獲取連線最大等待時間 -->
    <property name="maxWait" value="${mysql.druid.maxWait}"></property>
</bean>
<!--配置MySQL的SqlSessionFactory-->
<bean id="sqlSessionFactoryMySQL" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="mysqlDtaSource"/>
    <property name="configLocation" value="classpath*:mybatis-config.xml" />
    <!-- 自動掃描mapping.xml檔案 -->
    <property name="mapperLocations" value="classpath*:com/rebecca/mybatismutildb/mysql/**/dao/mapper/*Mapper.xml"/>
    <property name="typeAliasesPackage" value="com.rebecca.mybatismutildb.mysql.**"/>
</bean>
<!--告訴框架掃描指定包中的mapper介面,然後為其自動的生成代理物件-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.rebecca.mybatismutildb.mysql.**.dao"/>
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryMySQL"/>
</bean>
<!--配置事務管理器-->
<bean id="mysqlTxManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="mysqlDtaSource"/>
</bean>
<!--配置事務的傳播特性-->
<tx:advice id="txAdvice" transaction-manager="mysqlTxManager">
    <tx:attributes>
        <tx:method name="get*" read-only="true"/>
        <tx:method name="list*" read-only="true"/>
        <tx:method name="query*" read-only="true"/>
        <tx:method name="*"/>
    </tx:attributes>
</tx:advice>
<!-- ===============第一個資料來源的配置結束=============== -->

<!-- ===============第二個資料來源的配置開始=============== -->
<!--Oracle的資料庫配置-->
<bean id="oracleDataSource" class="com.alibaba.druid.pool.DruidDataSource">
    <property name="driverClassName" value="${oracle.driverClassName}" />
    <property name="url" value="${oracle.url}" />
    <property name="username" value="${oracle.username}" />
    <property name="password" value="${oracle.password}" />
    <!-- 初始化連線大小 -->
    <property name="initialSize" value="${oracle.druid.initialSize}"></property>
    <!-- 連線池最大數量 -->
    <property name="maxActive" value="${oracle.druid.maxActive}"></property>
    <!-- 連線池最大空閒 -->
    <property name="maxIdle" value="${oracle.druid.maxIdle}"></property>
    <!-- 連線池最小空閒 -->
    <property name="minIdle" value="${oracle.druid.minIdle}"></property>
    <!-- 獲取連線最大等待時間 -->
    <property name="maxWait" value="${oracle.druid.maxWait}"></property>
</bean>
<!--配置SqlSessionFactory-->
<bean id="sqlSessionFactoryOracle" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="oracleDataSource"/>
    <property name="configLocation" value="classpath:mybatis-config.xml" />
    <!-- 自動掃描mapping.xml檔案 -->
    <property name="mapperLocations" value="classpath*:com/rebecca/mybatismutildb/oracle/**/dao/mapper/*Mapper.xml">
    </property>
    <property name="typeAliasesPackage" value="com.rebecca.mybatismutildb.oracle.**"/>
</bean>
<!--告訴框架掃描指定包中的mapper介面,然後為其自動的生成代理物件-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.rebecca.mybatismutildb.oracle.**.dao"/>
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryOracle"/>
</bean>

<!--配置事務管理器-->
<bean id="txManagerOracle" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="oracleDataSource"/>
</bean>

<!--配置事務的傳播特性-->
<tx:advice id="txAdviceOracle" transaction-manager="txManagerOracle">
    <tx:attributes>
        <tx:method name="get*" read-only="true"/>
        <tx:method name="list*" read-only="true"/>
        <tx:method name="query*" read-only="true"/>
        <tx:method name="*"/>
    </tx:attributes>
</tx:advice>
<!-- ===============第二個資料來源的配置結束=============== -->
複製程式碼

此處第一個資料來源指定去解析com/rebecca/mybatismutildb/mysql/**/dao/mapper包下的*Mapper.xml檔案，即指定這些dao的方法去連MySQL的資料來源；第二個資料來源指定去解析com/rebecca/mybatismutildb/oracle/**/dao/mapper包下的*Mapper.xml檔案，即指定這些dao的方法去連Oracle的資料來源。

applicationContext.xml配置好後，直接在指定的包內編碼即可。

動態資料來源配置

在applicationContext.xml中配置動態切換資料來源


<!--MySQL的資料庫配置-->
<bean id="mysqlDtaSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    <property name="driverClassName" value="${mysql.driverClassName}"/>
    <property name="url" value="${mysql.url}"/>
    <property name="username" value="${mysql.username}"/>
    <property name="password" value="${mysql.password}"/>
    <!-- 初始化連線大小 -->
    <property name="initialSize" value="${mysql.druid.initialSize}"></property>
    <!-- 連線池最大數量 -->
    <property name="maxActive" value="${mysql.druid.maxActive}"></property>
    <!-- 連線池最大空閒 -->
    <property name="maxIdle" value="${mysql.druid.maxIdle}"></property>
    <!-- 連線池最小空閒 -->
    <property name="minIdle" value="${mysql.druid.minIdle}"></property>
    <!-- 獲取連線最大等待時間 -->
    <property name="maxWait" value="${mysql.druid.maxWait}"></property>
</bean>
<!--Oracle的資料庫配置-->
<bean id="oracleDataSource" class="com.alibaba.druid.pool.DruidDataSource">
    <property name="driverClassName" value="${oracle.driverClassName}" />
    <property name="url" value="${oracle.url}" />
    <property name="username" value="${oracle.username}" />
    <property name="password" value="${oracle.password}" />
    <!-- 初始化連線大小 -->
    <property name="initialSize" value="${oracle.druid.initialSize}"></property>
    <!-- 連線池最大數量 -->
    <property name="maxActive" value="${oracle.druid.maxActive}"></property>
    <!-- 連線池最大空閒 -->
    <property name="maxIdle" value="${oracle.druid.maxIdle}"></property>
    <!-- 連線池最小空閒 -->
    <property name="minIdle" value="${oracle.druid.minIdle}"></property>
    <!-- 獲取連線最大等待時間 -->
    <property name="maxWait" value="${oracle.druid.maxWait}"></property>
</bean>
<!--告訴框架掃描指定包中的mapper介面,然後為其自動的生成代理物件-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.rebecca.mybatismutildb.mysql.**.dao,com.rebecca.mybatismutildb.oracle.**.dao"/>
</bean>
<!--配置事務管理器-->
<bean id="txManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="dataSource"/>
</bean>
<!--配置事務的傳播特性-->
<tx:advice id="txAdvice" transaction-manager="txManager">
    <tx:attributes>
        <tx:method name="get*" read-only="true"/>
        <tx:method name="list*" read-only="true"/>
        <tx:method name="query*" read-only="true"/>
        <tx:method name="*"/>
    </tx:attributes>
</tx:advice>

<!--配置SqlSessionFactory（此處自定義實現SqlSessionFactoryBean，以支援mapperLocations的萬用字元配置）-->
<bean id="sqlSessionFactory" class="com.rebecca.mybatismutildb.db.PackagesSqlSessionFactoryBean" scope="prototype">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatis-config.xml" />
    <!-- 自動掃描mapping.xml檔案 -->
    <property name="mapperLocations">
        <list>
            <value>classpath*:com/rebecca/mybatismutildb/mysql/**/dao/mapper/*Mapper.xml</value>
            <value>classpath*:com/rebecca/mybatismutildb/oracle/**/dao/mapper/*Mapper.xml</value>
        </list>
    </property>
    <property name="typeAliasesPackage" value="com.rebecca.mybatismutildb.**"/>
</bean>
<!--動態配置資料來源-->
<bean id="dataSource" class="com.rebecca.mybatismutildb.db.DynamicDataSource" >
    <property name="targetDataSources">
        <map key-type="java.lang.String">
            <!--通過不同的key決定用哪個dataSource-->
            <entry value-ref="mysqlDtaSource" key="mysqlDtaSource"></entry>
            <entry value-ref="oracleDataSource" key="oracleDataSource"></entry>
        </map>
    </property>
    <!--設定預設的dataSource-->
    <property name="defaultTargetDataSource" ref="mysqlDtaSource">
    </property>
</bean>

<!--動態資料來源切換 -->
<bean id="dataSourceAspect" class="com.rebecca.mybatismutildb.db.DataSourceAspect" />
<!--動態資料來源切換 spring的aop切面-->
<aop:config>
    <!--請設定 @Order(0)。否則可能出現 資料來源切換失敗問題！ 因為要在事務開啟之前就進行判斷，並進行切換資料來源！-->
    <aop:aspect ref="dataSourceAspect" order="0">
        <!--expression中要配置多個包時，注意用or連線，如：execution(* com.rebecca.mybatismutildb.mysql..dao..*.*(..)) or execution(* com.rebecca.mybatismutildb.oracle..dao..*.*(..)) ; 即攔截com.rebecca.mybatismutildb.mysql和com.rebecca.mybatismutildb.oracle下所有的dao包 -->
        <aop:pointcut id="dataSourcePointcut" expression="execution(* com.rebecca.mybatismutildb..dao..*.*(..)) "/>
        <aop:before pointcut-ref="dataSourcePointcut" method="changeDataSource" />
        <aop:after pointcut-ref="dataSourcePointcut" method="removeDataSource" />
    </aop:aspect>
</aop:config>

複製程式碼

applicationContext.xml中用到的相關類

DataSource 註解

package com.rebecca.mybatismutildb.db;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * DataSource的註解
 * @Author: rebecca
 * @Date: Created in 2019/4/25 17:27
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface DataSource {
    String value();
}
複製程式碼

DataSourceAspect 切面

package com.rebecca.mybatismutildb.db;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.LoggerFactory;

import java.lang.reflect.Method;

/**
 * 攔截所有帶有註解@DataSource的類和方法
 * @Author: rebecca
 * @Date: Created in 2019/4/25 17:28
 */
public class DataSourceAspect {
    private static final org.slf4j.Logger logger = LoggerFactory.getLogger(DataSourceAspect.class);
    /**
     * @Title: changeDataSource
     * @Description: 攔截目標方法，獲取由@DataSource指定的資料來源標識，設定到執行緒儲存中以便切換資料來源
     * @param joinPoint
     * @return: void
     */
    public void changeDataSource(JoinPoint joinPoint){
        Class<?> target = joinPoint.getTarget().getClass();
        MethodSignature methodSignature = (MethodSignature)joinPoint.getSignature();
        for(Class<?> clazz : target.getInterfaces()){
            resolveDataSource(clazz,methodSignature.getMethod());
        }
        resolveDataSource(target,methodSignature.getMethod());
        logger.debug("資料來源切換至--->", DataSourceContextHolder.getDbType());
    }

    private void resolveDataSource(Class<?> clazz, Method method){
        try {
            if(clazz.isAnnotationPresent(DataSource.class)){
                DataSource source = clazz.getAnnotation(DataSource.class);
                DataSourceContextHolder.setDbType(source.value());
            }

            Class<?>[] types = method.getParameterTypes();
            Method m = clazz.getDeclaredMethod(method.getName(), types);
            if(null != m && m.isAnnotationPresent(DataSource.class)){
                DataSource source = m.getAnnotation(DataSource.class);
                DataSourceContextHolder.setDbType(source.value());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public void removeDataSource() {
        try {
            DataSourceContextHolder.clearDbType();
            logger.debug("資料來源已移除！");
        } catch (Exception e) {
            e.printStackTrace();
            logger.debug("資料來源移除報錯！", e);
        }
    }
}

複製程式碼

DataSourceContextHolder 類

package com.rebecca.mybatismutildb.db;

/**
 * @Author: rebecca
 * @Description:
 * @Date: Created in 2019/3/28 11:43
 * @Modified By:
 */
public class DataSourceContextHolder {
    // 注意此處的屬性值要與applicationContext.xml中配置的一致
    public static final String DATA_SOURCE_MYSQL = "mysqlDtaSource";
    public static final String DATA_SOURCE_ORACLE = "oracleDataSource";
    //用ThreadLocal來設定當前執行緒使用哪個dataSource
    private static final ThreadLocal<String> contextHolder = new ThreadLocal<String>();

    public static void setDbType(String customerType) {
        contextHolder.set(customerType);
    }

    public static String getDbType() {
        return contextHolder.get();
    }

    public static void clearDbType() {
        contextHolder.remove();
    }
}

複製程式碼

DynamicDataSource 類

package com.rebecca.mybatismutildb.db;

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
import java.util.logging.Logger;

/**
 * 動態切換資料來源
 * @Author: rebecca
 * @Description:
 * @Date: Created in 2019/3/28 11:42
 * @Modified By:
 */
public class DynamicDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.getDbType();
    }

    @Override
    public Logger getParentLogger() {
        return null;
    }
}
複製程式碼

PackagesSqlSessionFactoryBean 類（自定義實現SqlSessionFactoryBean，以支援mapperLocations的萬用字元配置）

package com.rebecca.mybatismutildb.db;

import org.apache.commons.lang.StringUtils;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.core.type.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.util.ClassUtils;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * 支援包名的萬用字元解析
 * @Author: rebecca
 * @Description:
 * @Date: Created in 2019/3/28 15:30
 * @Modified By:
 */
public class PackagesSqlSessionFactoryBean extends SqlSessionFactoryBean {

    static final String DEFAULT_RESOURCE_PATTERN = "**/*.class";

    private Logger logger = LoggerFactory.getLogger(PackagesSqlSessionFactoryBean.class);

    @Override
    public void setTypeAliasesPackage(String typeAliasesPackage) {
        ResourcePatternResolver resolver = (ResourcePatternResolver) new PathMatchingResourcePatternResolver();
        MetadataReaderFactory metadataReaderFactory = new CachingMetadataReaderFactory(resolver);
        typeAliasesPackage = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
                ClassUtils.convertClassNameToResourcePath(typeAliasesPackage) + "/" + DEFAULT_RESOURCE_PATTERN;

        // 將載入多個絕對匹配的所有Resource
        // 將首先通過ClassLoader.getResource("META-INF")載入非模式路徑部分
        // 然後進行遍歷模式匹配
        try {
            List<String> result = new ArrayList<String>();
            Resource[] resources =  resolver.getResources(typeAliasesPackage);
            if(resources != null && resources.length > 0){
                MetadataReader metadataReader = null;
                for(Resource resource : resources){
                    if(resource.isReadable()){
                        metadataReader =  metadataReaderFactory.getMetadataReader(resource);
                        try {
                            result.add(Class.forName(metadataReader.getClassMetadata().getClassName()).getPackage().getName());
                        } catch (ClassNotFoundException e) {
                            e.printStackTrace();
                        }
                    }
                }
            }
            if(result.size() > 0) {
                super.setTypeAliasesPackage(StringUtils.join(result.toArray(), ","));
            }else{
                logger.warn("引數typeAliasesPackage:"+typeAliasesPackage+"，未找到任何包");
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
複製程式碼

在對應的dao的介面上，增加@DataSource(string value)註解，其中value的值是DataSourceContextHolder.DATA_SOURCE_MYSQL或DataSourceContextHolder.DATA_SOURCE_ORACLE。
因為在applicationContext.xml中配置的預設資料庫連線是MySQL，所以在連MySQL庫的介面上可以不寫@DataSource(string value)註解。同樣，此註解也可以加在介面的方法上。

參考連結

mybatis配置多資料來源

mybatis配置動態資料來源

Spring aop:pointcut--expression--多個execution連線方法

SpringBoot 配置多資料來源 MyBatis
2018-12-20
Spring BootMyBatis
Spring+MyBatis多資料來源配置實現
2014-05-25
SpringMyBatis
【教程】Spring+Mybatis環境配置多資料來源
2019-05-09
SpringMyBatis
多資料來源配置
2024-04-04
Springboot 多資料來源配置，結合tk-mybatis
2020-07-29
Spring BootMyBatis
Springboot 配置多資料來源Mybatis的UnderScore不生效
2018-04-27
Spring BootMyBatis
web 配置多資料來源
2020-12-29
Web
springboot+druid+mybatis plus的多資料來源配置
2018-08-09
Spring BootUIMyBatis
mybatis 多資料來源動態切換
2020-11-21
MyBatis
SpirngBoot整合Mybatis Plus多資料來源
2021-11-03
bootMyBatis
SpringBoot整合Mybatis多資料來源
2017-02-18
Spring BootMyBatis
Spring多資料來源配置
2019-03-01
Spring
Spring配置多資料來源
2016-12-12
Spring
Spring Boot + Mybatis 多資料來源配置實現讀寫分離
2018-09-30
Spring BootMyBatis
Spring Boot 配置多資料來源
2022-11-30
Spring Boot
Spring Boot 多資料來源配置
2022-11-23
Spring Boot
springboot多資料來源配置
2024-04-15
Spring Boot
springBoot 多資料來源配置
2024-04-18
Spring Boot
SpringBoot配置多資料來源
2024-07-11
Spring Boot
Spring Boot 2.x基礎教程：MyBatis的多資料來源配置
2020-06-28
Spring BootMyBatis
談一談 Spring-Mybatis 在多資料來源配置上的坑
2018-11-28
SpringMyBatis
談一談Spring-Mybatis在多資料來源配置上的坑
2018-11-26
SpringMyBatis
全程解析，MyBatis在SpringBoot中的動態多資料來源配置
2020-12-07
MyBatisSpring Boot
SpringBoot 整合多資料來源（MyBatis + Druid）
2021-09-09
Spring BootMyBatisUI
多資料來源結合mybatis-plus的使用
2020-11-24
MyBatis
Spring Boot 原始碼分析資料來源 + Mybatis 配置
2018-06-18
Spring Boot原始碼MyBatis
基於SpirngBoot2.0+ 的 SpringBoot+Mybatis 多資料來源配置
2018-12-05
Spring BootMyBatis
SpringBoot 的多資料來源配置
2020-12-30
Spring Boot
SpringMVC連線多資料來源配置
2017-04-14
SpringMVC
springbootdruidmybatis多資料來源配置
2017-09-16
Spring BootUIMyBatis
Spring Boot MyBatis 動態資料來源切換、多資料來源，讀寫分離
2017-12-21
Spring BootMyBatis
MyBatis整合雙資料來源
2020-06-04
MyBatis
Spring-Boot 多資料來源配置+動態資料來源切換+多資料來源事物配置實現主從資料庫儲存分離
2020-07-18
Springboot資料庫
spring-mybatis專案搭建（支援多資料來源）
2017-04-09
SpringMyBatis
Spring Boot 入門系列（二十三）整合Mybatis，實現多資料來源配置！
2021-09-02
Spring BootMyBatis
MyBatis初級實戰之四：druid多資料來源
2021-01-20
MyBatisUI
Spring Boot 中使用 MyBatis 整合 Druid 多資料來源
2017-10-20
Spring BootMyBatisUI
使用Spring Boot配置多個資料來源 - Udith
2019-06-24
Spring Boot

MyBatis配置多資料來源

分類

準備工作

多資料來源配置

動態資料來源配置

參考連結

相關文章