Section 6-3. 필터

모든 코드는 테스트 코드에 추가

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

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

 

• 컴포넌트 스캔 대상에 추가할 애노테이션

• 컴포넌트 스캔 대상에서 제외할 애노테이션

클래스 타입에 붙는 애노테이션이라는 의미로,

@MyIncludeComponent가 붙으면 컴포넌트 스캔에 추가,

@MyExcludeComponent가 붙으면 컴포넌트 스캔에서 제외하도록 만들고자 한다.

---

컴포넌트 대상으로 추가 및 제외할 클래스 생성

• 컴포넌트 대상으로 추가할 BeanA

@MyIncludeComponent 적용

• 컴포넌트 대상에서 제외할 BeanB

@MyExcludeComponent 적용

---

Config설정 클래스에서 Filter를 만들어 Test하기

includeFilters를 사용하여 Filter타입은 ANNOTATION으로 하여, MyIncludeComponent 애노테이션이 붙은 클래스들은 컴포넌트 대상에 추가하도록 설정한다.

excludeFilters를 사용하여 Filter타입은 ANNOTATION으로 하여, MyExcludeComponent 애노테이션이 붙은 클래스들은 컴포넌트 대상에서 제외하도록 설정한다.

 

테스트 코드를 실행시키면, 컴포넌트 스캔 대상인 beanA를 조회하고 이는 MyIncludeComponent 애노테이션이 붙어있기에 빈으로 등록된다. 따라서 Null이 아니므로 테스트가 문제없이 성공할 것이다.

 

우리가 제외시킨 beanB를 조회하면 어떻게 될까?

beanB라는 이름을 가진 빈은 없다는 NoSuchBeanDefinitionException이 발생한다.

 

테스트를 성공시키기 위해 assertThrows를 통해 예외처리 하여 테스트를 진행해보면

테스트 성공

---

FilterType 옵션

1. ANNOTATION : 기본값, 애노테이션을 인식해서 동작

• ex) org.example.SomeAnnotation

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

• ex) org.example.SomeClass

3. ASPECTJ : AspectJ 패턴 사용

• ex) org.example..*Service+

4. REGEX : 정규 표현식

• ex) org\.example\.Default.*

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

• ex) org.example.MyTypeFilter

 

예를 들어서 BeanA도 제외하고 싶으면 다음과 같이 추가하면 된다.

ASSIGNABLE_TYPE을 사용하여 직접 클래스를 지정한다.

 

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

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