탐색 위치와 기본 스캔 대상

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

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

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

}

• basePackages: 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"}이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses: 지정한 클래스의 패키지를 탐색 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

권장 방법

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
• 예를 들어 프로젝트가 다음과 같이 구조가 되어 있으면,
  • com.hello
  • com.hello.service
  • com.hello.repository
• com.hello → 프로젝트 시작 루트, 여기에 AppConfig와 같은 메인 설정 정보를 두고, @ComponentScan 어노테이션을 붙이고, basePackages지정은 생략한다.
• 이렇게 하면 com.hello를 포함하는 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
  • 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트에 두는 것이 좋다 생각한다.
  • 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.
    • 그리고 이 설정 안에 @ComponentScan이 들어있다.
    • 그래서 root 패키지부터 모든 클래스를 spring bean에 등록된다.
    • == Springboot를 사용하면 Config를 따로 설정하지 않아도 됨!

컴포넌트 스캔 기본 대상

• 컴포넌트 스캔은 @Component뿐만 아니라 다음 내용도 추가로 대상에 포함된다.
  • @Component: 컴포넌트 스캔에서 사용
  • @Controller: 스프링 MVC 컨트롤러에서 사용
  • @Service: 스프링 비즈니스 로직에서 사용
  • @Repository: 스프링 데이터 접근 계층에서 사용
  • @Configuration: 스프링 설정 정보에서 사용
• 해당 클래스의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있다.

사실 어노테이션에는 상속관계가 없음. 그래서 이렇게 어노테이션이 특정 어노테이션을 들고 있는 것을 인식할 수 있는 것은 자바가 지원하는 기능이 아닌 스프링이 지원하는 기능이다.

• 컴포넌트 스캔의용도 뿐만 아니라, 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.
  • @Controller: 스프링 MVC 컨트롤러로 인식
  • @Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리한다.
  • @Service: 사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 ‘핵심 비즈니스 로직이 여기에 있겠구나’ 라고 비즈니스 계층을 인식하는데 도움이 된다.

useDefaultFilters옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 대상들이 제외된다.

필터

종류

• includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.

ComponentFilterAppConfigTest

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

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

FilterType 옵션

FilterType은 5가지의 옵션이 있다.

• ANNOTATION: 기본값, 어노테이션을 인식해서 동작한다.
  • ex) org.example.SomeAnnotation
• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ex) org.example.SomeClass
• ASPECTJ: AspectJ 패턴 사용
  • ex) org.example.*service+
• REGEX: 정규표현식
  • ex) org\.example\.Default.*
• CUSTOM: TypeFilter라는 인터페이스를 구현해서 처리
  • ex) org.example.MyTypeFilter

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

특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 옵션을 변경하면서 사용하기 보단 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편.

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

다음 두가지 상황이 있다.

1. 자동 빈 등록 vs 자동 빈 등록
2. 수동 빈 등록 vs 자동 빈 등록

자동 빈 등록 vs 자동 빈 등록

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
  • ConflictingBeanDefinitionException 예외 발생

수동 빈 등록 vs 자동 빈 등록

AutoAppConfig

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

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

• 이 경우 수동 빈 등록이 우선권을 가진다.
  • 수동 빈이 자동 빈을 오버라이딩 해버린다.

수동빈 등록시 남는 로그

14:23:54.181 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing [Generic bean: class [hello.core.member.repository.MemoryMemberRepository]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in file [E:\workspace\Study\Spring-core\out\production\classes\hello\core\member\repository\MemoryMemberRepository.class]] with [Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=autoAppConfig; factoryMethodName=memberRepository; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.config.AutoAppConfig]

• 물론 개발자가 의도적으로 이런 결과를 기대했다면 자동보다는 수동이 우선권을 가지는 것이 좋다.
• 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.
• 그렇게 되면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.
• 그래서 최근 스프링부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

수동 빈 등록, 자동 빈 등록 오류 시 스프링 부트 에러

The bean 'memoryMemberRepository', defined in class path resource [hello/core/config/AutoAppConfig.class], could not be registered. A bean with that name has already been defined in file [E:\workspace\Study\Spring-core\out\production\classes\hello\core\member\repository\MemoryMemberRepository.class] and overriding is disabled.

• 스프링 부트로 실행하면 오류를 확인할 수 있다.

개발 혼자하는 것 아니다… 애매한 상황 자체를 만들지 않는 것이 좋음.