컴포넌트 스캔

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

- 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

- 예제에서는 몇개 안되었지만 스프링 빈이 수십 수백개가 되면 등록도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.

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

- 또 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

 

코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자.

 

먼저 기존 AppConfig.java는 과거 코드와 테스트를 위해 남겨두고, 새로운 AutoAppConfig.java를 생성한다.

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

}

- 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.

- 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.

 

참고 : 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 AppConfig, TestConfig등 앞서 만들어 두었던 설정 정보도 함께 등록되고 실행되어 버린다. 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하진 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해 이 방법을 선택하였다.

 

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

 

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

 

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주자.

@Component
public class MemoryMemberRepository implements MemberRepository{

}

@Component
public class RateDiscountPolicy implements DiscountPolicy{

}

@Component
public class MemberServiceImpl implements MemberService{

}

 

MemberServiceImpl의 DI를 처리해줘야 하는 문제가 하나 있다.

기존 AppConfig 코드를 보면

    @Bean
    public MemberService memberService(){
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService(){
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public DiscountPolicy discountPolicy(){
//        return new FixDiscountPolicy();
        return new RateDiscountPolicy();
    }

DI 까지 다 처리가 되었지만 지금의 AutoAppConfig에는 그러한 내용이 없기 때문이다.

이 문제를 @Autowired라는 어노테이션을 통해 다음과 같이 해결해준다.

 

@Component
public class MemberServiceImpl implements MemberService{

    MemberRepository memberRepository;

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

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }

    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

 

- 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.

- @Autowired는 의존관계를 자동으로 주입해준다.

 

@Component
public class OrderServiceImpl implements OrderService{

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);
        return new Order(memberId, itemName, itemPrice, discountPrice);
    }

    //for test
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

OrderServiceImpl또한 Autowired 처리를 해준다.

 

테스트를 통해검증을 진행해보자.

public class AutoAppConfigTest {

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

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

-AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.

 

 

테스트는 통과가 된다. 로그를 보면

 Creating shared instance of singleton bean 'autoAppConfig'
 Creating shared instance of singleton bean 'rateDiscountPolicy'
 Creating shared instance of singleton bean 'memberServiceImpl'
 Creating shared instance of singleton bean 'memoryMemberRepository'
 Autowiring by type from bean name 'memberServiceImpl' via constructor to bean named 'memoryMemberRepository'
 Creating shared instance of singleton bean 'orderServiceImpl'
 Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
 Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'

 

싱글톤 객체가 생성이 되고, AutoWiring이 되는 것을 확인할 수 있다.

- @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.

- 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

  - 빈 이름 기본 전략 : MemberServiceImpl -> memberServiceImpl

  - 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2")이런 식으로 직접 이름을 부여하면 된다.

 

그 후 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

- 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

  - getBean(MemberRepository.class)와 동일하다고 이해하면 된다.

 

 

 

 

탐색 위치와 기본 스캔 대상

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

@Configuration
@ComponentScan(
        basePackages = "hello.core.member",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,
                classes = Configuration.class)
)
public class AutoAppConfig {

}

-basicPackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

  - basePackgex ={"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

- basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위로 지정한다.

- 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

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

 

예를 들어서 프로젝트가 다음과 같은 구조로 되어있다면.

- com.hello

- com.hello.service

- com.hello.repository

 

com.hello -> 프로젝트 시작 루트, 여기에 AppConfig같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙힌뒤, basePackage 지정은 생략한다.

 

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

- 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.(이 설정 안에 바로 @ComponentScan이 들어있다)

 

 

컴포넌트 스캔 기본 대상

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

- @Component : 컴포넌트 스캔에서 사용

- @Controller : 스프링 MVC 컨트롤러에서 사용

- @Service : 스프링 비즈니스 로직에서 사용

- @Repository : 스프링 데이터 접근 계층에서 사용

- @Configuration : 스프링 설정 정보에서 사용

 

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

 

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

- @Controller : 스프링 MVC 컨트롤러로 인식

- @Service : 특별한 처리를 하지 않으나, 개발자들이 핵심 비즈니스 로직이 여기 있다는 것을 인식하는데 도움을 준다.

- @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환시켜준다.

- @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

 

 

다음 예제를 통해 Filter를 알아보자

테스트 패키지는 다음과 같다.

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

}

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

}

 

다음과 같은 애노테이션을 만들었다.(어려우니 만들었다고만 생각하자)

include는 스프링 빈에 포함할거고 exclude는 스프링 빈에 등록을 제외할 것이다.

@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(
            includeFilters = @Filter(type = FilterType.ANNOTATION,
                    classes = MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION,
                    classes = MyExcludeComponent.class))
    static class ComponentFilterAppConfig{

    }
}

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

 

includeFilters를 통해 MyIncludeComponent는 추가하였고 excludeFilters를 통해 MyExcludeComponent는 제외하였다.

 

따라서 BeanA는 스프링 빈에 등록되었고, BeanB는 스프링 빈에 등록되지 않는다.

 

 

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도 빼고 싶으면 다음과 같이 추가하면 된다.

 

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

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

 

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

다음 두가지 상황이 있다.

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

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

 

 

자동 빈 등록 vs 자동 빈 등록

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

  - ConflictingBeanDefinitionException 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

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

public class AutoAppConfig {

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

}

 

memoryMemberRepository라는 Bean 이름이 충돌되게 수동 빈 하나를 더 등록하였다.

이후 테스트 코드를 돌려보면 다음과 같은 로그를 확인할 수 있다.

 

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing 

 

이 경우 수동 빈 등록이 우선권을 가진다.

/** 수동 빈이 자동 빈을 오버라이딩 해버린다 */

 

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.

* 그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그이다.

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

 

***************************
APPLICATION FAILED TO START
***************************

Description:

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:\Users\tta\IdeaProjects\core\out\production\classes\hello\core\member\MemoryMemberRepository.class] and overriding is disabled.

 

라는 에러가 발생한다.