Spring Boot + Mybatis 多数据源配置

应用场景

项目需要同时连接两个不同的数据库poi、pos，暂未涉及到主从，仅仅是因为两个数据库相互独立。

多数据源

首先要将spring boot自带的DataSourceAutoConfiguration禁掉，因为它会读取application.properties文件的spring.datasource.*属性并自动配置单数据源。在@SpringBootApplication注解中添加exclude属性即可：

@SpringBootApplication(exclude = {
        DataSourceAutoConfiguration.class
})
public class WebApplication {
    public static void main(String[] args) {
        SpringApplication.run(WebApplication.class, args);
    }
}

然后在application.yml中配置多数据源连接信息：

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    poi:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://127.0.0.1:3306/poi
      username: root
      password: root
    pos:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://127.0.0.1:3306/pos
      username: root
      password: root

由于我们禁掉了自动数据源配置，因些下一步就需要手动将这些数据源创建出来：

poi数据源配置

注意，配置类需要对DataSource、DataSourceTransactionManager、SqlSessionFactory 、SqlSessionTemplate四个数据项进行配置；DataSource类型需要引入javax.sql.DataSource

@MapperScan对指定dao包建立映射，确保在多个数据源下，自动选择合适的数据源，而在service层里不需要做特殊说明.

@Configuration
@MapperScan(basePackages = "cn.caoler.poi.mapper", sqlSessionTemplateRef = "poiSqlSessionTemplate")
public class BaseDataSourceConfig {
    @Bean(name = "poiDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.poi")
    @Primary
    public DataSource setDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "poiTransactionManager")
    @Primary
    public DataSourceTransactionManager setTransactionManager1(@Qualifier("poiDataSource") DataSource dataSource) {
        return new DruidDataSource();
    }

    @Bean(name = "poiSqlSessionFactory")
    @Primary
    public SqlSessionFactory setSqlSessionFactory(@Qualifier("poiDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/poi/*.xml"));
        return bean.getObject();
    }

    @Bean(name = "poiSqlSessionTemplate")
    @Primary
    public SqlSessionTemplate setSqlSessionTemplate(@Qualifier("poiSqlSessionFactory") SqlSessionFactory sqlSessionFactory) throws Exception {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

经过如上配置，cn.caoler.poi.mapper包下的Mapper接口，都会使用poi数据源。同理可配第二个

pos数据源配置

@Configuration
@MapperScan(basePackages = "cn.caoler.pos.mapper", sqlSessionTemplateRef = "poiSqlSessionTemplate")
public class BaseDataSourceConfig {
    @Bean(name = "posDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.pos")
    @Primary
    public DataSource setDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "posTransactionManager")
    @Primary
    public DataSourceTransactionManager setTransactionManager2(@Qualifier("posDataSource") DataSource dataSource) {
        return new DruidDataSource();
    }

    @Bean(name = "posSqlSessionFactory")
    @Primary
    public SqlSessionFactory setSqlSessionFactory(@Qualifier("posDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/pos/*.xml"));
        return bean.getObject();
    }

    @Bean(name = "posSqlSessionTemplate")
    @Primary
    public SqlSessionTemplate setSqlSessionTemplate(@Qualifier("posSqlSessionFactory") SqlSessionFactory sqlSessionFactory) throws Exception {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

完成这些配置后，假设有2个Mapper poi.mapper.UserMapper和pos.mapper.RoleMapper，使用前者时会自动连接poi库，后者连接pos库。

踩坑

1. jdbcUrl is required with driverClassName报错

解决方法：在配置文件中使用spring.datasource.jdbcUrl，而不是通常使用的spring.datasource.url。

datasource:
  type: com.alibaba.druid.pool.DruidDataSource
  poi:
    driverClassName: com.mysql.cj.jdbc.Driver
    jdbcUrl: jdbc:mysql://127.0.0.1:3306/poi         #此处必须使用jdbcUrl而不是url
    username: root
    password: root

2. 访问接口时提示：DataSourceTransactionManager 重复

@Bean(name = "posTransactionManager")
@Primary
public DataSourceTransactionManager setTransactionManager2(@Qualifier("posDataSource") DataSource dataSource) {
    return new DruidDataSource();
}

在配置DataSourceTransactionManager时，Bean命名为posTransactionManager和poiTransactionManager，已经做了区分，但是调用时还会提示有两个TransactionManager，产生原因暂不明确，但是解决方法为： 修改函数名，保证函数名之间有严格区分即可（例：setTransactionManager1、setTransactionManager2）

3. 提示mapper/xxx/*.xml未找到

只要保证程序运行之前，上述位置生成好对应的mapping.xml文件即可，若该位置无xml文件，则会报上述错误。

至此，大功告成。

Caole的个人博客