스프링 핵심원리 기본편 - Ch06. 컴포넌트 스캔

목록

1. 포스팅 개요
2. 본론
     2-1. 컴포넌트 스캔과 의존관계 자동 주입 시작하기
     2-2. 탐색 위치와 기본 스캔 대상
     2-3. 필터
     2-4. 중복 등록과 충돌
3. 요약

1. 포스팅 개요

인프런에서 영한님의 스프링 핵심 원리 기본편 Section06 컴포넌트 스캔를 학습하며 정리한 포스팅이다.

| 참고 이전 포스팅

2. 본론

2-1. 컴포넌트 스캔과 의존관계 자동 주입 시작하기

스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
하지만 스프링은 설정 정보 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
또한 의존관계도 자동으로 주입하는 @Autowired 기능도 제공한다.

이를 코드로 하면 다음과 같다.

@Configuration
@ComponentScan( // @Component가 붙은 클래스를 찾아서 자동으로 스프링 빈으로 등록해준다.
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class) // @Configuration이 붙은 애너테이션은 거른다.
)
public class AutoAppConfig {

}

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

참고

컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록된다.
AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보가 함께 등록되어 실행된다. 그래서 excludeFilters 속성으로 설정정보는 컴포넌트 스캔 대상에서 제외하도록 했다.
| ※ 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하려고 이렇게 했다.

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

참고

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

각 클래스마다 @Component를 붙여주자.

// MemoryMemberRepository
@Component
public class MemoryMemberRepository implements MemberRepository {...}

// MemberServiceImpl
@Component
public class MemberServiceImpl implements MemberService {
   ...

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

   ...
}

// RateDiscountPolicy
@Component
public class RateDiscountPolicy implements DiscountPolicy {...}

MemberServiceImpl클래스를 보면 생성자에서 @Autowired를 붙여주었다.
AppConfig.java파일에서는 MemberRepository클래스를 @Bean으로 등록하여 의존관계를 직접 명시했지만, AppConfig를 사용하지 않는 지금은 의존관계를 주입해줄 수 있는 방법이 없다.
그런데 @Autowired붙여줌으로써 자동으로 의존관계가 주입된다.

OrderServiceImpl도 다음과 같이 변경한다.

@Component
public class OrderServiceImpl implements OrderService {
   ...

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

   ...
}

자동 의존관계 주입을 테스트해보자.

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

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

결과는 다음과 같다.

중간 트러블 슈팅

중간에 테스트가 실패 했다.

Unsatisfied dependency expressed through constructor parameter 0: No qualifying bean of type 'hello.core.member.MemberRepository' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}

메세지는 이와 같은데, MemberRepository를 찾을 수 없다고 한다.

원인은 다음과 같다. AutoAppConfig.java를 엉뚱한 패키지에 넣어놨다.

다음과 같이 root 패키지에 넣어야 잘 작동한다.

ㅇㅇ

---

결과를 보면 이런 문구가 있다.

08:30:25.413 [main] DEBUG o.s.c.a.ClassPathBeanDefinitionScanner -- Identified candidate component class: file [C:\...\RateDiscountPolicy.class]
08:30:25.414 [main] DEBUG o.s.c.a.ClassPathBeanDefinitionScanner -- Identified candidate component class: file [C:\...\MemberServiceImpl.class]
08:30:25.414 [main] DEBUG o.s.c.a.ClassPathBeanDefinitionScanner -- Identified candidate component class: file [C:\...\MemoryMemberRepository.class]
08:30:25.415 [main] DEBUG o.s.c.a.ClassPathBeanDefinitionScanner -- Identified candidate component class: file [C:\...\OrderServiceImpl.class]

다음과 같은 클래스들을 component로 식별했다는 문구와 더불어서 다른 로그를 보면,

08:30:25.529 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'autoAppConfig'
08:30:25.534 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'rateDiscountPolicy'
08:30:25.535 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'memberServiceImpl'
08:30:25.547 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'memoryMemberRepository'
08:30:25.551 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'orderServiceImpl'

@Component를 붙인 클래스들이 싱글톤 빈으로 등록되었다는 것을 알려주고,

또한 의존 관게 주입 메세지도 함께 나온다.

08:30:25.550 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Autowiring by type from bean name 'memberServiceImpl' via constructor to bean named 'memoryMemberRepository'
08:30:25.552 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
08:30:25.552 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'

이름 그림으로 보면 다음과 같다.

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
  • 빈 이름 기본 전략: MemberServiceImpl -> memberServiceImpl
  • 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 처럼 하면 된다.

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
  • getBean(MemberRepository.class)방식과 동일하다고 이해하면 된다.

위와 같이 생성자에 파라미터가 많아도 자동으로 주입한다.

2-2. 탐색 위치와 기본 스캔 대상

탐색 위치를 지정해줄 수 있다.

@Configuration
@ComponentScan( // @Component가 붙은 클래스를 찾아서 자동으로 스프링 빈으로 등록해준다.
        basePackages = "hello.core.member", // 탐색 위치 지정
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class) // @Configuration이 붙은 애너테이션은 거른다.
)
public class AutoAppConfig {

}

basePackages 속성을 통해서 탐색할 위치를 지정해줄 수 있다.
그리고 이전의 basicScan() 테스트를 돌려보면,

08:43:38.748 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'memoryMemberRepository'

