[Spring] @Component와 컴포넌트 스캔

 

컴포넌트 스캔과 자동 주입 설정

앞선 글에서는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했으나, 이렇게 할 경우 등록해야 할 스프링 빈이 수십~수백 개가 될 경우 설정 정보도 커지고 누락하는 문제가 발생할 수가 있다. 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 또한 의존관계도 자동으로 주입하는 @Autowired 기능도 제공한다.

 

이제부터 AutoAppConfig.java 파일을 생성하는 것부터 해서 코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자

 

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

}

• 컴포넌트 스캔을 사용하기 위해 @ComponentScan을 붙여주면 된다.
• 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 없다.
• 컴포넌트 스캔은 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

이처럼 컴포넌트 스캔을 할 대상들에 @Component 어노테이션을 설정해 주자

@Component
public class MemoryMemberRepository implements MemberRepository{

}

@Component
public class RateDiscountPolicy implements DiscountPolicy{

}

@Component
public class MemberServiceImpl implements MemberService{

}

@Component
public class OrderServiceImpl implements OrderService {

}

• AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에 의존관계 주입도 이 클래스 안에서 해결해야 된다.
• @Autowired는 의존관계를 자동으로 주입해 준다.
• @Autowired를 사용하면 생성자에서 여러 의존관계도 한 번에 주입받을 수 있다.

이렇게 컴포넌트 스캔을 통해 스프링 빈이 정상적으로 등록이 되었는지 테스트 코드를 통해 확인해 보자.

public class AutoAppConfigTest {

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

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

}

결과

결과에서 보이듯이 위에서 @Component를 선언한 4개의 클래스에 대해서 정상적으로 스프링 빈으로 등록된 것을 확인할 수가 있다.

 

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

1. @ComponentScan

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

2. @Autowired 의존관계 자동 주입

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

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

 

탐색 위치와 기본 스캔 대상

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

@ComponentScan(
          basePackages = "hello.core",
}

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

 

컴포넌트 스캔 기본 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용, 스프링 MVC 컨트롤러로 인식
• @Service : 스프링 비지니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용, 스프링 데이터 접근 계층으로 인식하고 데이터 계층의 예외를 스프링 예외로 변환해 준다.
• @Configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

 

필터

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

코드를 통해서 확인해 보자

 

컴포넌트 스캔 대상에 추가할 어노테이션

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

컴포넌트 스캔 대상에서 제외할 어노테이션

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

컴포넌트 스캔 대상에 추가할 클래스

@MyIncludeComponent
public class BeanA {
}

컴포넌트 스캔 대상에서 제외할 클래스

@MyExcludeComponent
public class BeanB {
}

public class ComponentFilterAppConfigTest {

    @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(
            // 내가 설정한 Annotation을 포함 및 제외 설정 -> BeanA : 스프링 빈 등록o, BeanB : 스프링 빈 등록x
            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라는 인터페이스를 구현해서 처리

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록할 경우 두 가지의 상황이 있다. 아래 각각의 상황을 살펴보자

 

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

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

-> ConflictingBeanDefinitionException 예외 발생

 

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

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

 

출처 : 인프런 우아한 형제들 최연소 기술이사 김영한의 스프링 완전 정복(스프링 핵심원리 - 기본 편)