- 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열 - 스프링에서는 설정 정보 없이도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔(@ComponentScan) 이라는 기능을 제공 - 또한 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공 - 컨포넌트 스캔을 사용한 설정 정보 - 컨포넌트 스캔을 사용하려면 설정 정보에 @ComponentScan 어노테이션을 붙여준다. - 컨포넌트 스캔은 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
[참고] - 컨포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 스프링 빈으로 등록하기 때문에, 앞선 예제에서 사용한 AppConfig, TestConfig 설정 파일에 나열한 클래스들이 스프링 빈으로 등록되지 않도록 사전에 filter 처리를 통해 스캔 대상에서 제외 - 보통 실무에서는 컴포넌트 스캔 대상을 제외하지 않는다. - Configuration 인터페이스를 들어가보면 @Component 어노테이션이 붙어있는 것을 확인할 수 있다. 즉 @Configuration 어노테이션이 붙은 클래스도 스프링 빈 등록 대상이 된다는 의미이다. 1) @ComponentScan - @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록 - 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞 글자는 소문자를 사용 - 빈 이름 직접 지정도 가능 -> @Component("빈 이름") 2) @Autowired 의존관계 자동 주입 - 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
■ 탐색 위치와 기본 스캔 대상
1) 탐색할 패키지의 시작 위치 지정 - 필요한 위치부터 컴포넌트를 스캔할 수 있도록 위치를 지정할 수 있다. - backPackages를 사용 : 탐색할 패키지의 시작 위치를 지정, 이 패키지를 포함해서 하위 패키지를 모두 탐색 - basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정, 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
[권장하는 방법] - 설정 정보 클래스의 위치를 프로젝트 최상단에 둠으로써, 설정 정보 클래스가 위치한 곳에서부터 컴포넌트를 스캔하도록 한다. - 스프링 부트도 이 방법을 기본으로 제공
- 예를 들어, 프로젝트가 다음과 같은 구조로 되어 있다면 com.hello com.hello.service com.hello.repository - com.hello가 프로젝트의 시작 루트로써 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan을 붙이고 basePachages는 생략 - 이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. - 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.
[참고] - 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. - 그리고 이 설정 안에 @ComponentScan이 들어있다.
■ 컨포넌트 스캔의 기본 대상
- @Component : 컴포넌트 스캔에서 사용 - @Controller : 스프링 MVC 컨트롤러에서 사용 - @Service : 스프링 비즈니스 로직에서 사용, 개발자들이 비즈니스 계층을 인식하는데 도움 - @Repository : 스프링 데이터 접근 계층에서 사용, 데이터 계층의 예외를 스프링 예외로 변환 - @Configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 해준다.
- 위의 해당 클래스의 소스 코드를 보면 모두 @Component를 포함하고 있는 것을 확인할 수 있다. - 즉 ComponentScan의 스캔 대상이 된다.
[참고] @Repository 어노테이션은 다양한 형태의 RDB를 사용하면서 발생할 수 있는 예외를 스프링 예외로 추상화하여 변환해줌으로써, 서비스 단에서 코드가 변경될 수 있음을 방지해준다.
[중복 등록과 충돌] 컴포넌트 스캔에서 같은 빈 이름으로 등록하면 어떻게 될까? 다음 두 가지 사황이 있다.
최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.
1) 자동 빈 등록 vs 자동 빈 등록 - 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생 - ConflictingBeanDefinitionException 예외 발생
2) 수동 빈 등록 vs 자동 빈 등록 - 이 경우 수동 빈 등록이 우선권을 가지게 된다.(수동 빈이 자동 빈을 오버라이딩) - 선호하지 않는다.
■ 필터
1) includeFilter - 컴포넌트 스캔 대상을 추가로 지정, 스프링 빈으로 생성
1) excludeFilter - 컴포넌트 스캔에서 제외할 대상을 지정, 스프링 빈으로 생성하지 X
■ 필터를 적용한 @ComponentScan Test
- MyIncludeComponent annotation : 컴포넌트 스캔 대상에 추가할 어노테이션 - MyExcludeComponent annotation : 컴포넌트 스캔 대상에서 제외할 어노테이션 - BeanA class : 컴포넌트 스캔 대상 클래스, 스프링 빈으로 생성 - BeanB class : 컴포넌트 스캔 대상에서 제외할 클래스, 스프링 빈으로 생성 X - ComponentFilterAppConfigTest class : 설정 정보와 전체 테스트 클래스
- includeFilters에 MyIncludeComponent 어노테이션을 추가해서 BeanA 클래스가 스프링 빈으로 등록 - excludeFilters에 MyExcludeComponent 어노테이션을 추가해서 BeanB 클래스가 스프링 빈으로 등록 X
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}
@MyIncludeComponent
public class BeanA {
void printBeanA(){
System.out.println("call BeanA.pritBeanA");
}
}
@MyExcludeComponent
public class BeanB {
void printBeanB(){
System.out.println("call BeanB.printBeanB");
}
}
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.*;
public class ComponentFilterAppConfigTest {
@Test
void filterScan() {
ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentAppConfig.class);
BeanA beanA = ac.getBean(BeanA.class);
//BeanA 클래스는 스프링 빈에 등록
Assertions.assertThat(beanA).isInstanceOf(BeanA.class);
//BeanB 클래스는 스프링 빈으로 등록 X
org.junit.jupiter.api.Assertions.assertThrows(
NoSuchBeanDefinitionException.class,
() -> ac.getBean(BeanB.class)
);
}
@Configuration
@ComponentScan(
includeFilters = @ComponentScan.Filter(
type = FilterType.ANNOTATION,
classes = MyIncludeComponent.class
),
excludeFilters = @ComponentScan.Filter(
type = FilterType.ANNOTATION,
classes = MyExcludeComponent.class
)
)
static class ComponentAppConfig {
}
}
