[Spring] 필터(ComponentScan하는 Annotation만들기)

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.

예제 확인

테스트 코드에 추가

Annotation 만들기

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

package hello.core.scan.filter;
import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

 

컴포넌트 스캔 대상에서 제외할 애노테이션 (@MyExcludeComponent 만들기)

package hello.core.scan.filter;
import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

 

Annotation  적용

컴포넌트 스캔 대상에 추가할 클래스 (@MyIncludeComponent 적용)

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

 

컴포넌트 스캔 대상에서 제외할 클래스 (@MyExcludeComponent 적용)

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

 

설정 정보와 전체 테스트 코드

📌 import org.junit.jupiter.api.Assertions;

     Assertions.assertThrows( NoSuchBeanDefinitionException.class,
     () -> ac.getBean("beanB", BeanB.class));

() -> ac.getBean("beanB", BeanB.class) 를 실행했을 때, NoSuchBeanDefinitionException 에러가 뜨면 테스트 성공

➕ [참고] [스프링 부트로 개발하는 MSA 컴포넌트] 스프링 부트 테스트 (2): Junit5 사용 예제|작성자 준모캥

준모캥의 블로그 : 네이버 블로그

 

📌  @ComponentScan( 
     includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
     excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
 )

 

includeFilters : 컴포넌트 스캔 대상에 포함할 대상을 지정

MyIncludeComponent : 어노테이션이 적용된 클래스만을 스캔 대상으로 포함하도록 구성

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

MyExcludeComponent :어노테이션이 적용된 클래스는 스캔 대상에서 제외하도록 구성

 

package hello.core.scan.filter;
import org.junit.jupiter.api.Assertions;
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.assertThat;
import static org.springframework.context.annotation.ComponentScan.Filter;

public class ComponentFilterAppConfigTest {

 @Test
 void filterScan() {
     ApplicationContext ac = new
    AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
    
// includeFilters 에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
     BeanA beanA = ac.getBean("beanA", BeanA.class);
     assertThat(beanA).isNotNull();
     
 // excludeFilters 에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.
     Assertions.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 {
 }
}

 

FilterType 옵션

FilterType은 5가지 옵션이 있다.

• 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

 

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

@ComponentScan(
     includeFilters = {
         @Filter(type = FilterType.ANNOTATION, classes =
        MyIncludeComponent.class),
     },
     
     excludeFilters = { // 2개 가능
         @Filter(type = FilterType.ANNOTATION, classes =
        MyExcludeComponent.class),
        // BeanA.class 도 제외 가능
         @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class) 
     }
)

 

참고: @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데,
옵션을 변경하면서 사용하기 보다 는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.