멀티 DB환경에서 JPA 사용시 주의점 (feat. connection leak)

JPA에서 Muti Datasource 설정에 관한 트러블 슈팅을 기록한 포스팅입니다. 최종 세팅 방식은 하단에 기재되어 있습니다.

문제상황

저희 서비스는 하나의 프로젝트에서 여러대의 DataBase를 연동하는 환경입니다. 그 중에서 몇개의 DataBase만 필요에 의해 JPA/QueryDsl을 연동하여 사용하는데 최근에 새로운 Datasource를 추가하여 QueryDsl을 사용하던 중 다음과 같은 connection leak warning이 뜨는 것을 확인하였습니다.

java.lang.Exception: Apparent connection leak detected

문제의 원인을 파악하기 위해 hikari로그를 확인해보니, 쿼리가 모두 실행된 후에도 active connenction이 유지되고 있었고(커넥션을 반납하지 않음) 일정 시간이 지나고 나니 connection이 완전히 close되어 요청을 아예 실행할 수 없다는 에러가 발생하였습니다.

[HikariPool-3 housekeeper] [pool.HikariPool]- HikariPool-3 - Pool stats (total=10, active=1, idle=9, waiting=0)

..

could not prepare statement [Connection is closed] [select ...]

문제가 재현된 요청은 슬로우 쿼리가 없는 요청이였고 QueryDsl을 사용한 경우에만 발생한다는 점을 보아 설정에 문제가 있을 것이라 추측할 수 있었습니다.

잘못된 코드

아래는 문제가 되었던 코드의 예시입니다.

@Bean("firstJpaQueryfactory")
public JPAQueryFactory firstJpaQueryfactory(
    @Qualifier("firstEntityManagerFactory") EntityManagerFatory entityManagerFatory
) {
    EntityManager entityManager = entityManagerFatory.createEntityManager();
    return new JPAQueryFactory(entityManager);
}

@Bean("secondJpaQueryfactory")
public JPAQueryFactory secondJpaQueryfactory(
    @Qualifier("secondEntityManagerFactory") EntityManagerFatory entityManagerFatory
) {
    EntityManager entityManager = entityManagerFatory.createEntityManager();
    return new JPAQueryFactory(entityManager);
}

해당 코드는 멀티 Datasource를 사용하는 JPAQueryFactory를 빈으로 등록하는 코드입니다.

단일 DB 환경에서는 Spring이 자동으로 빈을 주입해주기때문에(Querydsl 4.이상) 별도 설정 없이도 JPAQueryFactory를 사용할 수 있습니다. 멀티 DB 환경에서는 동일한 타입의 DataSource bean이 여러 개 존재하기 때문에 어떤 DataSource를 사용해야 할지 판단할 수 있도록 사용하고자하는 DataSource 별 EntityManagerFactory와 TransactionManager, JPAQueryFactory와 같은 JPA 관련 bean들을 명시적으로 구성해주어야 합니다.

문제 원인

(문제가 무엇인지 찾으셨나요?)
위 코드가 문제가 되었던 이유는 JPAQueryFactory에 EntityManager를 직접 주입했기 때문입니다.

JPA는 기본적으로 요청 당 하나의 EntityManager를 사용합니다. 각 EntityManager는 내부적으로 DB 커넥션 풀을 통해 DB에 접근합니다. EntityManager는 thread-safe하지 않기 때문에 스레드 간 공유되어서는 안 되며, 트랜잭션이 완료된 후에는 커넥션을 반납해야 합니다.

스프링과 같은 컨테이너 환경에서는 개발자가 EntityManager를 직접 생성하지 않고 컨테이너에 위임하는데, 스프링은 싱글톤 기반으로 동작하기 때문에 기본적으로 빈의 속성값은 모든 스레드가 공유하게 됩니다. 따라서 스프링은 EntityManager의 thread-safe를 보장하기 위해 프록시를 통해 EntityManager를 관리합니다.
프록시 객체는 트랜잭션 범위에 따라 EntityManager를 생성하고 관리합니다. 이를 통해 각 트랜잭션마다 새로운 EntityManager가 생성되며, 트랜잭션이 종료되면 자동으로 EntityManager가 닫히고 커넥션이 반환됩니다.

 

