Spring Boot配置和使用两个数据源

技术背景

在实际的开发场景中，一个Spring Boot应用可能需要连接多个数据库，比如主从数据库、不同业务模块使用不同数据库等。Spring Boot本身支持多数据源的配置，通过合理配置可以实现对多个数据源的管理和使用。

实现步骤

1. 配置数据源信息

在application.properties或application.yml中添加两个数据源的配置信息。以application.properties为例：

# 第一个数据库配置
spring.datasource.url = [url]
spring.datasource.username = [username]
spring.datasource.password = [password]
spring.datasource.driverClassName = oracle.jdbc.OracleDriver

# 第二个数据库配置
spring.secondDatasource.url = [url]
spring.secondDatasource.username = [username]
spring.secondDatasource.password = [password]
spring.secondDatasource.driverClassName = oracle.jdbc.OracleDriver

2. 创建数据源Bean

在配置类中创建两个数据源的Bean：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

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

    @Bean
    @ConfigurationProperties(prefix="spring.secondDatasource")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}

3. 配置事务管理器（可选）

如果需要对两个数据源进行事务管理，可以配置两个事务管理器：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import javax.sql.DataSource;

@Configuration
public class TransactionManagerConfig {

    @Bean(name="tm1")
    @Autowired
    @Primary
    DataSourceTransactionManager tm1(@Qualifier ("primaryDataSource") DataSource datasource) {
        DataSourceTransactionManager txm  = new DataSourceTransactionManager(datasource);
        return txm;
    }

    @Bean(name="tm2")
    @Autowired
    DataSourceTransactionManager tm2(@Qualifier ("secondaryDataSource") DataSource datasource) {
        DataSourceTransactionManager txm  = new DataSourceTransactionManager(datasource);
        return txm;
    }
}

4. 使用不同的数据源

在需要使用数据源的地方，通过@Qualifier注解指定使用哪个数据源：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;

import javax.sql.DataSource;

@Service
public class MyService {

    private final JdbcTemplate primaryJdbcTemplate;
    private final JdbcTemplate secondaryJdbcTemplate;

    @Autowired
    public MyService(@Qualifier("primaryDataSource") DataSource primaryDataSource,
                     @Qualifier("secondaryDataSource") DataSource secondaryDataSource) {
        this.primaryJdbcTemplate = new JdbcTemplate(primaryDataSource);
        this.secondaryJdbcTemplate = new JdbcTemplate(secondaryDataSource);
    }

    public void doSomething() {
        // 使用主数据源执行操作
        primaryJdbcTemplate.execute("SELECT 1 FROM DUAL");

        // 使用从数据源执行操作
        secondaryJdbcTemplate.execute("SELECT 1 FROM DUAL");
    }
}

核心代码

数据源配置

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

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

    @Bean
    @ConfigurationProperties(prefix="spring.secondDatasource")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}

事务管理器配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import javax.sql.DataSource;

@Configuration
public class TransactionManagerConfig {

    @Bean(name="tm1")
    @Autowired
    @Primary
    DataSourceTransactionManager tm1(@Qualifier ("primaryDataSource") DataSource datasource) {
        DataSourceTransactionManager txm  = new DataSourceTransactionManager(datasource);
        return txm;
    }

    @Bean(name="tm2")
    @Autowired
    DataSourceTransactionManager tm2(@Qualifier ("secondaryDataSource") DataSource datasource) {
        DataSourceTransactionManager txm  = new DataSourceTransactionManager(datasource);
        return txm;
    }
}

服务层使用数据源

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;

import javax.sql.DataSource;

@Service
public class MyService {

    private final JdbcTemplate primaryJdbcTemplate;
    private final JdbcTemplate secondaryJdbcTemplate;

    @Autowired
    public MyService(@Qualifier("primaryDataSource") DataSource primaryDataSource,
                     @Qualifier("secondaryDataSource") DataSource secondaryDataSource) {
        this.primaryJdbcTemplate = new JdbcTemplate(primaryDataSource);
        this.secondaryJdbcTemplate = new JdbcTemplate(secondaryDataSource);
    }

    public void doSomething() {
        // 使用主数据源执行操作
        primaryJdbcTemplate.execute("SELECT 1 FROM DUAL");

        // 使用从数据源执行操作
        secondaryJdbcTemplate.execute("SELECT 1 FROM DUAL");
    }
}

最佳实践

• 标记主数据源：使用@Primary注解标记一个主数据源，这样在自动注入时Spring会优先使用该数据源。
• 事务管理：对于需要同时操作两个数据源的场景，使用ChainedTransactionManager进行事务管理。
• 代码隔离：将不同数据源的配置和使用代码进行隔离，提高代码的可维护性。

常见问题

1. jdbcUrl is required with driverClassName错误

在Spring Boot 2.0之后，需要使用jdbc-url代替url。

2. 如何让不同的JpaRepository使用不同的数据源

可以通过配置不同的EntityManagerFactory和TransactionManager，并在@EnableJpaRepositories注解中指定对应的entityManagerFactoryRef和transactionManagerRef。

3. 分布式事务问题

如果需要在两个数据源之间进行分布式事务处理，可以考虑使用XA协议或分布式事务框架，如Atomikos。