김영한 스프링 핵심 원리(기본편) - 컴포넌트 스캔

컨포넌트 스캔?

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

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

📌 컴포넌트 스캔과 의존관계 자동 주입 코드로 확인
AutoAppConfig.java

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

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

• @Component 설정 정보를 붙임
  ( @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다. )

• @Bean으로 등록한 클래스가 없음

• 참고
  컨포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 스프링 빈으로 등록

• 컴포넌트 스캔의 대상이 되도록 @Component 애너테이션을 붙임

@Component
public class MemoryMemberRepository implements MemberRepository{}
  
@Component
public class RateDiscountPolicy implements DiscountPolicy{}
  
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 = new FixDiscountPolicy();
    //private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
    private final DiscountPolicy discountPolicy;

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

• 이전에는 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성 했지만, 의존관계도 직접 명시
  -> 설정 자체 없기 때문에 의존관계 주입도 클래스 안에서 해결 필요
• @Autowrired는 의존관계를 자동으로 주입
• 테스트 코드
  AutoAppConfigTest.class

public class AutoAppConfigTest {

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

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

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

• @ComponentScan
  

  • @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록
  • 스프링 빈 기본이름은 클래스명 앞글자 소문자 사용
    • 빈 이름 기본 전략 : memberServiceImpl
    • 빈 이름 직접 지정 : @Component("memberService2") 이런식으로 이름을 부여

• @Autowired 의존관계 자동 주입
  

  • 생성자에 @Autowired 지정, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아 주입
  • 빈을 찾는 기본 조회 전략은 같은 타입의 빈을 찾음

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

• 탐색할 패키지의 시작 위치 설정
  • 모든 클래스를 다 스캔하기 보다는 시작 위치를 정함

@ComponentScan(
basePackage = "hello.core"
)

• basePackages : 탐색할 패키지의 시작 위치를 지정. 이 패키지를 포함해서 하위 패키지를 모두 탐색

• basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정

• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정
  만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치

• 컴포넌트 스캔 기본 대상

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

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

  • @Controller : 스프링 MVC 컨트롤러로 인식하고 그 매커니즘 맞춰 동작
  • @Service : 비즈니스 계층 인식
  • @Repository : 스프링 데이터 접근 계층 인식, 데이터 계층의 예외를 스프링 예외로 변환
  • @Configuration : 스프링 설정 정보 인식, 스프링 빈이 싱글톤을 유지하도록 처리

3) 필터

• includeFilters : 컴포넌트 스캔 대상 추가로 지정

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

• MyIncludeComponent

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

• MyExcludeComponent

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

• BeanA

@MyIncludeComponent
public class BeanA {
}

• BeanB

@MyExcludeComponent
public class BeanB {

}  

• ComponentFilterAppConfigTest

public class ComponentFiilterAppConfigTest {

    @Test
    void filterScan(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        Assertions.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 = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {}

}

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

@Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다.

4) 중복 등록과 충돌

• 자동 빈 등록

  • 자동으로 스프링 빈이 등록되는데 이름이 중복되는 경우 스프링은 오류를 발생
  • ConflictingBeanDefinitionException 발생

• 수동 빈 등록

  • AutoAppConfig

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

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

• 테스트 정상

• 수동 빈 등록이 우선(수동 빈이 자동 빈을 오버라이딩 함)

• 로그 확인

• 변경된 부분 수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러: Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true