SpringBoot Multi DataSource - JPA

🔗 SpringBoot에서 멀티 데이터소스 설정하기 - JPA

하나의 프로젝트에서 여러 개의 다른 데이터베이스를 사용해야 하는 경우가 있는데요, 이런 경우 DataSource를 커스텀으로 설정하여 관리할 수 있습니다.

간단한 설정을 통해 한 프로젝트에서 다른 데이터베이스를 사용하는 방법을 정리합니다.

예제 코드는 GitHub에서 확인할 수 있습니다.

 

 

🎈 application.yml

yml 파일에 두 개의 데이터베이스(datasource, datasource-second)를 설정합니다.

(기본 스프링 부트의 데이터베이스 설정과 달리 멀티 데이터 소스 HikariConfig에서는 url이 아닌 jdbc-url으로 네이밍을 해야합니다.)

 

 

출처: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto.data-access.configure-custom-datasource

 

 

🎈 DataSource Configuration 

아래 코드에서 사용할 패키지명은 다음과 같습니다.

•  User Entity: package com.example.springmultidatasourcejpa.user.entity
•  User Repository: package com.example.springmultidatasourcejpa.user.repository
•  Product Entity: package com.example.springmultidatasourcejpa.product.entity
•  Product Repository: package com.example.springmultidatasourcejpa.product.repository

 

UserDataSourceConfiguration

•  @EnableJpaRepositories: JPA Repository Bean을 활성화해주는 어노테이션
  •  basePackages: SpringBoot가 Bean Scan 범위 설정 (Repository 패키지 설정)
  •  entityMaganerFactoryRef: DataSource, Hibernate Property, Entity 설정 (Entity 패키지 설정)
  •  transactionManagerRef: 스프링의 트랜잭션 설정

멀티 데이터소스에서 트랜잭션을 묶어주려면 ChainedTransactionManager 라는 클래스를 사용하여 설정할 수 있습니다.
참고: https://taes-k.github.io/2020/06/09/chained-transaction-manager/

•  @Primary: 스프링에서 하나의 타입에 대해 여러 개의 Bean이 존재할 수 없기때문에 우선순위를 설정하는 어노테이션
• mainEntityManager(): 위 entityManagerFactoryRef 속성에 사용할 Bean 생성 메서드
  • LocalContainerEntityManagerFactoryBean: JPA EntityManagerFactory를 생성하는 FactoryBean으로 DataSource, Entity가 위치한 경로 Scan 설정, Hibernate 기반으로 동작하는 것을 설정하는 JpaVenoderAdapter 등을 지정합니다.

basePackages

entityMaganerFactoryRef, transactionManagerRef

 

ProductDataSourceConfiguration

@Primary 어노테이션을 제외하면 UserDataSource와 설정은 동일합니다.

 

 

🎈 Test

위와 같이 간단한 컨트롤러를 작성하고 User, Product API를 호출해보면 각각 다른 데이터베이스에 데이터가 저장이됩니다.

datasource

datasource-second

 

 

📄 참고문서

• https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto.data-access.configure-custom-datasource
• https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#configurationproperties-scanning