이렇게 결과가 나오는데, hello.core.member를 위치로 지정했기에, Order와 관련된 스프링 빈은 등록되지 않았다.

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함한 하위 패키지를 모두 탐색한다.
• basePackages = {"hello.core", "hello.service"} 이렇게 중괄호를 이용해서 여러 시작 위치를 지정할 수 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다. 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

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

• 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

참고

스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 프로젝트 시작 루트 위치에 두는 것이 관례이다.
@SpringBootApplication에 @ComponentScan이 있다.

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.
@Component : 컴포넌트 스캔에서 사용
@Controlller : 스프링 MVC 컨트롤러에서 사용
@Service : 스프링 비즈니스 로직에서 사용
@Repository : 스프링 데이터 접근 계층에서 사용
@Configuration : 스프링 설정 정보에서 사용

왜냐하면 이 애너테이션마다 @Component가 들어있다.

참고

애노테이션은 상속관계라는 것이 없다. 따라서 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

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

• @Controller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • 예를 들면 DB를 변경하면 예외가 바뀌는 경우 같은 경우다.
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
• @Service : @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기 있다고 생각하여 비즈니스 계층을 인식하는데 도움이 된다.

참고

useDefaultFilters옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.

2-3. 필터

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

테스트를 해보자.

public class ComponentFilterAppConfigTest {

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

//        ac.getBean("beanB", BeanB.class); // No bean named 'beanB' available
        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: 기본값, 애노테이션을 인식해서 동작한다.

  • ex) org.example.SomeAnnotation

  • 이전 테스트에서 @Filter 속성에서 제외해도 된다.

    @Configuration
    @ComponentScan(
          includeFilters = @Filter(classes = MyIncludeComponent.class),
          excludeFilters = @Filter(classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {
    
     }

• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.

  • 타입을 직접 지정한다.
  • ex) org.example.SomeClass
  • ex) excludeFilters = @Filter(type = ASSIGNABLE_TYPE, classes = MyExcludeComponent.class)

• ASPECTJ: AspectJ 패턴 사용

  • ex) org.example..*Service+

• REGEX: 정규 표현식

  • ex) org.example.Default.*

• CUSTOM: TypeFilter이라는 인터페이스를 구현해서 처리

  • ex) org.example.MyTypeFilter

참고

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

2-4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?
다음 두가지 상황이 있다.

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

자동 빈 등록 vs 자동 빈 등록

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

다음과 같이 임의로 수정해보자.

@Component("service")
public class OrderServiceImpl implements OrderService {...}

@Component("service")
public class MemberServiceImpl implements MemberService {...}

그리고 이전에 작성했던 basicScan() 테스트를 해보면, 결과는 다음과 같다.

오류 메세지를 살펴보면 다음과 같이 예외가 발생한다.

로그는 다음과 같다.

Caused by: org.springframework.context.annotation.ConflictingBeanDefinitionException: Annotation-specified bean name 'service' for bean class [hello.core.order.OrderServiceImpl] conflicts with existing, non-compatible bean definition of same name and class [hello.core.member.MemberServiceImpl]

같은 빈 이름으로 인해서 충돌이 발생했다고 한다.
(참고로 테스트하고 원복을 해주자.)

수동 빈 등록 vs 자동 빈 등록

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

AutoAppConfig.java에 다음 코드를 작성한다.

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

그리고 basicScan()을 테스트하면... 결과는 다음과 같다.

로그 중간에 다음과 같은 메시지가 있다.

09:26:02.554 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing [Generic bean: class [hello.core.member.MemoryMemberRepository]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodNames=null; destroyMethodNames=null; defined in file [C:...\hello\core\member\MemoryMemberRepository.class]] with [Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=autoAppConfig; factoryMethodName=memberRepository; initMethodNames=null; destroyMethodNames=[(inferred)]; defined in hello.core.AutoAppConfig]

@Component로 등록한 memoryMemberRepository 빈이 AutoAppConfig에 정의된 memoryMemberRepository 빈으로 대체되었다는 의미다.

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

개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다.
하지만 현실은... 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다! 그러면 정말 잡기 어려운 버그가 만들어진다.
항상 잡기 어려운 버그는 애매한 버그다.
그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러는 다음과 같다.

프로젝트 생성시 처음 만들어진 클래스(@SpringBootApplication이 있는 클래스)를 통해서 스프링부트를 실행하면, 실패한다.

이유는 다음과 같다.

The bean 'memoryMemberRepository', defined in class path resource [hello/core/AutoAppConfig.class], could not be registered. A bean with that name has already been defined in file [C:\...\hello\core\member\MemoryMemberRepository.class] and overriding is disabled.

MemoryMemberRepository.class가 이미 빈으로 등록되어 있는데, AutoAppConfig에도 memoryMemberRepository가 등록되어 있다는 메세지다.

스프링은 오버라이딩 옵션이 true로 되어있지만,
스프링 부트는 오버라이딩 옵션이 false로 되어있다.

그래서 이를 사용하려면, "옵션을 이렇게 변경해라"는 메세지를 알려준다.

application.properties에 spring.main.allow-bean-definition-overriding=true 옵션을 설정하고, 실행하면 된다.

(부트 3.0으로 올라가면서 그런지 모르겠는데, 실행은 되지 않는다...ㅋㅋ)

3. 요약

컴포넌트 스캔에 대해서 자세히 알아보았다.
@Component 애너테이션과 관련된 애너테이션들 그리고 빈 등록이 어떻게 이루어지는지,
자동으로 등록하는 법, 수동으로 등록하는 법, 그리고 충돌시엔 어떻게 되는지에 대해서 알아보았다.