使用Spring Boot配置多个数据源 - Udith

19-06-24 banq
         

Spring Boot是一个非常强大的框架,可以非常轻松地用于开发基于Spring的应用程序。这个框架最好的事情是什么?您只需使用Java注释即可轻松完成高级配置。因此,您可以将重点放在业务逻辑而不是应用程序配置上。虽然Spring Boot应用程序默认使用单个数据源,但也可以使它们与多个数据源一起使用。

单个数据源

大多数情况下,我们开发的应用程序需要单个数据源才能运行。在开发单个数据源Spring Boot应用程序时,配置非常简单。这只是在application.properties文件中定义一些属性的问题。以下是这样的配置,其中显示了如何定义基于MySQL的数据源。

# DB connection properties
spring.datasource.url=jdbc:mysql://host:3306/MY_DB
spring.datasource.username = dbUser
spring.datasource.password = password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# JPA properties
spring.jpa.hibernate.ddl-auto = validate
spring.jpa.hibernate.naming-strategy = org.hibernate.cfg.ImprovedNamingStrategy
spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5Dialect

一旦正确定义了上述属性,您剩下要做的就是在JPA级别上。那就是编写Model类来表示表并编写Repositories来访问这些表。Spring在引擎盖下照顾其余的!

现在假设您有2个现有的后端应用程序在2个独立的数据源上工作。并且需要开发单个SB应用程序来管理这两个数据源上的数据。

那么如何使用单个Spring Boot应用程序配置多个数据源?这有可能吗?

多个数据源

这绝对是可能的,而不是那么复杂。它只需要用Spring的注释编写一些配置类。然后在application.properties文件中定义数据源连接属性,并正确地将存储库和模型组织到包中。所以让我们先看看后面的第一个。

管理模型和存储库包:

包组织是配置多个数据源的主要先决条件之一。确切地说,与2个数据源相关的模型类和存储库类应该在单独的包中。

例如,假设我们有2个数据源作为A和B.与数据源A相关的存储库类可以在一个或多个包中,我们将其假设为包com.udith.p和com.udith.q。条件是数据源B的存储库不能位于com.udith.p或com.udith.q包中。但是如果需要,它们可以位于com.udith.ps之类的子包中。

同样的条件也适用于Model类。但请注意,这不适用于Controller和Service类。

因此,对于此示例,我们假设存储库和模型的包如下所示:

模型:
    数据源A:
          com.udith.model.p
          com.udith.model.q
    数据源B:
          com.udith.model.r
          com.udith.model.s

仓储:
       数据源A:
         com.udith.repo.p
         com.udith.repo.q
       数据源B:
         com.udith.repo.r
         com.udith.repo.s

定义连接属性

当我们使用单个数据源时,我们使用“ spring.datasource。”前缀定义连接属性名称。例如,连接URL定义如下。

spring.datasource.url=jdbc:mysql://localhost:3306/MY_DB

但是,当使用多个数据源时,要求是每个数据源的连接属性名称应具有不同的前缀。所以让我们定义我们的2个数据源属性如下。

# Connection properties of Data Source A
spring.datasource.a.url=jdbc:mysql://host1:3306/MY_DB_A
spring.datasource.a.username = dbUserA
spring.datasource.a.password = passwordForA
spring.datasource.a.driver-class-name=com.mysql.cj.jdbc.Driver

# Connection properties of Data Source B
spring.datasource.b.url=jdbc:mysql://host2:3306/MY_DB_B
spring.datasource.b.username = dbUserB
spring.datasource.b.password = passwordForB
spring.datasource.b.driver-class-name=com.mysql.cj.jdbc.Driver

请注意,这些前缀可以是您喜欢的任何有效属性名称,并且不必以spring.datasource开头。

编写配置类

所以让我们进入Configuration类。您所要做的就是为每个数据源编写如下2个配置类。每个类都将为数据源,实体管理器工厂和事务管理器定义Spring bean。

