[Spring]스프링 핵심 원리 - 컴포넌트

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

• 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>을 사용하였다. 
• 실무에서는 수많은 빈이 있어 등록에 문제가 있다.
• 그래서 스프링은 설정 정보 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공한다. 

@Configuration
@ComponentScan(
	//기존 예제 코드를 유지하기 위해 필터
    excludeFilters  = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class))
public class AutoAppConfig {
}

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

또한 excludeFilters는 AppConfig 같은 설정 정보는  이미 @Bean으로 등록하기 때문에 제외해 주는 것이다. 

실무에서는 그냥 전체 컴포넌트 스캔을 돌린다. 

 

@ComponentScan은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈에 등록한다. 
@Configuration은 @Component가 붙어있어 스캔의 대상이 된다. 

 

 

@Autowired

@Component
public class OrderServiceImpl implements OrderService{
  private final MemberRepository memberRepository;
  private final DiscountPolicy discountPoilcy;
  @Autowired
  public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPoilcy) {
    this.memberRepository = memberRepository;
    this.discountPoilcy = discountPoilcy;
  }

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

 

• 컴포넌트 스캔 시에 기존에 했던 AppConfig와 다르게 의존 관계 주입을 하지 못한다. 
  • 컴포넌트 스캔은 단지 빈에만 등록하는 것이기 때문이다. 
• 그래서 상속 받는 생성자에 @Autowired 애노테이션을 통해 따로 의존관계를 주입해주어야 한다. 

 

컴포넌트 스캔 과정

1. 컴포넌트 스캔

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이때 스프링 빈의 이름은 클래스 명을 사용하지만 앞글자만 소문자로 대체한다.
  • 빈 이름을 지정할 수 있다. 
    • @Component("지정할 이름")

2. 의존관계 자동 주입 

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. 
• 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다. 
  • @getBean(MemberRepository.class) 와 동일 

 

 

📝탐색 기본 위치와 기본 스캔 대상 

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 매우 오래걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 조정 가능하다. 

@ComponentScan(
//패키지 시작 위치 지정
 basePackages = "hello.core",
}

•  basePackages : 탐색할 패키지의 시작 위치를 지정, 해당 패키지의 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core" , "hello.service"} 다중 지정도 가능하다. 
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다. 

위 사진에서 @ComponentScan은 AutoAppConfig에 있다. 

• 아무것도 지정하지 않으면 AutoAppConfig의 패키지와 모든 하위 패키지를 스캔한다. 
  • 즉 AutoAppConfig는 최상위 패키지에 있으므로 전부 스캔한다.
• basePackages = {"com.example.basics.basics.discount"}로 지정하면 discount의 모든 클래스를 스캔한다.
• basePackageClasses = {"OrderSerivceImpl"}로 지정하면 OrderServiceImpl이 있는 order 패키지를 스캔하게 된다.

 

🚩권장 방법

설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다. 

@SpringBootApplication 는 스프링 부트의 대표 시작 정보이다. 이 설정 안에도 @ComponentScan이 들어있다.

 

컴포넌트 스캔 기본 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controller  : 스프링 MVC 컨트롤러 인식 
• @Service : 스프링 비즈니스 로직 구현에서 사용
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 반환
• @Configuration : 스프링 설정 정보를 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리 

 

📝필터

public class ComponentFilterAppConfigTest {
  @Test
  void filterScan(){
    ApplicationContext ac = new
        AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
    BeanA beanA = ac.getBean("beanA", BeanA.class);
    org.assertj.core.api.Assertions.assertThat(beanA).isNotNull();
    Assertions.assertThrows(
        NoSuchBeanDefinitionException.class,
        () -> ac.getBean("beanB", BeanB.class));
  }
  @Configuration
  @ComponentScan(
      includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes =
          MyIncludeComponent.class),
      excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes =
          MyExcludeComponent.class)
  )
  static class ComponentFilterAppConfig {
  }
}

• includeFilters에 MyIncludeComponent 애노테이션을 추가하여 BeanA가 스프링 빈에 등록된다
• excludeFilters에 MyExcludeComponent 애노테이션을 추가하여 BeanB는 스프링 빈에 등록되지 않는다. 

 

참고로 최근 스프링 부트는 컴포넌트 스캔을 기본적으로 제공하여, 개인적으로 옵션을 변경하면서 사용하기보다 스프링 기본설정에 맞춰 사용하는 것이 권장된다. 

 

 

📝중복 등록과 충돌 

빈은 같은 이름이 등록되면 안된다. 그러나 컴포넌트 스캔에서 같은 빈이 등록되면 어떻게 될까?

• 자동 빈 등록이 되고 자동 빈 등록이 한번 더 되는 경우 
  • 이름이 같을 경우 오류를 발생 시킨다. ConflictingBeanDefinitionException
• 수동 빈 등록과 자동 빈 등록이 되는 경우 
  • 이 경우에는 수동 빈 등록이 우선권을 가지며 자동 빈을 오버라이딩 해버린다. 
  • 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

 

 

 

 

 

✔정리

• 스프링은 자동 빈 등록인 @ComponentScan을 지원한다. 또한 @Autowired를 통해 의존 관계도 주입하게 된다. 
• 스프링 실행 때 모든 곳을 스캔하면 오래 걸리기 때문에 @ComponentScan은 탐색 위치를 지정할 수 있다. 
  •  basePackages //지정 패키지와 하위 패키지 모두
  •  basePackageClasses  //지정한 클래스가 있는 패키지와 그의 하위 패키지 모두 
• 컴포넌트 스캔을 하는 필터를 지정할 수 있다. 
  • includeFilters : 포함 지정
  • excludeFilters : 제외 지정
• 스프링 빈의 이름 중복은 현재는 어느 경우에도 오류를 발생시키며 이름이 중복되자 않게 주의가 필요하다.