컴포넌트 스캔

컴포넌트 스캔

• 기존에는 스프링 빈에 등록하기 위해 설정 정보가 담긴 AppConfig에 모든 메소드에
  일일이 @Bean을 등록해서 사용
• 하지만 스프링 빈으로 등록해야 할 메서드가 많아지면 등록해야 할 빈이 너무 많아지고
  설정 정보도 너무 커지는 등 문제점이 발생
• 스프링은 이러한 경우 설정 정보 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공
• 또 의존 관계를 자동으로 주입하는 @Autowired 기능도 제공

 

 

 

컴포넌트 스캔 사용법

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여줌
• 예시

@Configuration
@ComponentScan
public class AutoAppConfig {
    //@Bean으로 등록한 클래스가 없다.
}

 

• 스프링 빈으로 등록하고 싶은 클래스에 @Component를 등록
• 예시
  
  

@Component
public class MemberServiceImpl implements MemberService {

 

• 의존 관계는 @Autowired를 이용하여 자동으로 주입할 수 있다.
• 예시
  
  

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

 

 

컴포넌트 스캔 동작 과정

1. @ComponentScan

 

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록
• 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자는 소문자를 사용
  • 빈 이름 기본 전략 : ex) MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정 : 빈 이름을 직접 지정할 때는 @Component("이름")과 같은 형식으로 부여

2. @Autowried 의존관계 자동 주입

 

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
• 기본적으로 타입이 같은 빈을 찾아서 주입
• getBean(MemberRepository.class)와 동일

 

• 생성자에 파라미터가 여러 개여도 모두 찾아서 주입

 

 

탐색 위치와 기본 스캔 대상

 

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

• basePackeges = "패키지 명"과 같은 형식으로 탐색 패키지를 지정할 수 있다.
• 지정하지 않을 경우 @ComponentScan이 붙은 설정 정보 클래스의 패키지를 시작 위치로 한다.
• 최근에는 패키지 위치를 따로 지정하지 않고 설정 정보 클래스를 프로젝트 최상단에 위치시켜
  자동으로 시작 위치를 최상단으로 할 수 있게 하는 방식이 주로 사용된다.

 

 

컴포넌트 스캔 기본 대상

• @Component : 컴포넌트 스캔
• @Controller : 스프링 MVC 컨트롤러
• @Service : 스프링 비즈니스 로직
• @Repository : 스프링 데이터 접근 계층
• @Configuration : 스프링 설정 정보

 

 

필터

• 필터
  • includeFilters : 컴포넌트 스캔 대상을 추가로 지정
  • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정
• 필터 타입
  • ANNOTATION : 기본값, 애노테이션을 인식해서 동작
  • ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작
  • ASPECTJ : AspectJ 패턴 사용
  • REGEX : 정규 표현식
  • CUSTOM : TypeFilter라는 인터페이스를 구현해서 처리
• 사용 예시

@Configuration
@ComponentScan(
        includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)

 

 

중복 등록과 충돌

• 컴포넌트 스캔에서 이름이 같은 빈을 등록하면 어떻게 될까?
• 컴포넌트 중복 상황에는 다음 두 가지가 있다
  • 자동 빈 등록 vs 자동 빈 등록
  • 수동 빈 등록 vs 자동 빈 등록

 

자동 빈 등록 vs 자동 빈 등록

• 이름이 같은 빈이 자동으로 등록되는 경우 ConflictingBeanDefinitionException 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

• 수동 빈과 자동 빈의 이름이 같아 충돌이 발생하는 경우 수동 빈 등록이 우선된다.
• 수동 빈이 자동 빈을 오버라이딩한다.
• 이 경우 다음과 같은 로그가 남는다.
  
  

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

 

• 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌 나면 오류가 발생하도록
  기본 값이 변경되었다.

 

 

 

출처 : 인프런 김영한 님 스프링 강의