Spring Boot多数据源及其事务管理配置方法

下面我来为你讲解"Spring Boot多数据源及其事务管理配置方法"的完整攻略。

一、背景

在实际开发中，多个应用程序需要访问多个数据源，例如管理系统需要访问用户数据和订单数据。这时就需要使用到多数据源配置。

Spring Boot多数据源配置较为复杂，涉及到数据源配置和事务管理，下面分别介绍如何进行多数据源的配置和事务管理。

二、多数据源的配置

配置多个数据源

在Spring Boot中配置多个数据源需要使用到Spring提供的AbstractRoutingDataSource类，该类是一种动态数据源，可以根据不同的线程动态地选择合适的数据源。具体的配置如下：

@Configuration
public class DataSourceConfig{
    // 主数据源，即默认数据源
    @Bean
    @Primary
    @ConfigurationProperties("spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    // 从数据源
    @Bean
    @ConfigurationProperties("spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    // 动态数据源
    @Bean
    public AbstractRoutingDataSource routingDataSource() {
        DynamicRoutingDataSource routingDataSource = new DynamicRoutingDataSource();
        Map<Object, Object> dataSourceMap = new HashMap<>(2);
        dataSourceMap.put("primary", primaryDataSource());
        dataSourceMap.put("secondary", secondaryDataSource());
        routingDataSource.setDefaultTargetDataSource(primaryDataSource());
        routingDataSource.setTargetDataSources(dataSourceMap);
        return routingDataSource;
    }
}

配置动态数据源

以上代码中使用的DynamicRoutingDataSource是我们自己定义的一个继承自AbstractRoutingDataSource的动态数据源。

public class DynamicRoutingDataSource extends AbstractRoutingDataSource{
    @Override
    protected Object determineCurrentLookupKey() {
        return DbContextHolder.get();
    }
}

上述代码中的DbContextHolder是一个用于存储数据源标识的ThreadLocal变量，可用于在不同线程间动态切换数据源。

public class DbContextHolder{
    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
    public static void set(String dbName) {
        contextHolder.set(dbName);
    }
    public static String get() {
        return contextHolder.get();
    }
    public static void clear() {
        contextHolder.remove();
    }
}

配置数据源路由

在实际应用中，需要动态选择使用哪个数据源，可以在DAO层根据具体需求动态选择数据源，具体操作如下：

@Repository
public class UserDao {
  @Autowired
  private JdbcTemplate jdbcTemplate;

  public List<User> getUsers() {
    DbContextHolder.set("primary"); // 切换默认数据源
    String sql = "SELECT id, username, email FROM user";
    return jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(User.class));
  }

  public List<Order> getOrders() {
    DbContextHolder.set("secondary"); // 切换从数据源
    String sql = "SELECT id, order_no, amount FROM orders";
    return jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(Order.class));
  }
}

在上述代码中，我们使用DbContextHolder动态切换数据源。

三、事务管理

多数据源切换完成后，需要对事务进行管理。在Spring Boot中，使用@Transactional进行事务管理。

@Service
@Transactional
public class TransactionalService {
  @Autowired
  private UserDao userDao;

  public List<User> getUsers() {
    return userDao.getUsers();
  }

  public List<Order> getOrders() {
    return userDao.getOrders();
  }

  public void saveUser(User user) {
    userDao.saveUser(user);
  }

  public void saveOrder(Order order) {
    userDao.saveOrder(order);
  }
}

在代码中，我们使用@Transactional注解来控制事务，整个Service类中的所有方法都绑定到同一个事务中。如果没有任何异常抛出，事务将会自动提交，否则事务将会回滚。如果需要更细粒度的事务控制，可以使用Propagation设置事务的传播行为。

四、示例说明

下面给出针对两个数据源的示例说明：

示例一：使用MySQL和H2两个数据源

MySQL数据源配置：

spring.datasource.primary.url=jdbc:mysql://127.0.0.1:3306/test1?useUnicode=true&characterEncoding=utf8&autoReconnect=true&failOverReadOnly=false&maxReconnects=5
spring.datasource.primary.username=root
spring.datasource.primary.password=root

spring.datasource.primary.driver-class-name=com.mysql.jdbc.Driver

H2数据源配置：

spring.datasource.secondary.url=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
spring.datasource.secondary.username=sa
spring.datasource.secondary.password=

spring.datasource.secondary.driver-class-name=org.h2.Driver

上述代码中，我们使用了spring.datasource.primary和spring.datasource.secondary来分别指定两个数据源的相关配置信息。

示例二：使用不同数据库产品的两个数据源

对于不同的数据库产品，我们需要使用不同的数据库驱动程序和不同的URL设置。例如，对于MySQL和Oracle，我们需要分别使用以下配置信息：

MySQL数据源配置：

spring.datasource.primary.url=jdbc:mysql://127.0.0.1:3306/test1?useUnicode=true&characterEncoding=utf8&autoReconnect=true&failOverReadOnly=false&maxReconnects=5
spring.datasource.primary.username=root
spring.datasource.primary.password=root

spring.datasource.primary.driver-class-name=com.mysql.jdbc.Driver

Oracle数据源配置：

spring.datasource.secondary.url=jdbc:oracle:thin:@127.0.0.1:1521:orcl
spring.datasource.secondary.username=scott
spring.datasource.secondary.password=tiger

spring.datasource.secondary.driver-class-name=oracle.jdbc.driver.OracleDriver