컴포넌트 스캔

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

컴포넌트 스캔 등장 배경

@Bean 어노테이션을 사용하거나 XML 의 태그 등을 통해 설정 정보에 직접 등록할 스프링 빈을 나열했지만, 등록할 빈이 수백가지가 되면 번거롭다.

@Component Scan

@Component 어노테이션이 붙은 빈을 모조리 찾아내고 스프링 빈으로 등록한다.

@Configuration 은 애초에 @Component 를 포함하기 때문에 충돌 방지를 위해 filter 를 사용.

@Configuration   // 필터 타입은 annotation 으로 지정
@ComponentScan(excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class))
public class AutoAppConfig {
}

기존의 AppConfig 와 달리 @Bean 으로 등록한 컴포넌트가 하나도 없다.

그러므로 AppConfig 에 사용할 객체를 일일이 빈 등록하지 않고, 그저 @Component 만 붙여주면 된다. (훨씬 간편하다!)

의존관계 자동 주입

Q. 그렇다면 AppConfig 에서 수동으로 설정한 의존관계 주입은 어떻게 하나?

A. @Autowired 어노테이션을 사용한다.

이전 AppConfig 파일에서는 의존관계 주입을 수동으로 (코드로) 작성하였지만, AutoAppConfig 파일에서는 의존관계 주입이 자동으로 이뤄진다. 어떻게? 바로 @Autowired 를 사용하여.

컴포넌트 스캔으로 인해 스프링 빈으로 등록된 클래스는, 자신의 생성자에 @Autowired 를 지정한다. 그러면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. 이 때 기본 조회 전략은 타입이 같은 빈을 찾아 먼저 주입힌다.

생성자의 @Autowired 어노테이션을 보고, 스프링 컨테이너는 자동으로 해당 스프링 빈을 찾아 의존성을 주입해준다.

스캔시작 위치 설정

basePackages 를 탐색할 패키지의 시작 위치로 설정한다.

해당 패키지를 포함하여 하위 패키지를 모두 탐색한다 .

관례

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

컴포넌트 스캔의 기본 대상

@Component : 컴포넌트 스캔에서 사용

@Controller, @Service, @Repository @Configuration: 모두 내부에 @Component 가 붙어있다.

스프링부트에서는

@SpringBootApplication 내부에 @Component 가 붙어있어 컴포넌트 스캔의 대상이 된다. 때문에 따로 어노테이션을 붙일 필요가 없다.

 

@Component 와 @Bean 어노테이션의 차이를 이해해야한다.

1. @Bean 의 경우 개발자가 컨트롤 불가능한 외부 라이브러리를 Bean 으로 등록하고 싶은 경우에 사용된다.
2. 반대로 개발자가 직접 컨트로 가능한 클래스의 경우엔 @Compnent 를 사용한다.
3. @Bean 은 setter, builder 등을 통해 사용자가 프로퍼티를 변경해서 생성한 인스턴스를 스프링에게 관리하라고 맡기는 것
4. @Component 는 클래스를 스프링 보고 알아서 인스턴스 생성한 후에 등록하라고 맡기는 것 차이가 있따.

2. 필터

includeFilter : 스캔의 대상을 명확히 하기 위해 사용

excludeFilter : 컴포넌트 스캔에서 제외할 대상을 지정

애노테이션 작성

@Target(ElementType.TYPE): TYPE → Class 레벨에 붙는 애노테이션

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        Assertions.assertThat(beanA).isNotNull();

        assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class)
        );
    }

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

}

3. 중복 등록과 충돌

동명의 빈이 존재할 때

1. 자동 빈 등록 vs 자동 빈 등록
   1. ConflictBeanDefinitionException 예외 발생
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

스프링에서는 수동으로 등록한 빈이 우선권을 가지며 오버라이드를 하지만, 스프링 부트에서는 오버라이드 설정을 false 로 뒀기 때문에 오버라이딩 되지 않고 에러가 발생한다. => 즉 동명의 빈을 사용하지 못하게 사전에 막는다.