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

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

• 스프링 빈을 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록했다. 등록해야할 스프링 빈이 수 십, 수 백개가 된다면?
  • 귀찮고, 설정 정보도 커지며 누락하는 문제도 발생
• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공
• 또 의존관계도 자동으로 주입하는 @Autowired도 제공

 

//AutoAppConfig.java

package hello.core;

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

@Configuration
@ComponentScan(
        //컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
        // 그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class))
public class AutoAppConfig {
}

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
• 컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록 ( 참고: @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.)
• MemoryMemberRepository, RateDiscountPolicy ,MemberServiceImpl, OrderServiceImpl에 @Component 추가
• MemberServiceImpl,OrderServiceImpl의 경우 생성자에 @Autowired 추가
  • 의존 관계 주입

 

테스트

//AutoAppconfigTest.java

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;

public class AutoAppConfigTest {

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

    }

}

• 로그를 통해 잘 동작하는 것 확인

 

 

 

 

 

 

탐색 위치와 기본 스캔 대상

 

탐색할 패키지의 시작 위치 지정

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

@ComponentScan(
          basePackages = "hello.core",
          
           // 여러 시작 위치를 지정할 수도 있음
          basePackages = {"hello.core", "hello.service"}
          
		  // 지정한 클래스의 패키지를 탐색 위치로 지정
          basePackageClasses =AutoAppConfig.class

}

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

 

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

 

 

 

컴포넌트 스캔  기본 대상

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

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

• @Component : 컴포넌트 스캔에서 사용
• @Controlller : 스프링 MVC 컨트롤러에서 사용, 부가 기능 : 스프링 MVC 컨트롤러로 인식
  
• @Service : 스프링 비즈니스 로직에서 사용, 부가 기능 :사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다
• @Repository : 스프링 데이터 접근 계층에서 사용, 부가 기능 :스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration : 스프링 설정 정보에서 사용, 부가 기능 :스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
  

참고 : useDefaultFilters - 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.

 

필터

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

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

 

예제

package hello.core.scan.filter;

import java.lang.annotation.*;

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

package hello.core.scan.filter;

import java.lang.annotation.*;

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

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

package hello.core.scan.filter;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
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.assertThat;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

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

• includeFilters 에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilters 에 MyExcludeComponent 애노테이션을 추가해서 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 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.>  특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

 

 

 

중복 등록과 충돌

두 가지 상황 존재

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

자동 빈 등록 vs 자동 빈 등록

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

-> ConflictingBeanDefinitionException 예외 발생

 

 

수동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록시 로그가 남음

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

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

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