Spring JPA::Master/Slave 분기처리(1)

📌 모든 소스는 Github에 있습니다.

DB Replication

먼저, Spring의 작업을 알아보기 전에 DB Replication에 대해 설명해보겠습니다.

보통 서비스 기업에서 DB에 대해 많은 Connection과 Transaction이 일어나게 되고,

이것을 분산 처리 하기 위해 1대의 쓰기/읽기 용도의 Master DB, 여러대의 읽기 전용의 Slave를 두게 됩니다.

이를 DB Replication이라 합니다.

@Transacional

Spring Framework에서 제공하는 @Transactional 어노테이션의 readOnly 속성을 통하여 특정 비즈니스 로직을 Master/Slave DB로 분기처리 해보도록 하겠습니다.

환경

• Java 11
• spring boot 2.5.7
• gradle 7.2
• h2

Dependencies

🖊️ build.gradle

dependencies{
implementation 'org.springframework.boot:spring-boot-starter-web'
   implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
   compileOnly 'org.projectlombok:lombok'
   runtimeOnly 'com.h2database:h2'
   annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
   annotationProcessor 'org.projectlombok:lombok'
   testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

스프링 설정

🖊️ application-test.yml

spring:
  application:
    name: jpa-multidb-connection
  config:
    activate:
      on-profile:
        - test
  jpa:
    hibernate:
      ddl-auto: create-drop
    generate-ddl: true
    properties:
      hibernate:
        format_sql: true
        use_sql_comments: true
  datasource:
    master:
      driver-class-name: org.h2.Driver
      jdbc-url: jdbc:h2:tcp://localhost/~/master
      read-only: false
      username: sa
      password:
    slave:
      driver-class-name: org.h2.Driver
      jdbc-url: jdbc:h2:tcp://localhost/~/slave
      read-only: true
      username: sa
      password:

logging:
  level:
    org.hibernate.SQL: debug
    org.hibernate.type: trace
    com.citizen.multidb: debug

코드

@SpringBootApplication

우선 제가 만들 DataSource 클래스가 적용되어야 하기 때문에 Spring Boot의 Auto-Configuration 클래스 중 하나인 DataSourceAutoConfiguration을 제외 시킵니다.

@AutoConfigureBefore를 사용하는 방법도 있으나 이번에는 아예 제외시켰습니다.

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class MultidbApplication {

	public static void main(String[] args) {
		SpringApplication.run(MultidbApplication.class, args);
	}
}

ReplicationRouingDataSource

@Transactional의 readOnly에 따라 접근한 DB, Master와 Slave를 구분짓도록 하겠습니다.

@Slf4j
public class ReplicationRoutingDataSource extends AbstractRoutingDataSource // -(1) {

    @Override
    protected Object determineCurrentLookupKey() {

        if (log.isDebugEnabled()) {
            log.debug("current getCurrentTransactionName : {}", TransactionSynchronizationManager.getCurrentTransactionName());
            log.debug("current isCurrentTransactionReadOnly : {}", TransactionSynchronizationManager.isCurrentTransactionReadOnly());
            log.debug("current isActualTransactionActive : {}", TransactionSynchronizationManager.isActualTransactionActive());
            log.debug("current getCurrentTransactionIsolationLevel : {}", TransactionSynchronizationManager.getCurrentTransactionIsolationLevel());
            log.debug("current getResourceMap : {}", TransactionSynchronizationManager.getResourceMap());
        }

        return TransactionSynchronizationManager.isCurrentTransactionReadOnly() ? "slave" : "master"; // -(2)
    }
}

(1) AbstractRoutingDataSource

org.springframework.jdbc.datasource.lookup패키지에서 제공하는 추상 클래스로 여러가지 DataSource를 Map으로 담고 Custom하게 설정한 로직에 따라 붙은 DB를 결정하게 합니다.

determineCurrentLookupKey() 메소드를 Override하여 TargetDataSource의 키를 어떤식으로 결정할지 코드를 작성합니다.

저는 readOnly에 따라 master와 slave를 결정할 것이기 때문에 아래와 같이 코드를 짰습니다.

(2) TransactionSynchronizationManager

org.springframework.transaction.support의 TransactionSynchronizationManager의 isCurrentTransactionReadOnly() 메소드를 사용하면 현재 Transaction의 readOnly 속성을 가져옵니다.

