multi-datasource Bean으로 전환

[cotchan]

작업 목적

• 프로젝트 내 mysql, mongodb를 사용하면서 각 각의 DB를 핸들링하는 transactionManager 정의 필요
• 또한 mongodb의 경우 multi document transaction을 위해서는 transactionManager 선언이 필수

작업 내용 목차

1. 작업내용1 링크
2. 작업내용2 링크

[cotchan]

작업내용1

rdb(MYSQL) - JavaConfig로 Datasource 설정 작업

• 관계형 DB에 대해 JavaConfig를 사용해서 Datasource 빈을 정의하는 방법에 대해 정리
• 연결해야할 datasource 가 여러개일 경우, 아래의 과정을 따라 프로퍼티를 별도로 설정하고, JavaConfig 파일을 설정

목차

1. JavaConfig에 application.yml 설정값 주입하여 dataSource 빈 직접 생성
   • 수정사항1
   • 수정사항2
   • 수정사항3(CamelCase에서 SnakeCase 변환)
2. JavaConfig 설정
   • @EnableJpaRepositories
   • DataSource와 JpaProperties
   • LocalContainerEntityManagerFactoryBean
   • PlatformTransactionManager

---

JavaConfig에 application.yml 설정값 주입하여 dataSource 빈 직접 생성

• 프로퍼티의 예약된 key에 datasource 설정을 하고 웹 애플리케이션을 실행하면 dataSource 빈이 자동으로 생성됩니다.
• 여러개의 database를 연결해야 할 경우에는 JavaConfig 또는 xml을 통한 datasource 설정이 필요합니다.
  • JavaConfig 설정으로 프로퍼티 값을 읽으려면 2가지 설정을 수정해야 합니다.

수정사항1

• spring.datasource에 설정되어있었던 driver-class-name, url, username, password를 hikari 내부로 옮깁니다.
• JavaConfig에서 @ConfigurationProperties로 dataSource 정보를 읽어들일 때, 트리형태로 datasource 하위 키인 hikari를 읽어들이지 않고, 같은 키 레벨에 설정된 곳에서 database url, driver-class-name, username, password 및 기타 정보를 읽어들입니다.

spring:
  datasource:
    hikari:
      driver-class-name: org.h2.Driver
      jdbc-url: jdbc:h2:tcp://localhost/~/daangn;MODE=MYSQL;
      username: sa
      password:

수정사항2

• 또한 hikariCP 는 database url을 jdbc-url이라는 예약된 키로 받기 때문에 url을 jdbc-url로 변경합니다.

수정사항3(CamelCase에서 SnakeCase 변환)

• 프로퍼티 설정으로 dataSource 빈 생성 시 CamelCase에서 SnakeCase로 자동으로 변환해줬습니다.
• 하지만 JavaConfig 설정으로 아래 설정을 추가해줘야 CamelCase에서 SnakeCase로 변환이 됩니다.
• 위의 수정사항1,2 보단 중요도가 많이 떨어지지만 막상 적용하지 않으면 에러가 나는 부분이기에 정리해놓습니다.

spring:
  jpa:
    properties:
      hibernate:
        implicit_naming_strategy: org.springframework.boot.orm.jpa.hibernate.SpringImplicitNamingStrategy
        physical_naming_strategy: org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy

JavaConfig 설정

package com.daangndaangn.common.configure;

import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
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 javax.sql.DataSource;

@Configuration // Configuration 클래스임을 명시
@EnableJpaRepositories(
    basePackages = "com.daangndaangn.common.api.repository", // 해당 DataSource를 적용할 패키지 경로, 해당 패키지가 적용될 repository
    entityManagerFactoryRef = "apiEntityManager",            // 해당 TransactionEntityManagerFactory가 사용할 메소드명
    transactionManagerRef = "apiTransactionManager"          // 해당 TransactinoManager가 참조할 메소드 명
)
public class ApiDbConfigure {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.hikari")
    public DataSource apiDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    @ConfigurationProperties(prefix = "spring.jpa")
    public JpaProperties jpaProperties() {
        return new JpaProperties();
    }

    @Bean
    public LocalContainerEntityManagerFactoryBean apiEntityManager(EntityManagerFactoryBuilder builder,
                                                                   DataSource dataSource,
                                                                   JpaProperties jpaProperties) {
        return builder
                .dataSource(dataSource)
                .properties(jpaProperties.getProperties())
                .packages("com.daangndaangn.common.api.entity")
                .persistenceUnit("default")
                .build();
    }

    @Primary
    @Bean(name = "apiTransactionManager")
    public PlatformTransactionManager apiTransactionManager(LocalContainerEntityManagerFactoryBean entityManagerFactory) {
        JpaTransactionManager transactionManager = new JpaTransactionManager(entityManagerFactory.getObject());
        return transactionManager;
    }
}

