컴포넌트 스캔

해당 포스팅은 김영한님의 인프런 강의(스프링 핵심 원리 - 기본편)를 듣고 정리한 내용입니다.

@ComponentScan

컴포넌트 스캔을 사용하지 않고 스프링 빈을 등록할 때 아래와 같이 @Bean(또는 XML의 <bean>)을 통해서 설정 정보를 직접 등록할 스프링 빈을 나열해야했다.

// 컴포넌트 스캔을 사용하지 않고 빈을 등록하는 Configuration
@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
	
    ...
    
}

 

스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능과 의존관계를 자동으로 주입하는 기능을 제공한다. 아래와 같이 @ComponentScan 어노테이션을 사용하면 빈 등록을 직접하지 않아도, @Component 어노테이션이 붙은 클래스들을 찾아 빈으로 등록해준다.

이때 빈들 간의 의존 관계를 명시해야 하는데 생성자 또는 의존성 주입이 필요한 필드에 @Autowired 어노테이션을 붙이게되면 자동으로 주입이 이루어진다.

// AutoAppConfig.java
@Configuration
@ComponentScan
public class AutoAppConfig {
}

// MemberServiceImpl.java
@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

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

}

@ComponentScan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
• 만약 직접 이름을 지정하고 싶다면 @Component("customBeanName")처럼 이름을 부여할 수 있다.

@Autowired

• 생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

---

탐색 위치와 기본 스캔 대상

탐색 위치

탐색 시작 위치를 다음과 같이 지정할 수 있다.

@ComponentScan(
        basePackages = {"hello.core", "hello.service"},
        basePackageClasses = CoreApplication.class
)

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

권장하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위치에 두는 것이 관례이고, 이 @SpringBootApplication 설정 안에 @ComponentScan이 들어있다.

컴포넌트 스캔 기본 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용 (해당 어노테이션이 붙은 클래스를 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다)
• @Configuration : 스프링 설정 정보에서 사용

---

필터

필터를 통해 컴포넌트 스캔 대상을 추가로 지정하거나 제외할 수 있다.

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

FilterType 옵션

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

참고로 @Component면 충분하기 때문에 includeFilters를 사용할 일은 거의 없다. excludeFilters는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.

---

중복 등록과 충돌

• 자동 빈 등록 vs 자동 빈 등록
  • 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 ConflictingBeanDefinitionException을 발생시킨다.
• 자동 빈 등록 vs 수동 빈 등록
  • 수동 빈 등록이 우선권을 가진다. 
  • 하지만 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.