[스프링 핵심 원리] 06. 컴포넌트 스캔 - 탐색 위치와 기본 스캔 대상 & 필터

(인프런) 김영한님의 스프링 핵심 원리-기본편을 공부하고 리뷰한 글입니다.

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

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

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

1) basePackages: 탐색할 패키지의 시작 위치 지정(해당 패키지 + 하위 패키지)

- 시작 위치를 여러개로 지정할 수 있음 (e.g basePackages = {"hello.core", "hello.service"} )

package hello.core;

@Configuration
@ComponentScan	// 탐색 시작 위치 = hello.core
public class AutoAppConfig {
	basePackages = "hello.core"
}

2) basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정

package hello.core;

@Configuration
@ComponentScan	// 탐색 시작 위치 = hello.core(AutoAppConfig의 패키지)
public class AutoAppConfig {
	basePackageClasses = "AutoAppConfig.class"
}

3) 시작 위치 지정하지 않는 경우, @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작위치로 지정(중요!)

package hello.core;

@Configuration
@ComponentScan	// 탐색 시작 위치 = hello.core
public class AutoAppConfig {
}

 

2. 권장하는 방법

탐색할 패키지의 시작 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. (최근 스프링 부트도 이 방법을 기본으로 제공한다.)

 

예를 들어, 프로젝트 구조가 다음과 같다면

프로젝트 최상단(시작 루트) = com.hello

com.hello에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 을 붙이고, basePackages 지정은 생략한다. 이렇게 하면 com.hello를 포함한 하위 패키지는 모두 컴포넌트 스캔의 대상이 된다.

프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이므로 시작 루트 위치에 두는 것이 좋다.

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

 

3. 컴포넌트 스캔 기본 대상

- @Component: 컴포넌트 스캔에서 사용

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

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

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

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

컴포넌트 스캔은 @Component가 붙은 클래스를 대상으로 하지만 나머지 애노테이션 내부에 @Component가 붙어있어 추가로 대상에 포함된다.

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

 

<애노테이션의 컴포넌트 스캔 외 부가 기능>

- @Controller : 스프링 MVC 컨트롤러로 인식

- @Repository : 스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환

- @Configuration : 스프링 설정 정보로 인식, 스프링 빈이 싱글톤을 유지하도록 추가 처리

- @Service : 특별한 처리 X, 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움

3. 필터

1) includeFilters: 컴포넌트 스캔 대상을 추가로 지정

2) excludeFilters: 컴포넌트 스캔에서 제외할 대상 지정

 

1. 컴포넌트 스캔 대상에 추가할 애노테이션 (@MyIncludeComponent)

package hello.core.scan.filter;

import java.lang.annotation.*;

// @MyIncludeComponent가 붙은 클래스는 컴포넌트 스캔에 추가
@Target(ElementType.TYPE)   // 클래스 레벨에 붙음
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

 

2. 컴포넌트 스캔 대사엥 제외할 애노테이션 (@MyExcludeComponent)

package hello.core.scan.filter;

import java.lang.annotation.*;

// @MyExcludeComponent가 붙은 클래스는 컴포넌트 스캔에서 제외
@Target(ElementType.TYPE)   // 클래스 레벨에 붙음
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

 

3. 컴포넌트 스캔 대상에 추가할 클래스 (BeanA)

package hello.core.scan.filter;

// 컴포넌트 스캔에 추가
@MyIncludeComponent
public class BeanA {
}

 

4. 컴포넌트 스캔 대상에 제외할 클래스 (BeanB)

package hello.core.scan.filter;

// 컴포넌트 스캔에서 제외
@MyExcludeComponent
public class BeanB {
}

 

5. 설정 정보와 전체 테스트 코드 (ComponentFilterAppConfigTest)

package hello.core.scan.filter;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

        // beanA 빈 조회 성공해야 함
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();
        
        // beanB 빈 조회 실패해야 함
        //BeanB beanB = ac.getBean("beanB", BeanB.class);
        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는 스프링 빈에 등록되지 않는다.

 

6. FilterType 옵션

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

e.g) org.example.SomeAnnotation

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

e.g) org.example.SomeClass

3) ASPECTJ: AspectJ 패턴 사용

e.g) org.example..*Service+

4) REGEX: 정규 표현식

e.g) org\.example\.Default.*

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

e.g) org.example.MyTypeFilter

 

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

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