[스프링 기본] 6. 컴포넌트 스캔

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

지금까지는 @Bean을 사용해서 스프링 빈을 일일히 등록했다.

하지만 등록해야할 스프링 빈이 많아지면 귀찮고 누락 문제도 많이 발생한다.

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

또 의존관계를 자동 주입하는 @Autowired도 제공한다.

AutoAppConfig라는 클래스를 만들자.

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

}

@Configuration에 더해 @ComponentScan을 더해준다.

컴포넌트 스캔은 말 그대로 @Component가 붙은 애들을 모두 스프링 빈에 더해준다.

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

단 초반에 필터 설정한 애들은 빈에 등록되지 않는다. 

 

@Configuration도 내부적으로 @Component를 가지고 있기 때문에 등록 대상이다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않는다. 하지만 이전 예제의 AppConfig와 TestConfig등을 등록하지 않기 위해 위 코드에서는 필터 설정을 해주었다.

 

지금 코드를 보면 AppConfig와 달리 @Bean으로 등록한 클래스가 하나도 없다.

@Bean으로 등록하는 대신 직접 그 클래스에 가서 @Component를 붙인다. 

@Component
public class MemoryMemberRepository implements MemberRepository {

@Component
public class RateDiscountPolicy implements DiscountPolicy {

MemoryMemberRepository와 RateDiscountPolicy에 @Component 붙이기.

 

@Component
public class MemberServiceImpl implements MemberService {
    //다형성!
    private final MemberRepository memberRepository ;

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

MemberServiceImpl에 @Component와 @Autowired를 붙이기

OrderServiceImpl도 마찬가지

 

@Autowired를 생성자에 붙이면 스프링이 의존관계 주입을 알아서 해준다.

기본적으로 타입이 같은 빈을 찾아서 주입한다.

위 코드의 경우 getBean(MemberRepository.class)과 같다.

 

@Test
void basicScan() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
    MemberService memberService = ac.getBean(MemberService.class);
    assertThat(memberService).isInstanceOf(MemberService.class);
}

빈이 제대로 등록되었는지 테스트해보자.

잘 동작하는 것을 볼 수 있다.

 

 

 

탐색 위치와 기본 스캔 대상

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

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

}

basePackages = "hello.core": 시작 위치 지정 

basePackages = {"hello.core", "hello.service"} :여러 시작 위치 지정

basePackageClasses: 지정한 클래스의 패키지를 시작 위치로 지정

지정하지 않을 경우: @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치

 

최근엔 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이 인기이다.

 

컴포넌트 스캔은 @Component 뿐만 아니라 아래 애들도 스캔 대상에 포함한다.

• @Controlller: 스프링 MVC 컨트롤러로 인식 
• @Service  :특별한 처리를 하지 않지만 개발자들이 핵심 비즈니스 로직이라고 파악 가능
• @Repository : 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리

이 클래스들의 소스 코드를 까보면 @Component을 포함하고 있기 때문이다.

 

필터

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

테스트 폴더에 이렇게 만들어보자. MyIncludeComponent, MyExcludeComponent 는 사용자 정의 어노테이션이다.

BeanA에는 @MyIncludeComponent를, BeanB에는 MyExcludeComponent를 붙인다.

 

@Configuration
@ComponentScan(
        includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
static class ComponentFilterAppConfig {
}

테스트 코드에 Configuration 작성.

내가 만든 어노테이션으로 필터를 설정해준다.

그리고 빈을 조회해보면, BeanA만 조회되고 BeanB는 조회되지 않는다.

 

중복 등록과 충돌

중복 등록의 두 가지 사례

• 자동 빈 등록 vs 자동 빈 등록
• 수동 빈 등록 vs 자동 빈 등록

자동 빈 등록 vs 자동 빈 등록

ConflictingBeanDefinitionException 오류 발생

 

수동 빈 등록 vs 자동 빈 등록

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

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

이렇게 이미 있는 빈 이름을 수동으로 추가 등록해보자.

그리고 아까만든 빈 조회 테스트를 돌려보면 성공하는 것을 볼 수 있다.

 

근데 이러면 오히려 더 애매해진다.

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

@SpringBootApplication
public class CoreApplication {

   public static void main(String[] args) {
      SpringApplication.run(CoreApplication.class, args);
   }

}

 

스프링 부트인 CoreApplication 을 실행해보면 오류가 나는 것을 볼 수 있다.

 

 

이 포스팅은 인프런 김영한님의 '스프링 핵심 원리 기본편'을 듣고 정리한 것입니다.
강의 링크: https://url.kr/udopsk