따라서, readOnly일 경우 Slave를 readOnly가 아닐 경우 Master의 구분자를 반환하도록 합니다.

번외

번외로 AbstractRoutingDataSource에서 어떤 시점에 DataSource가 결정되는지 궁금하여 내부를 살펴보았습니다. 내부에서 determineTargetDataSource()라는 메소드와 getConnection() 확인할 수 있습니다.

AbstractRoutingDataSource를 상속한 ReplicationRoutingDataSource가 Spring Bean으로 등록되고, getConnection()이 호출될 때, determineCurrentLookupKey() → determineTargetDateSource()를 호출하여 DataSource를 결정하는 것이었습니다.

또한 determineTargetDateSource()가 protected로 되어있는 것을 보아하니 이 메소드도 Override하여 재정의로 사용할 수 있겠다 싶었습니다.

DbConfig

다음으로 실제로 ReplicationRoutingDataSource를 가지고 Spring에 적용될 Config 클래스를 만들어 보겠습니다.

DbConfig 클래스에는 Master/Slave, ReplicationRouting DataSource, EntityManagerFactory, TransactionManager를 Bean으로 설정합니다.

@Configuration
@EnableJpaRepositories( // -(1)
    entityManagerFactoryRef = DbConfig.MULTI_DB_ENTITY_MANAGER,
    transactionManagerRef = DbConfig.MULTI_DB_TX_MANAGER,
    basePackages = DbConfig.MULTI_DB_COMPONENT_PACKAGE
)
public class DbConfig {

    public static final StringMULTI_DB_ENTITY_MANAGER= "multidbEntityManager";
    public static final StringMULTI_DB_TX_MANAGER= "multidbTransactionManager";
    public static final StringMULTI_DB_COMPONENT_PACKAGE= "com.citizen.multidb.domain";

    private final String MULTI_DB_MASTER_DATA_SOURCE = "multidbMasterDataSource";
    private final String MULTI_DB_SLAVE_DATA_SOURCE = "multidbSlaveDataSource";
    private final String MULTI_DB_ROUTING_DATA_SOURCE = "multidbRoutingDataSource";
    private final String MULTI_DB_DATA_SOURCE = "multidbDataSource";

    private final String MULTI_DB_MASTER_PROPERTIES_PREFIX = "spring.datasource.master";
    private final String MULTI_DB_SLAVE_PROPERTIES_PREFIX = "spring.datasource.slave";

    private final String MULTI_DB_PERSISTENCE_UNIT = "multidb";

		// -(2)
    @ConfigurationProperties(prefix = MULTI_DB_MASTER_PROPERTIES_PREFIX)
    @Bean(name = MULTI_DB_MASTER_DATA_SOURCE)
    public DataSource multidbMasterDataSource() {
        return new HikariDataSource();
    }

		// -(3)
    @ConfigurationProperties(prefix = MULTI_DB_SLAVE_PROPERTIES_PREFIX)
    @Bean(name = MULTI_DB_SLAVE_DATA_SOURCE)
    public DataSource multidbSlaveDataSource() {
        return new HikariDataSource();
    }

		// -(4)
    @Bean(name = MULTI_DB_ROUTING_DATA_SOURCE)
    public DataSource multidbRoutingDataSource(
        @Qualifier(MULTI_DB_MASTER_DATA_SOURCE) DataSource multiMasterDataSource,
        @Qualifier(MULTI_DB_SLAVE_DATA_SOURCE) DataSource multiSlaveDataSource
    ) {
        ReplicationRoutingDataSource replicationRoutingDataSource = new ReplicationRoutingDataSource();

        Map<Object, Object> dataSourceMap = new HashMap<>();
        dataSourceMap.put("master", multiMasterDataSource);
        dataSourceMap.put("slave", multiSlaveDataSource);
        replicationRoutingDataSource.setTargetDataSources(dataSourceMap);
        replicationRoutingDataSource.setDefaultTargetDataSource(multiMasterDataSource);

        return replicationRoutingDataSource;
    }

