스프링 핵심원리 : 기본편 - 필터, 중복 등록과 충돌

"인프런의 스프링 핵심원리 - 기본편 강의를 듣고 작성한 글 입니다."

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

필터

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

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

 

예제로 확인해보자.

test 폴더 아래 hello.core.scan.filter 패키지에 다음과 같이 MyIncludeComponent, MyExcludeComponent 어노테이션을 만들고 코드를 작성해보자.

- MyIncludeComponent.java -> 컴포넌트 스캔 대상에 추가할 어노테이션

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

- MyExcludeComponent.java -> 컴포넌트 스캔 대상에서 제외할 어노테이션

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

 

다음으로 컴포넌트 스캔 대상에 추가할 클래스와 제외할 클래스를 만든다.

- BeanA.java -> 컴포넌트 스캔 대상에 추가할 클래스

@MyIncludeComponent
public class BeanA {
}

- @MyIncludeComponent 적용

 

- BeanB.java -> 컴포넌트 스캔 대상에서 제외할 클래스

@MyExcludeComponent
public class BeanB {
}

- @MyExcludeComponent 적용

 

이제 컴포넌트 스캔 추가 및 제외 여부를 확인하기 위한 테스트 코드를 작성해보자.

- ComponentFilterAppConfigTest.java

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 = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        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{
    }
}

위와 같이 코드를 작성하고 filterScan 메소드를 실행하면 정상적으로 테스트를 통과하는 것을 확인할 수 있다.

 

위에서 내부 설정 클래스인 ComponentFilterAppConfig 클래스에 작성한 @ComponentScan 어노테이션에 대해 알아보자.

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

- includeFilters 에 MyIncludeComponent 어노테이션을 추가해서, 해당 어노테이션이 붙어있는 클래스는 컴포넌트 스캔에 포함되기 때문에 BeanA 가 스프링 빈에 등록된다.

- excludeFilters 에 MyExcludeComponent 어노테이션을 추가해서, 해당 어노테이션이 붙어있는 클래스는 컴포넌트 스캔에 포함되지 않기 때문에 BeanB 는 스프링 빈에 등록되지 않는다.

 

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

 

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

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

 

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

다음 두 가지 상황이 있다.

1. 자동 빈 등록 vs 자동 빈 등록

2. 수동 빈 등록 vs 자동 빈 등록

 

* 자동 빈 등록 vs 자동 빈 등록

- 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록 되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.

- ConflictingBeanDefinitionException 예외 발생

 

* 수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?

AutoAppConfig 에 MemoryMemberRepository 빈 과 똑같은 이름으로 스프링 빈 객체를 하나 더 등록해보자.

- AutoAppConfig.java

@Configuration
@ComponentScan(
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class),
        basePackages = "hello.core"
)
public class AutoAppConfig {

    @Bean(name = "memoryMemberRepository")
    public MemberRepository memberRepository(){
        return new MemoryMemberRepository();
    }
}

위와 같이 코드를 작성한 후 AutoAppConfigTest 클래스로 가서 테스트를 수행해보자.

- 이 경우 수동 빈 등록이 우선권을 가진다.(수동 빈이 자동 빈을 오버라이딩 해버린다.)

아래는 수동 빈 등록 시 남는 로그이다.

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

 

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.

그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

 

* 수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

CoreApplication 을 실행시켜 보면 아래와 같은 에러가 발생하는 것을 확인할 수 있다.

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

물론 여기서 spring.main.allow-bean-definition-overriding=true 이 옵션을 properties 파일에 설정해주면 스프링 빈 객체의 오버라이딩을 수행할 수 있다.