Spring Boot + Mybatis 配置多数据源

1.前言

项目环境：

• Spring Boot
• MyBatis

项目背景：

原本项目是单数据源的，只需要在application.properties里进行spring.datasource.*相关配置，则Spring-Boot就会自行完成数据源配置。

最近因为业务发生变更，需要新增一个数据源进行一些其他操作。

实现步骤：

为了实现多数据源配置，需要以下四个步骤：

1. 将原数据源获取方式改造成手动方式
2. 增加新数据源的相关配置
3. 取消原主类的@MapperScan配置
4. 调整新数据源对应的Dao层路径

2.流程

2.1.将原数据源获取方式改造成手动方式

原始数据源配置维持不变：

# 原始数据源
spring.datasource.url = jdbc:mysql://localhost:3306/test?characterSet=utf8mb4
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.username = root
spring.datasource.password = root

新增sqlSessionTemplate相关配置文件：

• 注意主数据源的basePackages为"pers.hanchao.multidatasource.dao"
• 注意一定要添加@Primary注解，表示当一个接口有多个实现类时，默认加载当前bean

package pers.hanchao.multidatasource.config;

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

import javax.sql.DataSource;

/**
 * <p>Description: 主数据源：处理非分库分表的表</P>
 *
 * @author hanchao
 * @date 2018/7/25 下午3:07
 */
@Configuration
@MapperScan(basePackages = {"pers.hanchao.multidatasource.dao"}, sqlSessionTemplateRef = "sqlSessionTemplate")
public class MajorDataSourceConfiguration {

    /**
     * <p>Description: xml路径</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:49
     */
    @Value("${mybatis.mapper-locations}")
    private String mapperLocations;

    /**
     * <p>Description: PO路径</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:49
     */
    @Value("${mybatis.type-aliases-package}")
    private String typeAliasesPackage;

    /**
     * <p>Description: 获取主数据源</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:17
     */
    @Bean(name = "dataSource")
    @ConfigurationProperties(prefix = "spring.datasource")
    @Primary
    public DataSource getDataSource() {
        return DataSourceBuilder.create().build();
    }

    /**
     * <p>Description: 获取主数据源的SqlSessionFactory</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:21
     */
    @Bean(name = "sqlSessionFactory")
    @Primary
    public SqlSessionFactory getSqlSessionFactory(@Qualifier("dataSource") DataSource dataSource) throws Exception {
        //创建SqlSessionFactoryBean
        SqlSessionFactoryBean sqlSessionFactory = new SqlSessionFactoryBean();
        //设置DataSource
        sqlSessionFactory.setDataSource(dataSource);
        //添加xml路径
        sqlSessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(mapperLocations));
        //添加PO路径
        sqlSessionFactory.setTypeAliasesPackage(typeAliasesPackage);
        //返回DataSource
        return sqlSessionFactory.getObject();
    }

    /**
     * <p>Description: 获取主数据源的事务管理器</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:25
     */
    @Bean(name = "transactionManager")
    @Primary
    public DataSourceTransactionManager getDataSourceTransactionManager(@Qualifier("dataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    /**
     * <p>Description: 获取主数据源的sqlSessionTemplate</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:25
     */
    @Bean(name = "sqlSessionTemplate")
    @Primary
    public SqlSessionTemplate getSqlSessionTemplate(@Qualifier("sqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

2.2.增加新数据源的相关配置

增加第二数据源相关配置：

# 原始数据源
spring.datasource.url = jdbc:mysql://localhost:3306/test?characterSet=utf8mb4
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.username = root
spring.datasource.password = root
# 新增数据源
second.datasource.url = jdbc:mysql://localhost:3306/demo?characterSet=utf8mb4
second.datasource.driver-class-name=com.mysql.jdbc.Driver
second.datasource.username = root
second.datasource.password = root

增加sqlSessionTemplate相关配置文件：

• 注意主数据源的basePackages为"pers.hanchao.multidatasource.second.dao"。
• 一定要注意：两个数据源配置的basePackages不能是上下级关系。
• 注意一定不要添加@Primary注解。

package pers.hanchao.multidatasource.config;

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

import javax.sql.DataSource;

/**
 * <p>Description: 第二数据源</P>
 *
 * @author hanchao
 * @date 2018/7/25 下午3:07
 */
@Configuration
@MapperScan(basePackages = {"pers.hanchao.multidatasource.second.dao"}, sqlSessionTemplateRef = "secondSqlSessionTemplate")
public class MajorDataSourceConfiguration {

    /**
     * <p>Description: xml路径</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:49
     */
    @Value("${mybatis.mapper-locations}")
    private String mapperLocations;

    /**
     * <p>Description: PO路径</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:49
     */
    @Value("${mybatis.type-aliases-package}")
    private String typeAliasesPackage;

    /**
     * <p>Description: 获取第二数据源</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:17
     */
    @Bean(name = "secondDataSource")
    @ConfigurationProperties(prefix = "second.datasource")
    public DataSource getDataSource() {
        return DataSourceBuilder.create().build();
    }

    /**
     * <p>Description: 获取第二数据源的SqlSessionFactory</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:21
     */
    @Bean(name = "secondSqlSessionFactory")
    public SqlSessionFactory getSqlSessionFactory(@Qualifier("secondDataSource") DataSource dataSource) throws Exception {
        //创建SqlSessionFactoryBean
        SqlSessionFactoryBean sqlSessionFactory = new SqlSessionFactoryBean();
        //设置DataSource
        sqlSessionFactory.setDataSource(dataSource);
        //添加xml路径
        sqlSessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(mapperLocations));
        //添加PO路径
        sqlSessionFactory.setTypeAliasesPackage(typeAliasesPackage);
        sqlSessionFactory.setVfs(SpringBootVFS.class);
        //返回DataSource
        return sqlSessionFactory.getObject();
    }

    /**
     * <p>Description: 获取第二数据源的事务管理器</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:25
     */
    @Bean(name = "secondTransactionManager")
    public DataSourceTransactionManager getDataSourceTransactionManager(@Qualifier("secondDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    /**
     * <p>Description: 获取第二数据源的sqlSessionTemplate</p>
     *
     * @author hanchao
     * @date 2018/7/25 下午3:25
     */
    @Bean(name = "secondSqlSessionTemplate")
    public SqlSessionTemplate getSqlSessionTemplate(@Qualifier("secondSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

2.3.取消原主类的@MapperScan配置

因为上述两个数据源已经各自指定了@MapperScan，所以主类不在需要相应配置，去掉：

//@MapperScan("pers.hanchao.multidatasource.dao")
public class MyMainService extends WebMvcConfigurerAdapter { //..}

2.4.调整新数据源对应的Dao层路径

一定记得使用第二个数据源相关的Dao层要放入其指定的basePackages。

3.其他

在上述的方案中，需要创建两个Dao层的basePackages，暂时没有更好的办法。

如果各位有更好的解决方法，请多多指教，