스프링 핵심 원리 - 기본편 | 6. 컴포넌트 스캔

김영한님의 [스프링 핵심 원리 - 기본편]을 보고 작성한 글입니다:)

---

지금까지의 수동 빈 등록

• 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 스프링 빈 등록한다.
• 등록해야 할 스프링 빈이 수백개가 되면, 설정 정보도 커지고 누락하는 문제가 발생한다.
• 무엇보다 개발자가 귀찮다...😭

 

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공!

그럼 이제 컴포넌트 스캔이 무엇인지 알아봅시다.

 

---

 

1. 컴포넌트 스캔과 의존관계 자동 주입

컴포넌트 스캔 사용 방법 1

@Configuration
@ComponentScan
public class AutoAppConfig {
}

• 설정 정보에 @ComponentScan를 붙여주기만 하면 된다.
• 기존의 설정 정보과 달리 @Bean으로 등록한 클래스가 없다.
• 참고로 스프링 컨테이너는 @Configuration이 붙은 클래스를 설정 정보로 사용한다.

 

컴포넌트 스캔 사용 방법 2

@Component
public class MemoryMemberRepository implements MemberRepository { ... }

@Component
public class RateDiscountPolicy implements DiscountPolicy { ... }

• 컴포넌트 스캔은 이름 그대로 @Component가 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
• 따라서 스프링 빈으로 등록하고 싶은 클래스에 @Component를 붙인다.

 

컴포넌트 스캔 사용 방법 3 - 의존관계 자동 주입

@Component
public class MemberServiceImpl implements MemberService {
     private final MemberRepository memberRepository;
     
     @Autowired
     public MemberServiceImpl(MemberRepository memberRepository) {
     	this.memberRepository = memberRepository;
     }
}

• 수동 빈 등록에서는 @Bean으로 직접 설정 정보를 작성하고, 의존관계도 직접 명시했다.
• 이제는 이런 설정 정보 자체가 없으므로, @Autowired를 통해서 의존관계를 자동으로 주입해주어야 한다.

 

컴포넌트 스캔과 자동 의존관계주입 동작 방식

1. @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
   • 빈 이름 기본 전략: 클래스명을 사용하되 맨 앞글자만 소문자 사용한다. ex) MemberServiceImpl 클래스 memberServiceImpl
   • 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런 식으로 이름을 부여하면 된다.
2. 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
   • 기본 조회 전략: 타입이 같은 빈을 찾아서 주입한다.

 

---

 

2. 컴포넌트 스캔 탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정

@ComponentScan(
 	basePackages = "hello.core",
}

• basePackages: 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
• basePackages 지정은 생략하고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 방법을 권장한다. 

참고. 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 @SpringBootApplication 안에 @ComponentScan이 들어있다)

 

컴포넌트 스캔 기본 대상

• @Component : 스프링 빈을 등록하기 위해 사용하는 가장 기본적인 애노테이션이다.

다음 애노테이션들은 모두 안에 @Component가 붙어있으며, @Component + 특별한 기능을 수행한다.

• @Controlller : 스프링 MVC 컨트롤러로 인식한다.
• @Service : 특별한 처리를 하지 않지만 개발자들이 핵심 비즈니스 로직이 있는 비즈니스 계층을 인식하는데 도움이 된다.
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

 

---

 

3. 필터

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.

 

FilterType 옵션

• ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
• ASPECTJ: AspectJ 패턴을 사용한다.
• REGEX: 정규 표현식을 사용한다.
• CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리한다.

 

 

 

---

 

4. 중복 등록과 충돌

다음과 같은 상황에서 같은 빈 이름을 등록하면 어떻게 될까?

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

 

1. 자동 빈 등록 vs 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
  • ConflictingBeanDefinitionException 예외 발생

 

2. 수동 빈 등록 vs 자동 빈 등록

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

해당 경우 남는 로그

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

 

보통은 개발자가 이런 결과를 의도하기 보단 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.

따라서 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

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

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