#6. [스프링 핵심 원리-기본편] - 컴포넌트 스캔

컴포넌트 스캔과 의존관계 자동 주입 시작하기

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

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

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

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

 

[AutoAppConfig]

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@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 애노테이션을 붙여주자.

[MemoryMemberRepository] @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

 

[RateDiscountPolicy] @Component 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

[MemberServiceImpl] @Component 추가

@Component
public class MemberServiceImpl implements MemberService {
     private final MemberRepository memberRepository;
 
     @Autowired
     public MemberServiceImpl(MemberRepository memberRepository) {
         this.memberRepository = memberRepository;
     }
 
}

[OrderServiceImpl] @Component 추가

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

@Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다

 

 

[AutoAppConfigTest]

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.*;

public class AutoAppConfigTest {

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

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

 

설명

 

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다.

그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

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

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

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

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

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

 

 

권장하는 방법

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

방법으로는

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

 

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

 

 

컴포넌트 스캔 기본 대상

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

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

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

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

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

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

@Component
public @interface Controller {
...
}

@Component
public @interface Service {
...
}

@Component
public @interface Configuration {
...
}

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

 

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

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

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

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

- '@Service' : 사실 '@Service'는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나라고 비즈니스 계층을 인식하는데 도움이 된다.

 

 

필터

- 'includeFilters' : 컴포넌트 스캔 대상을 추가로 지정한다.

- 'excludeFilters' : 컴포넌트 스캔에서 제외할 대상을 지정한다.

 

[MyIncludeComponent]

package hello.core.scan.filter;

import java.lang.annotation.*;

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

 

[MyExcludeComponent]

package hello.core.scan.filter;

import java.lang.annotation.*;

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

 

[BeanA]

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

 

[BeanB]

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

 

[ComponentFilterAppConfigTest]

package hello.core.scan.filter;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.context.annotation.ComponentScan.*;

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

    }
}

MyIncludeComponent는 includeFilters에 포함시키고, MyExcludeComponent는 excludeFilters에 포함시켰다.

이러면 ComponentScan을 할 떄 MyExcludeComponent 애노테이션이 붙은 컴포넌트는 제외하고, MyIncludeComponent 애노테이션이 붙은 컴포넌트는 포함시킨다.

따라서 BeanA는 포함, BeanB는 제외한다.

 

FilterType의 종류

- 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

 

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

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

 

 

중복 등록과 충돌

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

 

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

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

 

자동 빈 등록 vs 자동 빈 등록

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

  * ConflictingBeanDefinitionException 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

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

@Component
public class MemoryMemberRepository implements MemberRepository { }

package hello.core;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
        basePackages = "hello.core",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
    @Bean(name = "memoryMemberRepository")
    MemberRepository memoryMemberRepository() {
        return new MemoryMemberRepository();
    }
}

한개는 @Component를 붙여서 컴포넌트 스캔이 되게 하고, 하나는 설정파일에 @Bean을 붙여서 수동등록 한다.

 

결과는 뜻밖에도 성공이다!

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

 

수동 빈 등록 시 남는 로그

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing [Generic bean: class [hello.core.member.MemoryMemberRepository]; ...

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

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

최근 스프링 부트에서는 수동 빈과 자동 빈이 충돌하면 오류가 발생하도록  기본 값을 바꿔버렸다.

 

수동 빈 등록, 자동 빈 등록 시 오류

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\banaple_111\Desktop\study_spring\core\out\production\classes\hello\core\member\MemoryMemberRepository.class] and overriding is disabled.

Action:

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

추가적으로 만약 수동 빈으로 오버라이딩을 원한다면 설정을 할 수 있다. (기본은 false 이다.)

 

오버라이딩을 원한다면?

[resources/appcliation.properties]

spring.main.allow-bean-definition-overriding=true