		// -(5)
    @Primary
    @DependsOn({MULTI_DB_MASTER_DATA_SOURCE, MULTI_DB_SLAVE_DATA_SOURCE,
        MULTI_DB_ROUTING_DATA_SOURCE})
    @Bean(name = MULTI_DB_DATA_SOURCE)
    public DataSource multidbDataSource(
        @Qualifier(MULTI_DB_ROUTING_DATA_SOURCE) DataSource multidbRoutingDataSource) {
        return new LazyConnectionDataSourceProxy(multidbRoutingDataSource);
    }

		// -(6)
    @Primary
    @Bean(name =MULTI_DB_ENTITY_MANAGER)
    public LocalContainerEntityManagerFactoryBean multidbEntityManager(
        @Qualifier(MULTI_DB_DATA_SOURCE) DataSource multidbDataSource,
        EntityManagerFactoryBuilder builder
    ) {
        return builder
            .dataSource(multidbDataSource)
            .packages(MULTI_DB_COMPONENT_PACKAGE)
            .persistenceUnit(MULTI_DB_PERSISTENCE_UNIT)
            .build();
    }

		// -(7)
    @Primary
    @Bean(name =MULTI_DB_TX_MANAGER)
    public PlatformTransactionManager multidbTransactionManager(
        @Qualifier(MULTI_DB_ENTITY_MANAGER) EntityManagerFactory entityManagerFactory) {
        return new JpaTransactionManager(entityManagerFactory);
    }
}

(1) @EnableJpaRepositories

@EnableJpaRepositories를 사용하여 Repository가 있는 package, EntityManagerFactory, TransactionManager를 지정해 줍니다.

(2) multidbMasterDataSource

@ConfigurationProperties를 사용하여 application-test.yml에 작성한 spring.datasource.master 값을 읽어 HikariDataSource()에 binding 하고, 해당 메소드를 Bean으로 등록합니다.

(3) multidbSlaveDataSource

multidbMasterDataSource와 같은 방식으로 slave의 정보를 토대로 Bean으로 등록합니다.

(4) multidbRoutingDataSource

생성한 ReplicationRoutingDataSource에 Master/Slave에 대한 DataSource에 key를 넣은 Map을 TargetDataSource로 설정하고, Default를 Master를 보도록 DefaultTargetDataSource로 등록합니다.

(5) multidbDataSource

위의 multidbRoutingDataSource를 기반으로 LazyConnectionDataSourceProxy를 생성하여 반환하고 이를 @Primary 즉, DataSource 중에서 우선하여 사용하도록 지정합니다.

💡Spring은 트랜잭션에 진입하는 순간 DataSource의 Connection을 가져옵니다. (심지어 아무 사용도 하지 않는 경우에도) 지금 제가 실습하는 Master/Slave 환경에서 트랜잭션 진입 시점에서 커넥션을 결정하게 되면 readOnly의 속성과는 상관없이 Master로만 Connection이 붙는 문제가 발생할 것입니다. 따라서, LazyConnectionDataSourceProxy를 사용하여 실제로 커넥션이 필요한 상황에서만 커넥션을 사용하도록 합니다.

(6) multidbEntityManager

LocalContainerEntityManagerFactoryBean을 반환하는 EntityManagerFactory에 위에서 Bean으로 등록한 multidbDataSource, Entity 패키지 경로, persistenceUnit을 세팅하여 반환한다.

❓사실 EntityManagerFactory를 Bean으로 등록하는건 알겠는데 왜 LocalContainerEntityManagerFactoryBean가 사용되는진 나도 저도 잘 모르겠습니다;; 추후 공부해서 포스트에 추가하도록 하겠습니다~

(7) multidbTransactionManager

TransactionManager로써 저는 Jpa를 사용하기 때문에 JpaTransactionManager를 반환해줍니다.

❓Spring에서 로우레벨의 트랜잭션 서비스를 이용하기 위해 PlatformTransactionManager를 사용하는 것은 알겠지만, 정확히 어떤 방식으로 동작하는진 아직 학습이 부족하네요.. 위의 LocalContainerEntityManagerFactoryBean와 마찬가지로 학습하는대로 포스트에 내용을 추가하도록 하겠습니다.

마무리

글이 너무 길어지는거 같아 이번 포스팅은 설정 관련 클래스 작성법으로 마무리하고 다음에 비즈니스 코드에서 @Transactional의 readOnly 사용법과 테스트 코드 위주로 설명하도록 하겠습니다.