위 코드와 같이 EntityManagerFatory를 주입 받아 EntityManager를 생성할 경우 JPAQueryFactory가 프록시가 아닌 실제 EntityManager 인스턴스를 직접 사용하게 됩니다. 이로 인해 요청이 종료되어도 커넥션이 반납되지 않고, 모든 요청에서 동일한 커넥션을 재사용하는 문제가 발생하게 된 것 입니다.

EntityManager가 thread-safe하지 않으면 race condition이 발생할 수 있으며, 다른 스레드에서 예기치 않게 flush를 수행하거나 엔티티를 조회하는 등의 문제가 발생할 수 있습니다.

해결방법 및 변경사항

EntityManager는 thread-safe하게 사용하기 위해서는 EntityManager 객체를 bean으로 등록하면 안되고 직접 호출할 경우에는 @PersistenceContext를 통해 주입받아 사용해야합니다.

 

잘못된 주입 방법

@Service
public class ProblematicService {
    private final EntityManagerFactory emf;
    private final EntityManager em;  // 직접 생성한 EntityManager

    public ProblematicService(EntityManagerFactory emf) {
        this.emf = emf;
        this.em = emf.createEntityManager();  // 이렇게 하면 안 됨!
    }
}

올바른 주입 방법

@Service
public class RecommendedService {
    // 1. 생성자 주입
    private final EntityManager em;

    public RecommendedService(EntityManager em) {
        this.em = em;
    }
}

@Service
public class RecommendedService {
    // 2. @PersistenceContext 사용
    @PersistenceContext
    private EntityManager entityManager;
}

 

Spring boot 2.0 부터는 @Autowired로도 EntityManager주입이 가능합니다. 스프링부트가 자동으로 @PersistenceContext로 대체해 빈을 등록하기 때문입니다.

 

위 문제의 코드를 아래와 같이 개선하였습니다.

@Configuration
public class QuerydslConfig {

    @PersistenceContext(unitName = "firstEntityManager")
    private EntityManager firstEntityManager;

    @PersistenceContext(unitName = "secondEntityManager")
    private EntityManager secondEntityManager;

    @PersistenceContext(unitName = "thirdEntityManager")
    private EntityManager thirdEntityManager;

    @Primary
    @Bean("firstjpaQueryFactory")
    public JPAQueryFactory firstJpaQueryFactory() {
        return new JPAQueryFactory(firstEntityManager);
    }

    @Bean("secondJpaQueryFactory")
    public JPAQueryFactory secondJpaQueryFactory() {
        return new JPAQueryFactory(secondEntityManager);
    }

    @Bean("thirdJpaQueryfactory")
    public JPAQueryFactory thirdJpaQueryfactory() {
        return new JPAQueryFactory(thirdEntityManager);
    }
}

---

Muti Datasource 설정 가이드

위 내용을 바탕으로 최종 설정은 다음과 같이 정리하였습니다.

Datasource bean 추가

@Configuration
public class DataSourceConfig {

    private static final String FIRST_DATASOURCE = "firstDataSource";
    private static final String SECOND_DATASOURCE = "secondDataSource";
    private static final String THIRD_DATASOURCE = "thirdDataSource";

    @Primary // 메인 DB
    @Bean(FIRST_DATASOURCE)
    @ConfigurationProperties(prfix = "spring.datasource.first")
    public DataSource corownDataSource(){
        return DataSourceBuilder.create()
                    .type(HikariDataSource.class)
                    .build();
    }

    @Bean(SECOND_DATASOURCE)
    @ConfigurationProperties(prfix = "spring.datasource.second")
    public DataSource corbatDataSource(){
        return DataSourceBuilder.create()
                    .type(HikariDataSource.class)
                    .build();
    }

