컴포넌트 스캔

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

 

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

그러나, 이렇게 등록해야 할 스프링 빈이 굉장히 많아질 경우 일일이 등록하기 귀찮으며 설정 정보도 커지고, 누락하는 문제가 발생할 수 있다.

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

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

 

우선 아래 코드를 통해 컴포넌트 스캔과 의존관계 자동 주입을 살펴보도록 한다.

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

}

 

• 컴포넌트 스캔을 사용하려면, 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
• 기존의 AppConfig과 다르게 @Bean 으로 등록한 클래스가 하나도 없다.

 

컴포넌트 스캔은 이름 그대로 @Component 애너테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

참고로, @Configuration 이 컴포넌트 스캔의 대상이 된 이유는 @Configuration 소스코드를 열어보면 @Component 애너테이션이 붙어있기 때문이다.

 

 

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository){
        this.memberRepository = memberRepository;
    }
	
    ...
}

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
    
    ...
}

 

구현 클래스마다 @Component 애너테이션을 달아줌으로써 자동으로 컴포넌트 스캔에 해당이 되어 Bean 등록이 되었던 것과 동일하게 될 수 있다.

@Autowired 는 의존관계를 자동으로 주입해준다. (AppConfig 에서 객체 생성하는 코드가 필요 없어짐)

 

 

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 자세히 알아보도록 한다.

 

① @ComponentScan

 

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.

이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

 

• 빈 이름 기본 전략 : MemberServiceImply 클래스 => memberServiceImpl
• 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 정하고 싶으면 @Component("memberServiceImpl") 와 같이 이름을 부여하면 된다.

 

② @Autowired 의존관계 자동 주입

 

생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

• getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.
• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

 

탐색 위치와 기본 스캔 대상

 

탐색할 패키지의 시작 위치를 지정하는 것을 알아보도록 한다.

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

 

아래 코드와 같이 지정 가능하다.

@ComponentScan(
        basePackages = "hello.core.member",
        ...
)
...

 

basePackages : 탐색할 패키지의 시작 위치를 지정하며 이 패키지를 포함하여 하위 패키지 모두를 탐색한다.

• basePackages = {"hello.core", "hello.service"} 와 같이 여러 시작 위치 지정도 가능하다.

basePackagesClasses : 지정한 클래스의 패키지를 탐색 시작 위로 지정한다.

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

 

예를 들어서 아래와 같이 코드가 상단부에 작성되었다고 가정해본다.

package hello.core;

 

이 경우 hello.core 하위 부분을 모두 탐색하여 컴포넌트 스캔을 하게 된다.

 

또 다른 예로 프로젝트가 다음과 같이 구조화 되었다고 가정해본다.

 

• com.hello
• com.hello.service
• com.hello.repository

 

com.hello -> 프로젝트 시작 루트로, 여기에 AppConfig 같은 메인 설정 정보를 두고 @ComponentScan 애너테이션을 붙이고 basePackages 지정을 생략해도 된다.

이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 되기 때문이다.

 

 

※ 컴포넌트 스캔 기본 대상

 

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

 

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용

 

...
@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}
...

 

애너테이션은 상속관계라는 것이 없다.

그래서 이렇게 애너테이션이 특정 애너테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능이 아닌, 스프링이 지원하는 기능이다.

 

컴포넌트 스캔의 용도 뿐만 아니라 다음 애너테이션이 있으면 스프링은 부가 기능을 수행한다.

 

• @Controller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
• @Service : 특별한 처리를 하지 않지만, 개발자들이 핵심 비즈니스 로직이 여기에 있겠다 라고 비즈니스 계층을 인식하는데 도움된다.

 

필터

 

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

 

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

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

}

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

}

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        Assertions.assertThat(beanA).isNotNull();

        org.junit.jupiter.api.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 {

    }
}

 

 

• includeFilters 에 MyIncludeComponent 에너테이션을 추가하여 BeanA가 스프링 빈에 등록된다.
• excludeFilters 에 MyExcludeComponent 에너테이션을 추가하여 BeanB는 스프링 빈에 등록되지 않는다.

 

※ FilterType 옵션

FilterType 은 5가지 옵션이 존재한다.

 

• ANNOTATION : 기본값, 애너테이션을 인식해서 동작한다.
• ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.
• ASPECTJ : ASPECTJ 패턴 사용
• REGEX : 정규 표현식
• CUSTOM : TypeFilter 이라는 인터페이스를 구현해서 처리

 

예를 들어서 BeanA도 스프링 빈에 등록하지 않으려면 다음과 같이 추가하면 된다.

@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)
	}		  
)

 

 

중복 등록과 충돌

 

컴포넌트 스캔에서 같은 빈 이름을 등록하는 상황이 발생하게 될 경우가 있다.

다음과 같은 2가지 상황을 생각해보자.

 

• 자동 빈 등록 vs 자동 빈 등록
• 수동 빈 등록 vs 자동 빈 등록

 

※ 자동 빈 등록 vs 자동 빈 등록

 

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

 

• ConflictingBeanDefinitionException 예외 발생

 

※ 수동 빈 등록 vs 자동 빈 등록

 

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

아래와 같이 코드를 작성하여 실행 결과를 확인해보도록 한다.

@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" 문구가 뜨면서 정상적으로 실행되는 것을 볼 수 있다.

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

 

@SpringBootApplication
public class CoreApplication {

    public static void main(String[] args) {
        SpringApplication.run(CoreApplication.class, args);
    }
}

 

CoreApplication 를 다음과 같이 실행하면 에러가 난다.

에러를 해결하기 위해 application.properties 에 다음을 붙여넣어준다.

 

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

 

그러면 정상적으로 실행된다.