springboot如何连接两个数据库

Spring Boot如何连接两个数据库

Spring Boot连接两个数据库的核心在于配置多个数据源、设置不同的数据库连接属性、使用不同的实体管理器来分别处理不同数据库中的实体类。以下将详细介绍如何在Spring Boot中实现这一需求。

一、配置两个数据源

在Spring Boot应用中，连接多个数据库的第一步是配置多个数据源。每个数据源都需要独立的配置信息，包括数据库的URL、用户名、密码等。

数据源配置文件

首先，在application.properties或application.yml文件中配置两个数据源。例如，如果你正在使用MySQL和PostgreSQL，可以按如下方式配置：

# 第一数据源配置 spring.datasource.primary.url=jdbc:mysql://localhost:3306/primary_db spring.datasource.primary.username=root spring.datasource.primary.password=password spring.datasource.primary.driver-class-name=com.mysql.cj.jdbc.Driver 第二数据源配置 spring.datasource.secondary.url=jdbc:postgresql://localhost:5432/secondary_db spring.datasource.secondary.username=postgres spring.datasource.secondary.password=password spring.datasource.secondary.driver-class-name=org.postgresql.Driver

数据源Bean配置

接下来，在Spring Boot应用程序中创建两个DataSource Bean。可以在一个配置类中完成这些配置：

import org.springframework.beans.factory.annotation.Qualifier;
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.boot.jdbc.DataSourceBuilder;
import javax.sql.DataSource;
@Configuration
public class DataSourceConfig {
    @Primary
    @Bean(name = "primaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }
    @Bean(name = "secondaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}

在这个配置类中，primaryDataSource 被标记为 @Primary，这意味着这是默认的数据源。 如果没有特别指定，Spring Boot将会使用这个数据源。

二、配置JPA实体管理器

为了使JPA能够分别使用不同的数据源，必须为每个数据源配置单独的EntityManager和TransactionManager。

配置Primary JPA实体管理器

首先，为第一个数据源配置EntityManager和TransactionManager：

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.orm.jpa.JpaTransactionManager;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import javax.persistence.EntityManagerFactory;
import javax.sql.DataSource;
@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
    entityManagerFactoryRef = "primaryEntityManagerFactory",
    transactionManagerRef = "primaryTransactionManager",
    basePackages = {"com.example.primary.repository"}
)
public class PrimaryDataSourceConfig {
    @Primary
    @Bean(name = "primaryEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean primaryEntityManagerFactory(
            EntityManagerFactoryBuilder builder, @Qualifier("primaryDataSource") DataSource dataSource) {
        return builder
                .dataSource(dataSource)
                .packages("com.example.primary.entity")
                .persistenceUnit("primary")
                .build();
    }
    @Primary
    @Bean(name = "primaryTransactionManager")
    public PlatformTransactionManager primaryTransactionManager(
            @Qualifier("primaryEntityManagerFactory") EntityManagerFactory primaryEntityManagerFactory) {
        return new JpaTransactionManager(primaryEntityManagerFactory);
    }
}

在这个配置类中，我们使用@EnableJpaRepositories注解指定了与这个数据源相关的仓库包路径。 同时，通过EntityManagerFactoryBuilder创建了一个新的EntityManagerFactory实例，并将其与指定的数据源绑定。

配置Secondary JPA实体管理器

同样地，为第二个数据源配置EntityManager和TransactionManager：

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.orm.jpa.JpaTransactionManager;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import javax.persistence.EntityManagerFactory;
import javax.sql.DataSource;
@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
    entityManagerFactoryRef = "secondaryEntityManagerFactory",
    transactionManagerRef = "secondaryTransactionManager",
    basePackages = {"com.example.secondary.repository"}
)
public class SecondaryDataSourceConfig {
    @Bean(name = "secondaryEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean secondaryEntityManagerFactory(
            EntityManagerFactoryBuilder builder, @Qualifier("secondaryDataSource") DataSource dataSource) {
        return builder
                .dataSource(dataSource)
                .packages("com.example.secondary.entity")
                .persistenceUnit("secondary")
                .build();
    }
    @Bean(name = "secondaryTransactionManager")
    public PlatformTransactionManager secondaryTransactionManager(
            @Qualifier("secondaryEntityManagerFactory") EntityManagerFactory secondaryEntityManagerFactory) {
        return new JpaTransactionManager(secondaryEntityManagerFactory);
    }
}

在这个配置类中，同样使用@EnableJpaRepositories注解指定了与第二个数据源相关的仓库包路径。 通过EntityManagerFactoryBuilder创建了一个新的EntityManagerFactory实例，并将其与第二个数据源绑定。

三、使用不同的数据源

在完成数据源和实体管理器的配置之后，接下来需要在代码中使用这些配置。通常会根据实体类来区分不同的数据源。

使用Primary数据源

对于第一个数据源，相关的实体类和仓库接口应放在com.example.primary.entity和com.example.primary.repository包中。例如：

@Entity
@Table(name = "primary_table")
public class PrimaryEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // 其他字段和getter、setter方法
}

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface PrimaryRepository extends JpaRepository<PrimaryEntity, Long> {
    // 自定义查询方法
}

