7/6 스프링 핵심 원리 - 컴포넌트 스캔

컴포넌트 스캔과 의존관계 자동주입하기

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.

 

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다

 

@Component 애노태이션이 붙은 클래스를 찾아서 자동으로 스프링 빈으로 등록해준다

 

@Configuration 애노테이션 가면 @Component가 붙어있다

 

Find in files : ctrl + shift + F

 

코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자. 

먼저 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고,

새로운 AutoAppConfig.java를 만들자.

 

AutoAppConfig.java

 

package hello.core;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import org.springframework.context.annotation.FilterType;

import static org.springframework.context.annotation.ComponentScan.*;

 

@Configuration

@ComponentScan( excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))

public class AutoAppConfig { }

 

컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.

기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다!

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주자

public class AutoAppConfigTest {
    @Test
    void basicScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

 

AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하다.

설정 정보로 AutoAppConfig 클래스를 넘겨준다.

실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.

memoryMemberRepository의 타입이 MemberRepository 타입이므로 memoryMemberRepository를 주입

ctrl+B  : 해당 클래스로 이동

->

탐색 위치와 기본 스캔 대상

만약 basePackageClasses = AutoAppConfig.class 라 하면 AutoAppConfig의 패키지인 hello.core 부터 찾는다.

 

만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

->AutoAppConfig의 패키지인 hello.core 

 

권장하는 방법 개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공

 

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

사실 이미 스프링 부트에서 자동으로 등록해주기 때문에 @Componentscan을 쓸 필요가 없다.

@Component만 붙이면됨

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.

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

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

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

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

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

 

필터

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

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

 

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

@Target(ElementType.TYPE) // TYPE은 클래스 레벨에 붙는것
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {

}

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

@Target(ElementType.TYPE) // TYPE은 클래스 레벨에 붙는것
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {

}

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

package hello.core.scan;

@MyIncludeComponent
public class BeanA {
}

 

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

package hello.core.scan;

@MyExcludeComponent
public class BeanB {
}

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

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext 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 = @ComponentScan.Filter(type= FilterType.ANNOTATION,classes = MyIncludeComponent.class),
    excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,classes=MyEncludeComponent.class))
    static class ComponentFilterAppConfig{

    }
}

includeFilters 에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.

excludeFilters 에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다

 

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

@Configuration
@ComponentScan(includeFilters = @Filter(type= FilterType.ANNOTATION,classes = MyIncludeComponent.class),
excludeFilters = @Filter(type = FilterType.ANNOTATION,classes=MyExcludeComponent.class),
        @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class))
static class ComponentFilterAppConfig{

}

중복 등록과 충돌

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

다음 두가지 상황이 있다.

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

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

 

자동 빈 등록 vs 자동 빈 등록

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

 

수동 빈 등록 vs 자동 빈 등록

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

@Component
public class MemoryMemberRepository implements MemberRepository {

@Configuration // 설정정보니까
@ComponentScan(//컴포넌트 스캔이란 스프링 빈을 스캔해서 자동으로 스프링 빈으로 끌어올려야 한다
        basePackages = "hello.core.member",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes=Configuration.class)) // 스캔 뺄거 지정
public class AutoAppConfig {

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

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

 

수동 빈 등록시 남는 로그

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

 

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다.

하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다! 그러면 정말 잡기 어려운 버그가 만들어진다.

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

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

 

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

스프링부트 애플리케이션 구동시 에러 발생

application.properties에서

spring.main.allow-bean-definition-overriding=true

 

해주면 정상 동작된다.

스프링부트에서 deault 값은 false이다. -> 원복해두자