컴포넌트 스캔
컴포넌트 스캔과 의존관계 자동 주입
스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.
컴포넌트 스캔을 통해 @Component이 붙은 클래스를 빈을 등록하면 의존관계를 주입할 방법이 없어진다.
의존관계를 명시한 설정정보가 없기 때문에 의존관계 주입도 해당 클래스 안에서 해결해야 한다.
이때, 생성자에 @Autowired를 쓰면 스프링 컨테이너에서 매개변수 타입의 빈을 찾아 주입해준다.
Q.같은 타입의 빈이 여러 개라면(상속 관계 포함) 어떤 빈이 주입될까?
@ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
빈 이름 기본 전략: MemberServiceImpl 클래스 -> memberServiceImpl
빈 이름 직접 지정: @Component("memberService2")
참고: @Configuration 도 내부에 @Component 를 포함하기 때문에 컴포넌트 스캔의 대상이 된다.
탐색 위치와 기본 스캔 대상
탐색할 패키지의 시작 위치 지정
@ComponentScan( basePackage: 탐색할 패키지의 시작 위치 지정 )
basePackages = {"hello.core", "hello.service"} 다수의 위치 지정 가능
만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스( @ComponentScan )의 위치를 프로젝트 최상단에 두는 것이다.
- 최근 스프링 부트도 이 방법을 기본으로 제공한다.
- 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.
- 불필요한 패키지나 클래스는 excludeFilters을 통해 배제하면 된다.
참고: 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 프로젝트 시작 루트 위치에 두는 것이 관례이다. (이 설정안에 @ComponentScan 이 포함되기 때문)
컴포넌트 스캔 기본 대상
- @Component : 컴포넌트 스캔에서 사용
- @Controlller : 스프링 MVC 컨트롤러에서 사용
- @Service : 스프링 비즈니스 로직에서 사용
- @Repository : 스프링 데이터 접근 계층에서 사용 (스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환)
- @Configuration : 스프링 설정 정보에서 사용 (스프링 빈이 싱글톤을 유지하도록 추가 처리)
참고: 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
필터
- includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
@Configuration
@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
static class ComponentFilterAppConfig {}
MyIncludeComponent 애노테이션이 붙은 클래스는 컴포넌트 스캔 포함
MyExcludeComponent 애노테이션이 붙은 클래스는 컴포넌트 스캔 제외
FilterType 옵션
- 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 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고 선호하는 편이다.
중복 등록과 충돌
자동 빈 등록 vs 자동 빈 등록
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
ConflictingBeanDefinitionException 예외 발생
수동 빈 등록 vs 자동 빈 등록
스프링에서는 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩)
그러나 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.
수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러
Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true
