컴포넌트 스캔 (@ComponentScan, 의존 관계 자동 주입, 컴포넌트 스캔 위치 지정 + 제외)

 

싱글톤 컨테이너 - 2 (싱글톤 주의점, @Configuration, 바이트 코드 조작)

싱글톤 컨테이너 - 2 (싱글톤 주의점, @Configuration, 바이트 코드 조작)

 

---

 

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

여태 프로젝트를 작성할 때 스프링 빈을 등록시에는, 자바 코드의 @Bean이나 XML의 <bean>을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열해서 작성했었다. 이렇게 할 수 있던 이유는, 등록해야 할 스프링 빈이 적었기에 가능했다. 만약 등록할 스프링 빈이 수백개가 된다면 등록하기 귀찮을 뿐더러, 설정 정보도 커지고, 누락하는 문제도 발생한다.

이를 해결하기 위해서 스프링에는 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능이 존재한다. 또한 의존 관계도 자동으로 주입하는 @Autowired 기능도 제공한다.

 

이번엔 이러한 기능들을  알아보겠다. 코드를 통해 테스트해보기 위해 core 디렉토리 하위에 AutoAppConfig 클래스를 생성한다.

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

}

 

컴포넌트 스캔을 사용하기 위해서는@ComponentScan 어노테이션을 붙여주면 된다. 기존의 AppConfig 설정 정보 클래스와는 다르게 @Bean으로 등록한 클래스가 하나도 존재하지 않는다. 

참고
 : 위 처럼 컴포넌트 스캔을 사용하게 되면 @Configuration 어노테이션이 붙은 설정 정보도 자동으로 등록되기에, 앞서 생성했던 AppConfig, TestConfig와 같은 설정정보 또한 함께 등록되고, 실행된다. 이를 막기위해서 excludeFilters를 사용하여 설정 정보는 컴포넌트 스캔 대상에서 제외하도록 뒷붙여 써준것이다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이러한 방법으로 코드를 작성해준 것이다.

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

 

컴포넌트 스캔은 이름 그대로 @Component 어노테이션이 붙은 클래스들을 스캔해서 스프링 빈으로 등록한다. 그렇기에 해다 기능을 사용해주기 위해서는 앞서 작성했던 빈으로 등록해야하는 클래스들에 @Component 어노테이션을 추가해줘야 한다.

@Component
public class MemoryMemberRepository implements MemberRepository{ }

@Component
public class RateDiscountPolicy implements DiscountPolicy { }

@Component
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;

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

 

이전에 사용하던 AppConfig 클래스에는 @Bean 어노테이션을 사용하여 직접 설정 정보를 작성했고, 의존관계 또한 직접 명시했다. 하지만 위처럼 컴포넌트 스캔을 통해 설정 정보를 사용하기 위해서는 의존관계 주입도 클래스 안에서 해결해줘야 한다. 따라서 @Autowired 어노테이션을 사용하여 의존관계를 자동으로 주입하는 것이다.

 

위처럼 작성해주면 스프링 빈으로 컴포넌트 스캔을 통해 자동으로 등록하는 것이 끝난다. 이를 확인해보기 위해서 테스트 코드를 작성해보겠다. test 하위에 scan 디렉토리 생성 후, AutoAppConfigTest 클래스를 생성해준다.

 

public class AutoAppConfigTest {

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

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

    }
}

assertThat을 통해 확인해보았을 때, memberService가 제대로 빈에 등록되어 검증이 되었다. 또한 콘솔을 잘 살펴보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다.

 

---

 

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 작동하는가?

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

 

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
• 기본 조회 전략은 타입이 같은 빈을 찾아서 주입
  • getBean(MemberRepository.class)와 동일하다고 이해하면 된다
  • 이 외의 더 자세한 내용은 뒤에서 설명할 것이다.

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

 

---

 

탐색 위치 지정

만약 실제 현업 프로젝트에서 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작위치를 지정해줄 수 있다.

@ComponentScan(basePackages = "com.example.core.member"}

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

 

마지막에 작성한 내용처럼, @CompoenetScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 되기에, 패키지 위치를 따로 지정해서 작성해주지 않고, 설정 정보 클래스의 위치를 프로젝트의 최상단에 두는 것이 바람직하다.
앞서 작성한 AutoAppConfig 클래스도 프로젝트의 최상단 패키지인 "com.example.core" 바로 하위에 두었기에 해당 하위에 존재하는 클래스들을 모두 자동으로 컴포넌트 스캔한 것이다.

참고
 : 스프링 부트를 사용하면 스프링 부트의 대표적인 대표 시작 정보인 @SpringBootApplication 어노테이션이 이 프로젝트 시작 루트 위치에 두는 것이 관례적이다. 또한 해당 어노테이션 안에 @ComponentScan 또한 들어있다.

 

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component 뿐만 아니라 아래의 내용도 추가로 대상에 포함한다.

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

위에서 언급한 어노테이션들 또한 컴포넌트 스캔 대상에 들어가는데, 그 이유는 해당 어노테이션들 모두 @Component를 포함하고 있기에 그렇다.

참고
 : 사실 어노테이션에는 상속관계라는 것은 존재하지 않는다. 그렇기에 어노테이션이 특정 어노테이션을 들고 있는 것을 인식하고 있는 것은 자바가 지원하는 기능이 아닌, 스프링이 지원하는 기능이다.

useDefaultFilters 옵션은 기본으로 켜져있는데, 해당 옵션을 끄게되면 기본 스캔 대상에서 제외할 수 있다.

 

위에서 언급한 어노테이션들은 해당 용도뿐만 아니라 다른 부가 기능들도 지원하는데, 아주 간단하게 알아보겠다.

• @Controller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration : 앞서 보았듯 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
• @Service : 특별한 처리를 하진 않지만, 개발자들이 비즈니스 계층을 인식하는데 도움이 된다.

 

---

 

필터

• 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 {

    @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", BeanA.class);
        Assertions.assertThat(beanA).isNotNull();

        org.junit.jupiter.api.Assertions.assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("beanB", BeanB.class));
    }
}

BeanA는 컴포넌트 스캔 대상에 추가해주는 @MyIncludeComponent를 적용했고, BeanB는 컴포넌트 대상에서 제외하는 @MyExcludeComponent를 적용해줬다. 정말 그렇게 적용이 되는지 테스트 코드를 통해 확인해보니, beanA는 Null이 아니였고, beanB는 Null이여서 exception이 발생하여 성공적으로 테스트가 실행되었다.

 

---

 

FilterType 옵션

FilterType은 아래처럼 5가지의 옵션이 존재한다.

• ANNOTATION : 기본값, 어노테이션을 인식해서 동작
  • ex) org.example.SomeAnnotation
• ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작
  • ex) org.example.SomeClass
• ASPECTJ : AspectJ 패턴 사용
  • ex) org.example..*Service+
• REGEX : 정규 표현식
  • ex) org\.example\.Default.*
• CUSTOM : TypeFilter라는 인터페이스를 구현해서 처리
  • ex) org.example.MyTypeFilter

 

만약 위에 작성한 클래스에서 BeanA도 빼고 싶으면 다음과 같이 수정해주면 된다.

@ComponentScan(
	includeFilters = {
    	@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
 	},
 	excludeFilters = {
    	@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class),
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
    }
)

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

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

 

---

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될지 알아보겠다.

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

 

자동 빈 등록 vs 자동 빈 등록

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

 

수동 빈 등록 vs 자동 빈 등록

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

 

 

---