springboot如何连接多个数据库

Spring Boot连接多个数据库的主要方法包括：配置多个数据源、使用不同的实体管理器、配置事务管理器。 在这些步骤中，配置多个数据源是最为关键的一步。下面将详细介绍如何实现这些步骤。

一、配置多个数据源

在Spring Boot中，配置多个数据源需要在application.properties或application.yml文件中配置多个数据源的属性。

1. 配置文件

在application.yml文件中，可以如下配置：

spring: datasource: primary: url: jdbc:mysql://localhost:3306/primary_db username: user password: pass driver-class-name: com.mysql.cj.jdbc.Driver secondary: url: jdbc:mysql://localhost:3306/secondary_db username: user password: pass driver-class-name: com.mysql.cj.jdbc.Driver

2. 数据源配置类

我们需要创建两个数据源配置类，分别用于配置主数据源和从数据源。

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
    basePackages = "com.example.primary",
    entityManagerFactoryRef = "primaryEntityManagerFactory",
    transactionManagerRef = "primaryTransactionManager"
)
public class PrimaryDataSourceConfig {
    @Primary
    @Bean(name = "primaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }
    @Primary
    @Bean(name = "primaryEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean primaryEntityManagerFactory(
            EntityManagerFactoryBuilder builder,
            @Qualifier("primaryDataSource") DataSource dataSource) {
        return builder
                .dataSource(dataSource)
                .packages("com.example.primary")
                .persistenceUnit("primary")
                .build();
    }
    @Primary
    @Bean(name = "primaryTransactionManager")
    public PlatformTransactionManager primaryTransactionManager(
            @Qualifier("primaryEntityManagerFactory") EntityManagerFactory entityManagerFactory) {
        return new JpaTransactionManager(entityManagerFactory);
    }
}

类似地，配置从数据源：

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
    basePackages = "com.example.secondary",
    entityManagerFactoryRef = "secondaryEntityManagerFactory",
    transactionManagerRef = "secondaryTransactionManager"
)
public class SecondaryDataSourceConfig {
    @Bean(name = "secondaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
    @Bean(name = "secondaryEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean secondaryEntityManagerFactory(
            EntityManagerFactoryBuilder builder,
            @Qualifier("secondaryDataSource") DataSource dataSource) {
        return builder
                .dataSource(dataSource)
                .packages("com.example.secondary")
                .persistenceUnit("secondary")
                .build();
    }
    @Bean(name = "secondaryTransactionManager")
    public PlatformTransactionManager secondaryTransactionManager(
            @Qualifier("secondaryEntityManagerFactory") EntityManagerFactory entityManagerFactory) {
        return new JpaTransactionManager(entityManagerFactory);
    }
}

3. 实体类和仓库配置

接下来，分别为不同的数据源配置实体类和仓库类：

主数据源的实体类：

@Entity
@Table(name = "primary_entity")
public class PrimaryEntity {
    // Fields, getters, setters, etc.
}

主数据源的仓库接口：

@Repository
public interface PrimaryRepository extends JpaRepository<PrimaryEntity, Long> {
}

从数据源的实体类：

@Entity
@Table(name = "secondary_entity")
public class SecondaryEntity {
    // Fields, getters, setters, etc.
}

从数据源的仓库接口：

@Repository
public interface SecondaryRepository extends JpaRepository<SecondaryEntity, Long> {
}

二、事务管理

在Spring Boot中，事务管理也是一个重要的部分，特别是在连接多个数据库时。我们需要为每个数据源分别配置事务管理器。

1. 主数据源事务管理器

在主数据源配置类中，我们已经定义了主数据源的事务管理器：

@Primary
@Bean(name = "primaryTransactionManager")
public PlatformTransactionManager primaryTransactionManager(
        @Qualifier("primaryEntityManagerFactory") EntityManagerFactory entityManagerFactory) {
    return new JpaTransactionManager(entityManagerFactory);
}

2. 从数据源事务管理器

同样地，在从数据源配置类中，我们定义了从数据源的事务管理器：

@Bean(name = "secondaryTransactionManager")
public PlatformTransactionManager secondaryTransactionManager(
        @Qualifier("secondaryEntityManagerFactory") EntityManagerFactory entityManagerFactory) {
    return new JpaTransactionManager(entityManagerFactory);
}

3. 使用事务管理器

在使用时，可以通过注解@Transactional指定使用哪个事务管理器。例如：

@Service
public class MyService {
    @Autowired
    private PrimaryRepository primaryRepository;
    @Autowired
    private SecondaryRepository secondaryRepository;
    @Transactional("primaryTransactionManager")
    public void savePrimary(PrimaryEntity entity) {
        primaryRepository.save(entity);
    }
    @Transactional("secondaryTransactionManager")
    public void saveSecondary(SecondaryEntity entity) {
        secondaryRepository.save(entity);
    }
}

三、测试连接多个数据库

为了确保我们配置的多个数据源能够正确工作，我们需要进行测试。可以编写一个简单的Spring Boot测试类来验证配置：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MultipleDataSourceTests {
    @Autowired
    private PrimaryRepository primaryRepository;
    @Autowired
    private SecondaryRepository secondaryRepository;
    @Test
    public void testPrimaryDataSource() {
        PrimaryEntity entity = new PrimaryEntity();
        // Set entity fields
        primaryRepository.save(entity);
        // Add assertions to verify the result
    }
    @Test
    public void testSecondaryDataSource() {
        SecondaryEntity entity = new SecondaryEntity();
        // Set entity fields
        secondaryRepository.save(entity);
        // Add assertions to verify the result
    }
}

通过运行这些测试，我们可以确保我们的配置是正确的，并且能够成功连接到多个数据库。

四、注意事项

在配置多个数据源时，有几个注意事项需要牢记：

1. 数据源配置前缀

在配置文件中，确保每个数据源的前缀是唯一的，以便Spring Boot能够正确识别和加载它们。

2. EntityManagerFactory和TransactionManager的Bean名称

在数据源配置类中，确保为每个EntityManagerFactory和TransactionManager指定唯一的Bean名称。这对于Spring Boot正确区分和使用它们是必要的。

3. 包扫描路径

在@EnableJpaRepositories注解中，指定的basePackages路径应包含对应数据源的实体类和仓库接口。

4. 事务管理器的使用

在使用@Transactional注解时，明确指定要使用的事务管理器，以确保事务能够正确应用于对应的数据源。

五、扩展：使用第三方库

在处理复杂的多数据源配置时，可以考虑使用一些第三方库来简化配置。例如，Spring Data JPA提供了一些注解和配置选项，可以帮助更轻松地管理多个数据源。

1. 使用Spring Data JPA

Spring Data JPA提供了一些有用的注解，可以简化多数据源的配置。例如，@Primary注解可以用来指定默认的数据源。

2. 使用Spring Cloud

如果你的应用程序是一个分布式系统，可以考虑使用Spring Cloud来管理多个数据源。Spring Cloud提供了一些工具和库，可以帮助你更轻松地管理和配置多个数据源。

六、示例项目

为了更好地理解和应用上述内容，可以参考一些示例项目。这些项目通常包含详细的配置和代码示例，可以帮助你更快地上手。

1. 官方文档

Spring Boot的官方文档提供了详细的配置和使用指南，可以作为一个很好的参考。

2. GitHub项目

在GitHub上，有很多开源项目实现了Spring Boot连接多个数据库的功能。可以通过搜索关键词“Spring Boot multiple data sources”来找到这些项目，并参考它们的实现。

总结

通过本文的讲解，我们详细介绍了如何在Spring Boot中连接多个数据库的配置和使用方法。从配置多个数据源、使用不同的实体管理器、配置事务管理器，到测试和注意事项，覆盖了实现这一功能的各个方面。希望这些内容能够帮助你在实际项目中成功实现Spring Boot连接多个数据库的需求。