[트러블 슈팅] BeanCreationException 빈 충돌 해결을 위한 @ConditionalOnProperty 활용

문제 상황

현재 진행중인 GlowGrow 프로젝트는 MSA 기반의 멀티모듈 구조의 프로젝트입니다.

 

멀티 모듈 구조의 장점 중 하나인 재사용성을 극대화하고, 중복 코드를 줄이기 위해 common이라는 모듈을 만들었습니다. 이 모듈에는 여러 서비스에서 공통으로 사용하는 기능들을 포함시켰습니다.

 

S3를 활용한 파일 업로드 기능은 서비스 제공자와 사용자의 프로필 관리, 그리고 게시판 등 여러 곳에서 공통적으로 사용되고 있습니다. 이에 따라 코드 중복을 최소화하기 위해 S3 관련 기능을 Common 모듈로 이전했습니다.

 

그러나 이 과정에서 다음과 같은 빈(Bean) 생성 예외가 발생했습니다.

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 's3UploadService': Lookup method resolution failed

 

 

 

문제 원인

각 모듈의 의존성 설정은 현재 다음과 같습니다.

 

현재 앞서 설명했듯이 위와 같이 각 모듈에서는 공통 모듈을 의존하고 있습니다.

 

따라서 이렇게 각 모듈에서 공통 모듈을 의존성으로 추가하면, 동일한 S3UploadService 빈이 여러 모듈에서 중복 생성되려고 시도됩니다. 이로 인해 스프링 빈 설정이 충돌하며 BeanCreationException이 발생할 수 있습니다.

 

문제 해결

빈 충돌을 해결하기 위해서는 S3를 실제로 사용하는 모듈에서만 빈이 생성되도록 제어해야 합니다. 이를 위한 여러 방법(싱글톤 패턴, @Profile 등) 중 @ConditionalOnProperty 어노테이션을 선택했습니다.

@ConditionalOnProperty를 선택한 이유

 

• 프로파일과 독립적으로 더 세밀한 빈 제어가 가능
• 특정 모듈이나 기능별로 빈 활성화를 쉽게 관리할 수 있음

 

 

@ConditionalOnProperty 어노테이션은 프로퍼티 설정에 따라 특정 빈을 활성화하거나 비활성화할 수 있으므로, 프로파일과 관계없이 세분화된 조건으로 빈을 관리할 수 있습니다. 이는 특정 모듈이나 기능에서만 빈을 활성화해야 하는 상황에 적합합니다.

 

활성화 & 비활성화 설정

# 활성화
app:
  s3:
    enabled: true
    
# 비활성화
app:
  s3:
    enabled: false

 

@ConditionalOnProperty 어노테이션을 S3서비스에 추가하고, S3 Bean을 활성화 하고 싶은 모듈에서 위와 같이 활성화/ 비활성화 여부를 설정해주면 됩니다.

 

문제 해결 결과

 

위와 같이 BeanCreationException 에러가 발생하지 않고, 정상적으로 서버가 실행된 것을 확인할 수 있습니다.