    @Bean(THIRD_DATASOURCE)
    @ConfigurationProperties(prfix = "spring.datasource.third")
    public DataSource custonDataSource(){
        return DataSourceBuilder.create()
                    .type(HikariDataSource.class)
                    .build();
    }
}

Transaction config 추가

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
        basePackages = "kr.co.sample.domain.first", // 해당 DB가 있는 패키지(폴더) 경로
        entityManagerFactoryRef = "firstEntityManagerFactory", // EntityManagerFactory 이름
        transactionManagerRef = "firstTransactionManager" // TransactionManager 이름
)
public class FirstTransactionConfig {

    @Autowired
    @Qualifier("firstDataSource")
    private DataSource firstDataSource;

    @Bean(name = "firstEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean firstEntityManagerFactory(EntityManagerFactoryBuilder builder) {
        return builder
                .dataSource(customDataSource)
                .packages("kr.co.sample.domain.first.entity") // 첫번째 DB와 관련된 엔티티들이 있는 패키지(폴더) 경로
                .persistenceUnit("firstEntityManager")  // EntityManager unit 이름
                .build();
    }

    @Bean(name = "firstTransactionManager")
    public PlatformTransactionManager firstTransactionManager(
            final @Qualifier("firstEntityManagerFactory") LocalContainerEntityManagerFactoryBean localContainerEntityManagerFactoryBean
    ) {
        return new JpaTransactionManager(localContainerEntityManagerFactoryBean.getObject());
    }
}

JpaQueryFactory bean 추가 (QueryDsl 사용시)

@Configuration
public class QuerydslConfig {

    @PersistenceContext(unitName = "firstEntityManager")
    private EntityManager corownEntityManager;

    @PersistenceContext(unitName = "secondEntityManager")
    private EntityManager secondEntityManager;

    @PersistenceContext(unitName = "thirdEntityManager")  // EntityManager unit 이름
    private EntityManager thirdEntityManager;

    @Primary
    @Bean("firstjpaQueryFactory")
    public JPAQueryFactory firstJpaQueryFactory() {
        return new JPAQueryFactory(firstEntityManager);
    }

    @Bean("secondJpaQueryFactory")
    public JPAQueryFactory secondJpaQueryFactory() {
        return new JPAQueryFactory(corbatEntityManager);
    }

    @Bean("thirdJpaQueryFactory")
    public JPAQueryFactory thirdJpaQueryFactory() {
        return new JPAQueryFactory(customEntityManager);
    }
}

커스텀 Tranactional 어노테이션 추가

@Transaction 어노테이션 또한 default로 Primary TransactionManager 빈을 사용하기 때문에
추가 DataSource에 대한 트랜잭션을 사용하기 위해서는 value 옵션을 지정해주어야합니다.

@Transactional(value = "secondTransactionManager")

 

자주 사용되는 트랜잭션의 경우 다음과 같이 custom transaction annotation을 생성해서 사용하도록 합니다.

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Transactional
public @interface SecondTransaction {

    String transactionManager() default "secondTransactionManager"; // TransactionManager 이름

    Propagation propagation() default Propagation.REQUIRED;

    Isolation isolation() default Isolation.DEFAULT;

    int timeout() default -1;

    boolean readOnly() default false;
}

커스텀 어노테이션에 @Transactional만 붙여주면 기본적으로 @Transactional과 같은 동작을 합니다.
readOnly와 같은 @Transactional의 속성들과 매칭되는 속성을 정의하면 스프링이 이를 읽고 @Transactional의 속성으로 인식하여 동작합니다.

 

---

 

이번 포스팅은 Spring의 EntityManager 프록시 기능과 Thread-safe와의 관계를 간과하고 발생했던 이슈를 다뤄봤습니다. Spring에서 제공해주던 기능을 커스텀하게 사용할 경우에는 항상 주의깊게 살펴야한다는 걸 다시 한번 느꼈습니다. 끝까지 읽어주셔서 감사합니다 🤗