@EnableJpaRepositories

• multiple datasource 설정 시, 연동시킬 repositories 패키지와 entityManagerFactoryRef, transactionManagerRef를 설정하는 부분입니다.

DataSource와 JpaProperties

• spring.datasource.hikari에 설정한 구성 정보를 가져와 dataSource 빈을 구성합니다.
• spring.jpa에 설정한 jpa 관련 설정을 읽어들여 jpa 설정을 합니다.

@Bean
@ConfigurationProperties(prefix = "spring.datasource.hikari")
public DataSource apiDataSource() {
    return DataSourceBuilder.create().build();
}

@Bean
@ConfigurationProperties(prefix = "spring.jpa")
public JpaProperties jpaProperties() {
    return new JpaProperties();
}

LocalContainerEntityManagerFactoryBean

• 위에 설정했던 dataSource, jpaProperties 설정을 가져와 엔티티매니저를 만드는 entityManagerFactory 빈을 만듭니다.

@Bean
public LocalContainerEntityManagerFactoryBean apiEntityManager(EntityManagerFactoryBuilder builder,
                                                               DataSource dataSource,
                                                               JpaProperties jpaProperties) {

    return builder
            .dataSource(dataSource)
            .properties(jpaProperties.getProperties())
            .packages("com.daangndaangn.common.api.entity")
            .persistenceUnit("default")
            .build();
}

PlatformTransactionManager

• 위에 설정한 entityManagerFactory를 이용하여 트랜젝션 처리에 이용되는 transactionManager 빈을 만듭니다.

@Bean(name = "apiTransactionManager")
public PlatformTransactionManager apiTransactionManager(LocalContainerEntityManagerFactoryBean entityManagerFactory) {
    JpaTransactionManager transactionManager = new JpaTransactionManager(entityManagerFactory.getObject());
    return transactionManager;
}

---

• 출처
  • [Spring Boot] JavaConfig로 Datasource 설정하기
  • Spring Boot 1개에 DB 2개 연결?
  • Spring JPA – Multiple Databases

[cotchan]

작업내용2

Spring Data MongoDB TransactionManager 설정

• Spring Data MongoDB 사용 시 MongoTransactionManager를 설정하는 방법 정리
• 이걸 적용하려는 이유는 multi-document에 대한 ACID 트랜잭션을 적용하기 위함
  • 4.0 릴리즈 버전부터 MongoDB는 multi-document에 대해 ACID 트랜잭션을 지원

목차

1. MongoTransactionManager 적용이유
2. Replica-Set
3. MongoConfig class

---

MongoTransactionManager 적용이유

• 이걸 적용하려는 이유는 multi-document에 대한 ACID 트랜잭션을 적용하기 위함입니다.
• 프로젝트에서 채팅 방 생성 요청 API가 들어오면
  • ChattingRoom Document row 1개를 생성하고 이어서 Participant Doucment row 2개를 생성합니다.
  • ChattingRoom을 생성한 후에 Participant 생성 과정에서 에러 발생 시 이미 생성한 ChattingRoom도 롤백하기 위해 이걸 적용합니다.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
}

---

Replica-Set

• MongoDB TransactionManager 적용 시 몽고디비는 standalone이 아닌 Replica-Set으로 띄워야합니다.

$ mongod --dbpath=/Users/Chanyoung/data/db --replSet rs

// 몽고DB 접근 시
$ mongo

---

MongoConfig class

• 프로젝트 샘플 코드

@Configuration
@EnableMongoRepositories(
    basePackages = "com.daangndaangn.common.chat.repository"
)
public class MongoDbConfigure extends AbstractMongoClientConfiguration {

    @Bean(name="mongoTransactionManager")
    public MongoTransactionManager mongoTransactionManager(MongoDatabaseFactory dbFactory) {
        return new MongoTransactionManager(dbFactory);
    }

    @Override
    protected String getDatabaseName() {
        return "daangn_test";
    }
}

• Baeldung Reference

@Configuration
@EnableMongoRepositories(basePackages = "com.baeldung.repository")
public class MongoConfig extends AbstractMongoClientConfiguration{

    @Bean
    MongoTransactionManager transactionManager(MongoDatabaseFactory dbFactory) {
        return new MongoTransactionManager(dbFactory);
    }

    @Override
    protected String getDatabaseName() {
        return "test";
    }

    @Override
    public MongoClient mongoClient() {
        final ConnectionString connectionString = new ConnectionString("mongodb://localhost:27017/test");
        final MongoClientSettings mongoClientSettings = MongoClientSettings.builder()
            .applyConnectionString(connectionString)
            .build();
        return MongoClients.create(mongoClientSettings);
    }
}

---

• 출처
  • Spring Data MongoDB Transactions
  • Hands on MongoDB 4.0 transactions with Spring Data
  • rs.initiate()