跳至主要內容

40. MyBatis-Plus如何处理多数据源配置？如何实现动态切换数据源？

PangHu大约 3 分钟

在使用MyBatis-Plus的Spring Boot项目中，处理多数据源和动态切换数据源的需求常见于企业级应用中。下面详细介绍如何配置多数据源以及如何实现动态切换数据源。

1. 配置多数据源

1.1 在application.yml中配置多个数据源

首先，在Spring Boot的application.yml中配置多个数据源。

spring:
  datasource:
    db1:
      url: jdbc:mysql://localhost:3306/db1
      username: root
      password: password
      driver-class-name: com.mysql.cj.jdbc.Driver
    db2:
      url: jdbc:mysql://localhost:3306/db2
      username: root
      password: password
      driver-class-name: com.mysql.cj.jdbc.Driver

1.2 定义数据源配置类

定义数据源配置类，配置不同的数据源和MyBatis的SqlSessionFactory。

@Configuration
public class DataSourceConfig {

    @Primary
    @Bean(name = "db1DataSource")
    @ConfigurationProperties(prefix = "spring.datasource.db1")
    public DataSource db1DataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "db2DataSource")
    @ConfigurationProperties(prefix = "spring.datasource.db2")
    public DataSource db2DataSource() {
        return DataSourceBuilder.create().build();
    }

    @Primary
    @Bean(name = "db1SqlSessionFactory")
    public SqlSessionFactory db1SqlSessionFactory(@Qualifier("db1DataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        return sessionFactory.getObject();
    }

    @Bean(name = "db2SqlSessionFactory")
    public SqlSessionFactory db2SqlSessionFactory(@Qualifier("db2DataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        return sessionFactory.getObject();
    }

    @Primary
    @Bean(name = "db1SqlSessionTemplate")
    public SqlSessionTemplate db1SqlSessionTemplate(@Qualifier("db1SqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }

    @Bean(name = "db2SqlSessionTemplate")
    public SqlSessionTemplate db2SqlSessionTemplate(@Qualifier("db2SqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

1.3 配置Mapper扫描路径

使用@MapperScan注解指定不同数据源的Mapper接口所在的包路径。

@Configuration
@MapperScan(basePackages = "com.example.mapper.db1", sqlSessionTemplateRef = "db1SqlSessionTemplate")
public class Db1MyBatisConfig {
}

@Configuration
@MapperScan(basePackages = "com.example.mapper.db2", sqlSessionTemplateRef = "db2SqlSessionTemplate")
public class Db2MyBatisConfig {
}

2. 实现动态切换数据源

2.1 定义动态数据源类

通过继承AbstractRoutingDataSource实现动态数据源的切换。

public class DynamicDataSource extends AbstractRoutingDataSource {

    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

    public static void setDataSource(String dataSourceKey) {
        contextHolder.set(dataSourceKey);
    }

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

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

    @Override
    protected Object determineCurrentLookupKey() {
        return getDataSource();
    }
}

2.2 配置动态数据源

在配置类中将多个数据源注册到DynamicDataSource，并设置默认数据源。

@Configuration
public class DynamicDataSourceConfig {

    @Bean
    public DataSource dynamicDataSource(@Qualifier("db1DataSource") DataSource db1DataSource,
                                        @Qualifier("db2DataSource") DataSource db2DataSource) {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("db1", db1DataSource);
        targetDataSources.put("db2", db2DataSource);

        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        dynamicDataSource.setTargetDataSources(targetDataSources);
        dynamicDataSource.setDefaultTargetDataSource(db1DataSource);
        return dynamicDataSource;
    }

    @Bean
    public SqlSessionFactory sqlSessionFactory(@Qualifier("dynamicDataSource") DataSource dynamicDataSource) throws Exception {
        SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
        sessionFactoryBean.setDataSource(dynamicDataSource);
        return sessionFactoryBean.getObject();
    }

    @Bean
    public SqlSessionTemplate sqlSessionTemplate(@Qualifier("sqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

2.3 动态切换数据源

在需要切换数据源的Service方法中，使用DynamicDataSource.setDataSource()来指定当前线程的数据源。

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    @Autowired
    private OrderMapper orderMapper;

    public User getUserFromDb1(Integer id) {
        DynamicDataSource.setDataSource("db1");
        try {
            return userMapper.findUserById(id);
        } finally {
            DynamicDataSource.clearDataSource();
        }
    }

    public Order getOrderFromDb2(Integer id) {
        DynamicDataSource.setDataSource("db2");
        try {
            return orderMapper.findOrderById(id);
        } finally {
            DynamicDataSource.clearDataSource();
        }
    }
}

3. 使用注解实现数据源切换

为了简化数据源切换的操作，可以使用自定义注解来切换数据源。

3.1 创建自定义注解

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    String value() default "db1";
}

3.2 实现AOP切面

使用AOP切面拦截带有@DataSource注解的方法，动态切换数据源。

@Aspect
@Component
public class DynamicDataSourceAspect {

    @Before("@annotation(dataSource)")
    public void changeDataSource(JoinPoint point, DataSource dataSource) {
        DynamicDataSource.setDataSource(dataSource.value());
    }

    @After("@annotation(dataSource)")
    public void clearDataSource(JoinPoint point, DataSource dataSource) {
        DynamicDataSource.clearDataSource();
    }
}

3.3 使用自定义注解

现在可以在Service层方法上使用@DataSource注解来动态切换数据源。

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    @Autowired
    private OrderMapper orderMapper;

    @DataSource("db1")
    public User getUserFromDb1(Integer id) {
        return userMapper.findUserById(id);
    }

    @DataSource("db2")
    public Order getOrderFromDb2(Integer id) {
        return orderMapper.findOrderById(id);
    }
}

4. 总结

MyBatis-Plus在Spring Boot项目中支持多数据源操作，并通过配置多个数据源和动态数据源实现动态切换数据源：

  1. 多数据源配置：通过配置多个DataSource、SqlSessionFactory、SqlSessionTemplate来支持多数据源操作，不同包下的Mapper接口使用不同的数据源。
  2. 动态切换数据源：通过实现AbstractRoutingDataSource和AOP切面，可以在运行时动态切换数据源，适用于复杂业务场景。
  3. 注解实现数据源切换：通过自定义注解和AOP结合，简化了数据源的动态切换操作，使代码更加简洁和易于维护。

通过这些配置，MyBatis-Plus可以轻松地支持多数据库的操作，并在需要时动态地切换数据源。