스프링 부트에서 스프링 빈의 중복 등록과 충돌?

스프링 부트에서 스프링 빈의 중복 등록과 충돌?

이 글은 2021년 4월에 작성되었으며 블로그를 이전하며 옮기게 되었습니다.

저의 글에대한 피드백이나 지적은 언제나 환영입니다 😊

먼저 간단하게 Bean을 알아보자

• Bean은 Spring IoC Container가 관리하는 자바 객체, Spring Bean Container에 존재하는 객체를 말한다.
• 스프링 빈은 @Component 애노테이션을 이용하여 스프링이 자동으로 컨테이너에 빈을 등록해주는 방법이 있고
  @Bean 애노테이션을 이용하여 직접 등록해주는 방법이 있다

간단하게 컨테이너를 알아보자

주입을 이용하여 객체를 관리하는 컨테이너이다.
컨테이너의 사전적 의미는 무언가를 담는 용기, 즉 그릇을 의미한다.
이를 통해 접근하자면 컨테이너는 객체 관리를 주로 수행하는 그릇 정도로 이해할 수 있다.

그런데 이 스프링 빈을 등록 시 이름이 같다면 어떻게 될까?

두가지 상황이 있다

1. 자동 빈 등록 VS 자동 빈 등록
2. 수동 빈 등록 VS 자동 빈 등록

자동 빈 등록 VS 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데(클래스 이름에서 맨 앞글자만 소문자로 바뀌어 스프링 빈 등록이 된다), 그 이름이 같은 경우 스프링은 오류를 발생시킨다 ConflictingBeanDefiniionException 예외가 발생한다

수동 빈 등록 VS 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?

이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버 라이딩해버린다)

수동 빈 등록 시 남는 로그

  Overriding bean definition for bean 'beanName' with a different
  definition: replacing

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기보다는 프로젝트를 하다 보면 많은 스프링 빈이 등록되고, 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다!
그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

그래서 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌 나면 오류가 발생하게 기본 값을 바꾸었다. (1~2년 전쯤?)

수동 빈 등록, 자동 빈 등록 오류 시 스프링 부트 에러

Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true 

스프링 부트(@SpringBootApplication (스프링 부트 대표 시작 정보))인 Application을 실행하면 오류를 볼 수 있다.

application.properties 에서 spring.main.allow-bean-definition-overriding=true를 추가해 준다면 수동 빈이 자동 빈을 오버 라이딩하게 설정할 수 있다.