컴포넌트스캔

컴포넌트 스캔

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

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

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
• 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
• excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.
• 컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
• @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.

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

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

• @Autowired 는 의존관계를 자동으로 주입해준다.
• 의존관계에 대한 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
• 빈으로 잘 등록됐는지 테스트코드로 확인해보자.

    public class AutoAppConfigTest {
      @Test
      void basicScan() {
          ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
          MemberService memberService = ac.getBean(MemberService.class);
          assertThat(memberService).isInstanceOf(MemberService.class);
      }
}

• 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
• 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.
  
  
  
  
  
  

컴포넌트 스캔 탐색 위치

• 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

    @ComponentScan(basePackages = "hello.core")

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
• basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
• 개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
• 보통 @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.
• 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. -> @ComponentScan 이 들어있다.
  
  
  
  
  
  

컴포넌트 스캔 기본 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controlller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용
• 사실 거의다 @Component를 포함하고 있다.
  
  
  
  
  
  

필터

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
• 아래 처럼 직접 애노테이션을 만들 수 있다.

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

• 아래와 같이 클래스에 직접만든 애노테이션을 달아준다.

    @CustomComponent
    public class BeanA {
    }

• 아래와 같이 직접 만든 애노테이션이 붙은 클래스들을 컴포넌트 스캔 대상에서 제외할 수 있다.

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

• 아래와 같이 확인할 수 있다.

Assertions.assertThrows( NoSuchBeanDefinitionException.class,
                  () -> ac.getBean("beanA", BeanA.class));

• 필터 옵션
  • ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
    • ex> @Filter(type = FilterType.ANNOTATION, classes = CustomComponent.class)
  • ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
    • ex> @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
  • ASPECTJ: AspectJ 패턴 사용
  • REGEX: 정규 표현식
  • CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리
• @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
• 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.
  
  
  
  
  
  

중복 등록과 충돌

• 자동 빈 등록 vs 자동 빈 등록
  • 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
  • ConflictingBeanDefinitionException 예외 발생
• 수동 빈 등록 vs 자동 빈 등록
  • 수동 빈 등록이 우선권을 가진다.
• 하지만 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.
  • Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true 라는 에러를 발생시킨다.

REFERENCES

• 김영한님의 스프링 기본편