[스프링 핵심 원리] 05. 컴포넌트 스캔

1. @ComponentScan, @Component

@Configuration
@ComponentScan()
public class AutoAppConfig {

}

@Component
public class MemoryMemberRepository implements MemberRepository {}

- 스프링은 Bean 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공한다.

- 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.

- 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다. (직접 지정도 가능)

 

2. @Autowired

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    @Autowired //ac.getBean(MemberRepository.class)
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

- 기존의 AppConfig에서는 의존관계를 직접 명시하였으나 Component를 쓸 때는 @Autowired가 의존관계를 자동으로 주입해준다.

- 타입이 같은 빈을 찾아서 주입한다.

- 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

 

3. 탐색 위치와 기본 스캔 대상

@Configuration
@ComponentScan(
        basePackages = "hello.core",
        basePackageClasses = AutoAppConfig.class
)
public class AutoAppConfig {

}

- basePackages: 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

- basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

- 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다. (권장)

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

 

ComponentScan은 다음과 같은 애노테이션도 추가로 대상에 포함한다. (@Component 포함 + 부가 기능 수행)

- @Controller: 스프링 MVC 컨트롤러에서 사용

- @Service: 스프링 비지니스 로직에서 사용

- @Repository: 스프링 데이터 접근 계층에서 사용

- @Configuration: 스프링 설정 정보에서 사용

- 사실 애노테이션에는 상속관계라는 것이 없다.

> 애노테이션이 특정 애노테이션을 들고 있는 것을 인식하는 것은 스프링이 지원하는 기능이다.

 

4. 필터

@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 = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {

    }
}

- includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.

- excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.

- 보통 @Component면 충분하기 때문에, includeFilters를 사용할 일은 거의 없다.

- excludeFilters는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.

 

FilterType 옵션

- ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.

- ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.

- ASPECTJ: AspectJ 패턴 사용

- REGEX: 정규 표현식

- CUSTOM: TypeFilter이라는 인터페이스를 구현해서 처리

 

5. 중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록 (컴포넌트 스캔에 의해 자동으로 등록되는 스프링 빈의 이름이 같은 경우)

> ConflictingDefinitionException 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Configuration
@ComponentScan()
public class AutoAppConfig {

    @Bean(name = "memoryMemberRepository")
    public MemoryMemberRepository memoryMemberRepository() {
        return new MemoryMemberRepository();
    }
}

- 이 경우 수동 빈 등록이 우선권을 가진다.

- 수동 빈이 자동 빈을 오버라이딩 해버린다.

- 대부분 여러 설정들이 꼬여서 발생하는 경우이기에 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

- spring.main.allow-bean-definition-overriding=true로 충돌을 허용할 수도 있다.