컴포넌트 스캔 - @ComponentScan

컴포넌트 스캔이란?

스프링이 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 기능.
(의존관계도 자동으로 주입하는 @Autowired 기능도 제공)

• 지금까지 스프링 빈을 등록할 때는 자바코드의 @Bean 이나 XML 의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다. 
• 만약 등록해야 할 스프링 빈이 수십, 수백 개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다. 
• 그래서 스프링은 컴포넌트 스캔 기능을 제공한다!

 

컴포넌트 스캔 적용방법 (+ 의존관계 자동 주입)

• 컴포넌트 스캔 대상으로 적용할 각 클래스에 @Component 애너테이션을 붙여준다.
• 의존관계 주입이 필요할 경우 해당 생성자에 @Autowired 도 추가해준다. 

 

ComponentScan 

• @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이 때, 스프링 빈의 기본 이름 :  클래스명을 사용하되, 맨 앞글자만 소문자 사용
  • 빈 이름 기본 정략 : MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정 : @Component("지정이름")

 

Autowired

• 생성자에 @Autowired 를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 기본 조회 전략 : 타입이 같은 빈을 찾아서 주입
  • getBean(MemberRepository.class) 과 동일하다고 이해하면 된다. 

 

탐색 위치

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

// 설정 파일 (AutoAppConfig.java)

@ComponaentScan(
	basePackages = "hello.core"
)
public class AutoAppConfig {

}

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"}
  • 이런 식으로 여러 시작 위치를 동시에 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
  • EX) basePackageClasses = AutoAppConfig.class
    => AutoAppConfig 클래스의 패키지가 탐색 시작 위치
• 만약 지정하지 않으면 : @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다. 
• 권장하는 방법
  • 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것
  • 최근 스프링 부트도 이 방법을 기본으로 제공한다.

 

컴포넌트 스캔 기본 대상

다음의 애너테이션들에는 @Component 가 포함되어 있어서 기본적으로 컴포넌트스캔의 대상이 된다. 

• @Controller
• @Service
• @Repository
• @Configuration

 

필터

• 설정 클래스 및 필터 대상 애너테이션들

/**
 * ComponentFilterAppConfig.java (설정 클래스)
 */

// MyIncludeComponent 라는 애노테이션은 포함, MyExludeComponent 라는 애노테이션은 제외
@Configuration
@ComponentScan(
        includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
static class ComponentFilterAppConfig {

}


/**
 * 필터의 포함 및 제외 대상이 된 애너테이션
 */

// MyIncludeComponent 애너테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
    // 이 어노테이션이 붙은 것은 컴포넌트 스캔에 추가할 것임.
}

// MyExcludeComponent 애너테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
    // 이 어노테이션이 붙은 것은 컴포넌트 스캔에서 제외할 것임.
}

• 애너테이션을 클래스에 적용 후 테스트

// BeanA 라는 클래스에 @MyIncludeComponent 적용
@MyIncludeComponent
public class BeanA {
}

// BeanB 라는 클래스에 @MyExcludeComponent 적용
@MyExcludeComponent
public class BeanB {
}


// 테스트
@Test
void filterScan() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
    BeanA beanA = ac.getBean("beanA", BeanA.class);// MyIncludeComponent 애노테이션이 붙은 클래스
    assertThat(beanA).isNotNull(); // 스캔 대상이므로 Null 이면 안 된다. (Bean 객체로 등록되어 있어야 한다.)

    // BeanB 는 스캔 제외 대상이므로 Bean 객체로 등록되지 않았을 것이다. BeanB 조회 시 예외가 발생해야 함.
    assertThrows(NoSuchBeanDefinitionException.class,
            () -> ac.getBean("beanB", BeanB.class));
}

• FilterType 옵션
  • (사실 사용되는 일이 많지는 않다고 한다.) 
  • ANNOTATION : 기본값, 애너테이션을 인식하여 동작
  • ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식하여 동작
  • ASPECTJ : AspectJ 패턴 사용
    Ex) org.example..*Service+
  • REGEX : 정규 표현식
    Ex) org\.example\.Default.*
  • CUSTOM : TypeFilter 라는 인터페이스를 구현하여 처리
    Ex) org.example.MyTypeFilter