Spring / @ComponentScan, @Component

@ComponentScan을 이용한 Bean 등록

 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean을 통해서나 또는 XML의 <bean> 을 통해 설정정보(AppConfig)에 직접 등록할 빈들을 나열했었다.

 

예제에서는 몇 개 없었지만, 등록해야 할 빈이 수십개, 수백개가 되면 일일이 등록하기 귀찮고, 설정정보 자체가 커져 누락하는 문제까지 발생할 수 있다.

 

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

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

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

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

}

 

컴포넌트 스캔을 사용하게 되면 @Configuration이 붙은 설정 정보(AppConfig)도 자동으로 등록되기 때문에, 기존에 있던 AppConfig에 영향이 가지 않도록 excludeFilter를 사용해서 기존의 설정정보는 스캔 대상에서 제외시켰다.

(보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서)

@ComponentScan을 이름 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

 

이제 등록할 빈들에 @Component를 붙혀 빈에 등록하고 테스트 해보자.

 

@Component
public class MemoryMemberRepository implements MemberRepository{

@Component
public class RateDiscountPolicy implements  DiscountPolicy{
 

 

+ 의존관계 주입할 때에는 @Autowired를 사용하면 된다.

@Component
public class MemberServiceImp implements MemberService{
    private final MemberRepository memberRepository;

    @Autowired // ac.getBean(MemberRepository.class)
    public MemberServiceImp(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

@Component
public class OrderServiceImp implements OrderService{
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

 

이 전 AppConfig에서는 @Bean으로 직접 설정정보를 작성했고, 의존관계도 직접 명시했다.

이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.

@Autowired는 의존관계를 자동으로 주입해준다.

 

Testcode

public class AutoAppConfigTest {

    @Test
    void basicBean()
    {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService bean = ac.getBean(MemberService.class);
        Assertions.assertThat(bean).isInstanceOf(MemberServiceImp.class);
    }
}

통과

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

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

로그를 잘보면 컴포넌트 스캔이 동작하는 것을 확인할 수 있다

 

동작원리를 알아보자.

 

1. @ComponentScan

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

이 때 빈의 기본이름은 클래스명을 사용하는데, 앞글자가 소문자로 바뀜

- 빈 이름 기본 전략 : MemberServiceImp -> memberServiceImp

만약 빈의 이름을 지정하고 싶다면 @Component("지정이름")으로 부여하면 된다.

 

2. @Autowired 의존관계 주입

생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 빈을 찾아 의존관계를 주입해준다.

ac.getBean(MemberRepository.class)와 동일하다고 보면 됨.

이때 기본 조회 전략은 타입을 보고 빈을 찾아서 주입하는데 만약 같은 타입이 컴포넌트로 여러 개 지정 되어 있으면 어떻게 될까??

뒤에서 다루도록 하겠다. 

 

 

---

@ComponentScan 탐색 위치

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리기 때문에, 탐색할 패키지의 시작 위치를 @ComponentScan에 basePackages 파라미터를 지정해서 변경할 수 있다.

@ComponentScan(
          basePackages = {"hello.core"} )

basePackages : 시작위치를 지정해서 해당위치의 하위 패키지를 모두 탐색한다.

basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

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

 

권장하는 방법

그냥 @ComponentScan이 붙은 설정정보 클래스의 위치를 프로젝트 최상단에 두자.

최근 스프링 부트도 이 방법을 default로 제공한다고 한다.

 

예를들어

kdo6301.core.hello

kdo6301.core.hello.service

kdo6301.core.hello.repository 가 있다고 하면

 

kdo6301.core.hello에 설정정보 클래스파일을 두자는 것이다.

클래스파일을 최상단에 두고 @ComponentScan만 붙혀주고 basePackage 지정 생략.

이게 제일 깔끔하다.

이렇게 하면 kdo6301.core.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

❗️ 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다!)

 

@ComponentScan 기본 대상

컴포넌트 스캔은 기본적으로 @Component 뿐만 아니라 

@Controller, @Service, @Repository, @Configuration도 추가로 대상에 포함한다.

 

1. @Controller : Spring MVC Controller에서 사용

2. @Service : Spring Buisness 로직에서 사용

3. @Repository : Spring 데이터 접근 계층에서 사용

4. @Configuration : Spring 설정 정보에서 사용 (AppConfig)

 

@Repository

@Repository는 컴포넌트를 포함하고 있어 빈 등록 뿐만 아니라 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다. 

 

@Controller

@Controller는 컴포넌트를 포함하고 있어 빈 등록 뿐만 아니라 스프링 MVC Controller로 인식하게 해준다.

 

@Service

@Service는 컴포넌트를 포함하고 있어 빈 등록을 해주지만 그 외의 별다른 기능은 제공하지 않는다.

단순하게 핵심 비즈니스 계층을 개발자가 인식하기 쉽게 해주기 위해 사용

 

@Configuration

@Configuration은 빈등록 뿐만 아니라 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

 

❗️ 참고: useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나 정도 알고 넘어가자.

 

---

@ComponentScan Filter

@ComponentScan에는 필터를 사용해서 컴포넌트 스캔 대상을 추가로 지정하거나 제외할 수 있다.

 

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

 

 

package hello.core.scan;


import hello.core.scan.filter.BeanA;
import hello.core.scan.filter.BeanB;
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;

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

    @Test
    void filterScan()
    {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean(BeanA.class);
        System.out.println("beanA = " + beanA);
        assertThat(beanA).isNotNull();

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


    }
    
}

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

 

 

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

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

 

 

---

중복등록과 충돌

 

수동 빈 등록 vs 수동 빈 등록

@Component("myService")
public class MemberServiceImp implements MemberService{
    private final MemberRepository memberRepository;

@Component("myService")
public class OrderServiceImp implements OrderService{
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

 

다음과 같이 수동으로 @Component를 지정해서 이름이 같은 빈을 등록하여 테스트를 돌려보면

 

ConflictBeanDefinitionException 예외 발생

다음과 같이 충돌이 발생하여 예외가 발생한다.

 

 

수동 빈 등록 vs 자동 빈 등록

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

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

수동으로 등록된 빈이 우선권을 가진다! 수동 빈이 자동 빈을 오버라이딩 해버림.

17:43:11.644 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Overriding bean definition for bean 'memoryMemberRepository' with a different definition 

 

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이라고 한다.
그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

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

스프링 부트인 CoreApplication 을 실행해보면 다음과 같은 오류를 볼 수 있다.

 

<참고 자료>

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

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