SpringBootで複数のデータソースを構成して使用する

投稿日: 2022-10-28 2022-10-28
タグ: Spring Boot, Spring Persistence

1. 概要

Spring Bootアプリケーションの一般的なシナリオは、単一のリレーショナルデータベースにデータを格納することです。ただし、複数のデータベースにアクセスする必要がある場合もあります。

このチュートリアルでは、Spring Bootで複数のデータソースを構成および使用する方法を学習します。単一のデータソースを処理する方法を見つけるために、 Spring DataJPAの概要に関する記事を読むことができます。

2. デフォルトの動作

Spring Bootでのデータソースの宣言は、application.ymlのように見えることがわかっています。

spring:
  datasource:
    url: ...
    username: ...
    password: ...
    driverClassname: ...

内部的に、Springはこれらの設定をorg.springframework.boot.autoconfigure.jdbc.DataSourcePropertiesのインスタンスにマップします。実装を見てみましょう：

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties implements BeanClassLoaderAware, InitializingBean {

    // ...

    /**
     * Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
     */
    private String driverClassName;

    /**
     * JDBC URL of the database.
     */
    private String url;

    /**
     * Login username of the database.
     */
    private String username;

    /**
     * Login password of the database.
     */
    private String password;

    // ...

}

構成のプロパティをJavaオブジェクトに自動的にマップする@ConfigurationPropertiesアノテーションを指摘する必要があります。

3. デフォルトの拡張

したがって、複数のデータソースを使用するには、Springのアプリケーションコンテキスト内で異なるマッピングを持つ複数のBeanを宣言する必要があります。

これは、構成クラスを使用して行うことができます。

@Configuration
public class TodoDatasourceConfiguration {

    @Bean
    @ConfigurationProperties("spring.datasource.todos")
    public DataSourceProperties todosDataSourceProperties() {
        return new DataSourceProperties();
    }

    @Bean
    @ConfigurationProperties("spring.datasource.topics")
    public DataSourceProperties topicsDataSourceProperties() {
        return new DataSourceProperties();
    }

}

データソースの構成は次のようになります。

spring:
  datasource:
    todos:
      url: ...
      username: ...
      password: ...
      driverClassName: ...
    topics:
      url: ...
      username: ...
      password: ...
      driverClassName: ...

次に、DataSourcePropertiesオブジェクトを使用してデータソースを作成できます。

@Bean
public DataSource todosDataSource() {
    return todosDataSourceProperties()
      .initializeDataSourceBuilder()
      .build();
}

@Bean
public DataSource topicsDataSource() {
    return topicsDataSourceProperties()
      .initializeDataSourceBuilder()
      .build();
}

4. Spring Data JDBC

Spring Data JDBCを使用する場合は、DataSourceごとにJdbcTemplateのインスタンスを1つ構成する必要もあります。

@Bean
public JdbcTemplate todosJdbcTemplate(@Qualifier("todosDataSource") DataSource dataSource) {
    return new JdbcTemplate(dataSource);
}

@Bean
public JdbcTemplate topicsJdbcTemplate(@Qualifier("topicsDataSource") DataSource dataSource) {
    return new JdbcTemplate(dataSource);
}

次に、@Qualifierを指定してそれらを使用することもできます。

@Autowired
@Qualifier("topicsJdbcTemplate")
JdbcTemplate jdbcTemplate;

5. Spring Data JPA

Spring Data JPAを使用する場合は、次のようなリポジトリを使用します。ここで、Todoはエンティティです。

public interface TodoRepository extends JpaRepository<Todo, Long> {}

したがって、データソースごとにEntityManagerファクトリを宣言する必要があります。

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
  basePackageClasses = Todo.class,
  entityManagerFactoryRef = "todosEntityManagerFactory",
  transactionManagerRef = "todosTransactionManager"
)
public class TodoJpaConfiguration {

    @Bean
    public LocalContainerEntityManagerFactoryBean todosEntityManagerFactory(
      Qualifier("todosDataSource") DataSource dataSource,
      EntityManagerFactoryBuilder builder) {
        return builder
          .dataSource(todosDataSource())
          .packages(Todo.class)
          .build();
    }

    @Bean
    public PlatformTransactionManager todosTransactionManager(
      @Qualifier("todosEntityManagerFactory") LocalContainerEntityManagerFactoryBean todosEntityManagerFactory) {
        return new JpaTransactionManager(Objects.requireNonNull(todosEntityManagerFactory.getObject()));
    }

}

以下の制限に注意する必要があります。

パッケージを分割して、データソースごとに1つの@EnableJpaRepositoriesを許可する必要があります。

残念ながら、 EntityManagerFactoryBuilder を挿入するには、データソースの1つを@Primaryとして宣言する必要があります。これは、EntityManagerFactoryBuilderがorg.springframework.boot.autoconfigure.orm.jpa.JpaBaseConfigurationで宣言されており、このクラスに単一のデータソースを挿入する必要があるためです。一般に、フレームワークの一部では、複数のデータソースが構成されていることを期待しない場合があります。

6. Hikari接続プールを構成する

Hikari を構成する場合は、データソース定義に@ConfigurationPropertiesを追加するだけです。

@Bean
@ConfigurationProperties("spring.datasource.todos.hikari")
public DataSource todosDataSource() {
    return todosDataSourceProperties()
      .initializeDataSourceBuilder()
      .build();
}

次に、application.propertiesファイルに次の行を挿入できます。

spring.datasource.todos.hikari.connectionTimeout=30000 
spring.datasource.todos.hikari.idleTimeout=600000 
spring.datasource.todos.hikari.maxLifetime=1800000

7. 結論

この記事では、SpringBootを使用して複数のデータソースを構成する方法を学習しました。いくつかの構成が必要であり、標準から逸脱すると落とし穴がある可能性があることを確認しましたが、最後に、それが可能であることがわかります。

いつものように、すべてのコードはGitHubで利用できます。

getdocs

13036