[Spring] 스프링 핵심 원리 (기본) - 5. 컴포넌트 스캔

5. 컴포넌트 스캔

5.1 개념

지금(이전)까지 스프링 빈을 등록할 떄는 자바 코드에 @Bean을 통해 설정 정보에 직접 등록할 빈을 나열했다. 하지만, 등록해야될 빈의 수가 많아질수록 단순 반복, 설정 정보 증가, 누락 등 문제가 발생할 수 있다. 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공한다. 더불어, 의존 관계를 자동으로 주입하는 @Autowired 기능도 제공한다.

• 컴포넌트 스캔을 사용하려면, @ComponentScan을 설정 정보에 붙여주면 된다. (기존 AppConfig와 달리 @Bean으로 등록한 클래스가 하나도 없음)
• 컴포넌트 스캔은 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. 따라서, 각 클래스가 스캔의 대상이 되도록 @Component 어노테이션을 붙여줘야 한다.
• 스프링 빈과의 의존 관계 주입은 각 클래스 안에서 해결해야 한다. 이때 @Autowired를 사용한다.

@Configuration
@ComponentScan(
//        basePackages = {"hello.core"},
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

참고:
컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어 둔 설정 정보도 함께 등록되고 실행된다. 그래서, excludeFilters를 사용해서 설정 정보는 컴포넌트 스캔 대상에서 제외한다. 보통은 설정 정보를 컴포넌트 스캔 대상에서 제외하진 않는다.

(여기에서는 예제 코드는 최대한 남기기 위해 이렇게...)

@ComponentScan

• @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 스프링 빈의 기본 이름은 클래스명을 사용하되, 맨 앞 글자만 소문자를 사용한다.
  

@Autowired

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

5.2 탐색 위치

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 많이 소모된다. 그래서 꼭 필요한 위치부터 탐색하도록 시작위치를 지정할 수 있다.

@ComponentScan(
    basePackages = {"hello.core"}
)

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

권장방법.
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 추천한다. 스프링 부트를 사용하면, 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위치에 두는 것이 관례임

5.3 컴포넌트 스캔의 기본 대상

컴포턴트 스캔은 @Component뿐만 아니라 여러 대상을 추가로 포함한다.

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

참고.
사실 어노테이션에는 상속 관계가 없다. 그래서 어노테이션이 특정 어노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하진 않고, 스프링이 지원한다.

5.4 필터

// 1. 컴포넌트 스캔 대상에 추가할 어노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

// 2. 컴포넌트 스캔 대상에서 제외할 어노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

// 3. 컴포넌트 스캔 대상에 추가할 클래스
@MyIncludeComponent
public class BeanA {}

// 4. 컴포넌트 스캔 대상에서 제외할 클래스
@MyExcludeComponent
public class BeanB {}

// 5. 설정 정보와 전체 테스트 코드
public class ComponentFilterAppConfigTest {
    @Test
    void filterScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        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 {
    }
}

• includeFilter에 MyIncludeComponent 어노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilter에 MyExcludeComponent 어노테이션을 추가해서 BeanB가 스프링 빈에 등록되지 않는다.

5.5 중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 이름이 같은 경우 스프링 오류가 발생한다.

수동 빈 등록 vs 자동 빈등록

• 수동 빈이 자동 빈을 오버라이딩 하기 때문에, 수동 빈 등록이 우선권을 가진다.

강조.
항상 잡기 어려운 버그는 애매모호한 버그이다!