所以这是我们的数据源A的配置类:

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(basePackages = {"com.udith.repo.p", "com.udith.repo.q"})
public class ConfigA {

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

    @Primary
    @Bean(name = "entityManagerFactoryA")
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder builder,
                                                                       @Qualifier("dataSourceA") DataSource dataSource) {
        return builder
            .dataSource(dataSource)
            .packages("com.udith.model.p", "com.udith.model.q")
            .persistenceUnit("datasourceA")
            .build();
    }

    @Primary
    @Bean(name = "transactionManagerA")
    public PlatformTransactionManager transactionManager(@Qualifier("entityManagerFactoryA") EntityManagerFactory entityManagerFactory) {
        return new JpaTransactionManager(entityManagerFactory);
    }
}

这是数据源B的那个:

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(basePackages = {"com.udith.repo.r", "com.udith.repo.s"})
public class ConfigB {

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

    @Primary
    @Bean(name = "entityManagerFactoryB")
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder builder,
                                                                       @Qualifier("dataSourceB") DataSource dataSource) {
        return builder
            .dataSource(dataSource)
            .packages("com.udith.model.r", "com.udith.model.s")
            .persistenceUnit("datasourceB")
            .build();
    }

    @Primary
    @Bean(name = "transactionManagerB")
    public PlatformTransactionManager transactionManager(@Qualifier("entityManagerFactoryB") EntityManagerFactory entityManagerFactory) {
        return new JpaTransactionManager(entityManagerFactory);
    }
}

现在让我们简要讨论一下上面配置类中使用的一些重要注释。

  • 在每个配置类的顶部,@EnableJpaRepositories注释随属性一起添加basePackages。在此属性中,我们定义了包含与此特定数据源相关的JPA存储库类的Java包。
  • 然后我们定义方法,为该数据源创建实例。此方法还具有属性的注释,该注释告诉Spring 在创建此数据源实例时应使用前缀为给定值的属性(来自application.properties文件)。dataSource()javax.sql.DataSource@ConfigurationPropertiesprefix
  • 下一个方法entityManagerFactory负责为数据源创建bean。这里我们将先前创建的数据源实例作为方法参数传递,并使用构建器实例生成实体管理器工厂,提供包含与此数据源相关的模型类的Java包的名称。org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean
  • 最后,transactionManager方法创建要用于此数据源的实例。org.springframework.transaction.PlatformTransactionManager
  • 此外,您可能已经注意到,@Primary只有第一个配置类的bean定义中才有注释。这个注释告诉Spring使用第一个配置类中定义的数据源,实体管理器工厂和事务管理器作为主bean。

自定义JPA属性

如果您已完成到目前为止的步骤,则已完成使用多个数据源的基本要求。但在某些情况下,可能需要自定义一些JPA属性,例如,使用的命名策略。

当使用单个数据源时,也可以通过在application.properties文件中定义属性来完成这些操作。例如,您可以按如下方式设置命名策略。

spring.jpa.hibernate.naming-strategy = org.hibernate.cfg.ImprovedNamingStrategy

但是,当使用基于配置文件的数据源时(正如我们在前面的步骤中所做的那样),由于某种原因,不会应用application.properties文件中定义的这些属性。因此,我们必须通过代码将它们传递给实体管理器工厂构建器,如下所示。

@Primary
@Bean(name = "entityManagerFactoryA")
public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder builder,
                                                                  @Qualifier("dataSourceA") DataSource dataSource) {
  Map jpaProperties = new HashMap<>();
  jpaProperties.put("hibernate.naming_strategy", ImprovedNamingStrategy.class.getName());
  // any other customized JPA properties
  return builder
       .dataSource(dataSource)
       .packages("com.udith.model.p", "com.udith.model.q")
       .persistenceUnit("datasourceA")
       .properties(jpaProperties)
       .build();
}

完成此步骤后,您已使用Spring Boot应用程序成功配置了多个数据源。