SpringBoot + Mybatis 多数据源配置

三十的狼 2020-04-04

展开全文

在实际中，一个项目一般只会对应着一个数据源，但也有些需要多个数据源的项目。在本文中，会介绍SpringBoot + Mybatis框架下如何配置多个数据源，并能代码中自主切换。

一、禁掉SpringBoot的自动配置数据源类，并写新的配置类

在SpringBoot中，程序会自动读取src/main/resources/application.properties文件中的spring.datasource.xxx的数据源配置信息，所以我们需要配置多数据源的话，要先把这个自动读取数据源配置信息的类禁掉。禁掉该类的方法是：在SpringBoot的启动类中，使用@SpringBootApplication注解时把该类（DataSourceAutoConfiguration.class）排除。代码如下：

/**
 * SpringBoot启动程序
 *
 * @author hrc
 * @date 2018年10月9日
 */
@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class }) // 禁掉
@EnableAutoConfiguration
@MapperScan("com.zldc.weekly.mapper")
public class StarApp extends SpringBootServletInitializer {
   @Override
   protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
      return builder.sources(StarApp.class);
   }
   public static void main(String[] args) {
      SpringApplication.run(StarApp.class, args);
   }
}

禁掉自动读取数据源配置类之后，需要自己写读取不同数据源的配置信息代码了，要配置多少个数据源，就多少个配置方法，相关代码如下：

   /**
    * mysql数据源
    * @return
    */
    @Bean("mysql") // bean的名称
    @ConfigurationProperties(prefix = "spring.datasource.mysql") // application.properteis中对应属性的前缀
   public DataSource mysqlDataSource() {
        return DataSourceBuilder.create().build();
    }
   /**
    * oracle数据源
    * @return
    */
   @Bean("oracle") // bean的名称
    @ConfigurationProperties(prefix = "spring.datasource.oracle") // application.properteis中对应属性的前缀
   public DataSource oracleDataSource() {
        return DataSourceBuilder.create().build();
    }

二、自动切换数据源

数据源类型常量类（也可以是枚举类），具体代码如下：

/**
 * 数据源名称
 *
 * @author hrc
 * @date 2018年10月9日
 */
public class DataSourceDialect {
   public static final String ORACLE="oracle";
   public static final String MYSQL="mysql"; 
}

数据源切换类，构建一个数据源类型容器，并提供了向其中设置、获取和清空数据源类型的方法，具体代码如下：

/**
 * 数据源类型容器
 *
 * @author hrc
 * @date 2018年10月9日
 */
public class DataSourceSwitch {
   /**
    * 保存数据源类型线程安全容器
    */
   private static final ThreadLocal<String> contextHolder = new ThreadLocal<String>();
   /**
    * 设置数据源类型
    * @param dataSourceType  数据源类型
    */
   public static void setDataSourceType (String dataSourceType) {
      contextHolder.set(dataSourceType);
   }
   /**
    * 获取数据源类型
    * @return
    */
   public static String getDataSourceType(){ 
        return (String) contextHolder.get(); 
    } 
   /**
    * 清空数据源类型
    */
    public static void clearDataSourceType(){ 
        contextHolder.remove(); 
    } 
}

动态切换数据源类，该类需要继承AbstractRoutingDataSource类，并重写determineCurrentLookupKey()方法，从数据源类型容器中获取当前线程的数据源类型。相关代码如下：

public class DynamicDataSource extends AbstractRoutingDataSource{ 
    @Override 
    protected Object determineCurrentLookupKey() { 
        return DataSourceSwitch.getDataSourceType(); 
    } 
}

三、重写SpringBoot的数据源配置

根据新配置的多数据源和新写的动态切换数据源类，配置新的SpringBoot数据源，具体代码如下：

    /**
     * 动态数据源配置
     *
     * @return
     */
    @Primary
    @Bean("dataSource")
    public DynamicDataSource dataSource(@Qualifier("mysql") DataSource mysql,
                                         @Qualifier("oracle") DataSource oracle) {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DataSourceDialect.MYSQL, mysql);
        targetDataSources.put(DataSourceDialect.ORACLE, oracle);
        dynamicDataSource.setTargetDataSources(targetDataSources);
        // 设置默认的数据源
        dynamicDataSource.setDefaultTargetDataSource(mysql);
        return dynamicDataSource;
    }

根据动态数据源配置，创建sqlSessionFactory，具体代码如下：

    @Primary
    @Bean("sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("mysql") DataSource mysql, @Qualifier("oracle") DataSource oracle) throws Exception {
       SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
       sessionFactory.setDataSource(this.dataSource(mysql, oracle));
       sessionFactory.setTypeAliasesPackage(env.getProperty("mybatis.typeAliasesPackage"));
       sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(env.getProperty("mybatis.mapper-locations")));
       return sessionFactory.getObject();
    }

根据动态数据源配置，创建transactionManager，具体代码如下：

   @Bean("transactionManager")
   public DataSourceTransactionManager transactionManager(@Qualifier("dataSource") DynamicDataSource dataSource) throws Exception {
      return new DataSourceTransactionManager(dataSource);
   }

四、数据源配置类的整合代码

/**
 * 数据源配置
 * @author hrc
 * @date 2018年10月9日
 */
@Configuration
public class DataSourceConfig {
    @Autowired
    private Environment env;
    /**
     * mysql数据源
     * @return
     */
    @Bean("mysql") // bean的名称
    @ConfigurationProperties(prefix = "spring.datasource.mysql") // application.properteis中对应属性的前缀
    public DataSource mysqlDataSource() {
        return DataSourceBuilder.create().build();
    }
    /**
     * oracle数据源
     * @return
     */
    @Bean("oracle") // bean的名称
    @ConfigurationProperties(prefix = "spring.datasource.oracle") // application.properteis中对应属性的前缀
    public DataSource oracleDataSource() {
        return DataSourceBuilder.create().build();
    }
    /**
     * 动态数据源配置
     * @return
     */
    @Primary
    @Bean("dataSource")
    public DynamicDataSource dataSource(@Qualifier("mysql") DataSource mysql,
                                         @Qualifier("oracle") DataSource oracle) {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DataSourceDialect.MYSQL, mysql);
        targetDataSources.put(DataSourceDialect.ORACLE, oracle);
        dynamicDataSource.setTargetDataSources(targetDataSources);
        // 设置默认的数据源
        dynamicDataSource.setDefaultTargetDataSource(mysql);
        return dynamicDataSource;
    }
    @Primary
    @Bean("sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("mysql") DataSource mysql, @Qualifier("oracle") DataSource oracle) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(this.dataSource(mysql, oracle));
     sessionFactory.setTypeAliasesPackage(env.getProperty("mybatis.typeAliasesPackage"));
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(env.getProperty("mybatis.mapper-locations")));
        return sessionFactory.getObject();
    }
    @Bean("transactionManager")
    public DataSourceTransactionManager transactionManager(@Qualifier("dataSource") DynamicDataSource dataSource) throws Exception {
       return new DataSourceTransactionManager(dataSource);
    }
}