使用Secondary数据源

对于第二个数据源，相关的实体类和仓库接口应放在com.example.secondary.entity和com.example.secondary.repository包中。例如：

@Entity
@Table(name = "secondary_table")
public class SecondaryEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // 其他字段和getter、setter方法
}

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface SecondaryRepository extends JpaRepository<SecondaryEntity, Long> {
    // 自定义查询方法
}

四、事务管理

在涉及多个数据源的应用中，事务管理是一个关键问题。通常需要确保事务能够跨多个数据源进行管理。Spring提供了多种事务管理策略，可以根据具体需求进行选择。

基于注解的事务管理

可以使用@Transactional注解来控制事务。例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Service
public class MyService {
    @Autowired
    private PrimaryRepository primaryRepository;
    @Autowired
    private SecondaryRepository secondaryRepository;
    @Transactional(transactionManager = "primaryTransactionManager")
    public void primaryTransactionMethod() {
        // 使用Primary数据源进行操作
        primaryRepository.save(new PrimaryEntity());
    }
    @Transactional(transactionManager = "secondaryTransactionManager")
    public void secondaryTransactionMethod() {
        // 使用Secondary数据源进行操作
        secondaryRepository.save(new SecondaryEntity());
    }
    @Transactional
    public void multipleDataSourceTransaction() {
        // 使用不同数据源进行操作
        primaryRepository.save(new PrimaryEntity());
        secondaryRepository.save(new SecondaryEntity());
    }
}

在上述代码中，通过@Transactional注解可以指定使用哪个事务管理器。对于跨多个数据源的事务，可以使用默认的事务管理器。

五、测试连接

为了确保配置正确并且能够正常连接多个数据库，可以编写简单的测试用例进行验证。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class DataSourceTest {
    @Autowired
    private PrimaryRepository primaryRepository;
    @Autowired
    private SecondaryRepository secondaryRepository;
    @Test
    public void testPrimaryDataSource() {
        primaryRepository.save(new PrimaryEntity());
        // 其他测试逻辑
    }
    @Test
    public void testSecondaryDataSource() {
        secondaryRepository.save(new SecondaryEntity());
        // 其他测试逻辑
    }
}

通过以上步骤，Spring Boot应用可以成功配置并连接多个数据库。这种多数据源配置非常适合需要同时访问多个数据库的复杂应用场景。

六、总结

在Spring Boot中配置多个数据源涉及到以下几个关键步骤：

配置多个数据源：在application.properties或application.yml文件中分别配置每个数据源的连接信息。
定义数据源Bean：在配置类中定义多个DataSource Bean，并使用@Primary注解指定默认数据源。
配置JPA实体管理器：为每个数据源分别配置EntityManager和TransactionManager，并使用@EnableJpaRepositories注解指定不同的数据源对应的仓库包路径。
使用不同的数据源：根据业务逻辑，在代码中区分使用不同的数据源。
事务管理：使用@Transactional注解控制事务，确保跨多个数据源的事务能够正常管理。
测试连接：编写测试用例，验证多个数据源的配置是否正确。

通过以上步骤，可以在Spring Boot应用中实现对多个数据库的连接和操作，为复杂业务场景提供灵活的解决方案。如果在项目团队管理中需要使用项目管理系统，推荐使用研发项目管理系统PingCode和通用项目协作软件Worktile。这两款工具可以帮助团队更好地管理项目任务和协作，提高工作效率。