🧑🏻‍💻컴포넌트 스캔(@ComponentScan)

앞서 스프링 빈을 등록할 때 @Bean 애노테이션을 붙여 설정정보에 직접 등록할 스프링 빈을 나열했다.
그런데 큰 프로젝트에서는 등록해야 할 빈이 수십, 수백개가 될수 도 있다. 누락할 수도 있다...😱

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

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

다음코드를 보자!

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...)에서 @Configuration이 붙어 있기 때문에 excludeFilters를 통해 제외했다.

📝컴포넌트 스캔은 @Component애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.❗️

각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component를 붙였다.

@Component
  public class MemoryMemberRepository implements MemberRepository {}

@Component
  public class RateDiscountPolicy implements DiscountPolicy {}

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

@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를 사용한 이유는 이전에 AppConfig에서는 의존관계도 직접 명시했지만 컴포넌트 스캔으로 바꾸면서 설정 정보가 없기 때문에 의존관계 주입도 각 클래스 안에서 해결해야 했기 때문에 의존관계가 필요한 곳에서는 사용했다.

package hello.core.scan;

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

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

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

11:00:09.472 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/leesangjun/Desktop/스프링/core/out/production/classes/hello/core/discount/RateDiscountPolicy.class]
11:00:09.473 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/leesangjun/Desktop/스프링/core/out/production/classes/hello/core/member/MemberServiceImpl.class]
11:00:09.474 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/leesangjun/Desktop/스프링/core/out/production/classes/hello/core/member/MemoryMemberRepository.class]
11:00:09.475 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/leesangjun/Desktop/스프링/core/out/production/classes/hello/core/order/OrderServiceImpl.class]

⬆️ 위에 AutoAppConfigTest의 로그를 보면 스캔이 정상적으로 동작한 것을 볼수 있다.😲👏🏻👏🏻

그림을 통해 동작 과정을 알아보자!

1. @Component Scan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다. 이때 스프링 빈의 기본 이름은 클래스명이긴 하지만 맨 앞글자는 소문자로 등록된다.
   

2. 생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입해준다.
   getBean(MemberRepository.class)와 동일하다고 보면 된다.
   
   생성자에 파라미터가 많아도 다음과 같이 다 찾아서 주입해준다.
   
   
   
   

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

예를들어 프로젝트 구조가 다음과 같다면

• com.hello
• com.hello.service
• com.hello.repositroy

com.hello가 프로젝트 시작 루트이기 때문에 보통 AppConfig같은 메인 설정 정보를 두고, @ComponentScan애노테이션을 붙인다.

이렇게 하면 com.hello를 포함한 하위 패키지들은 모두 자동으로 컴포넌트 스캔의 대상이 된다 보통은 이런 룰을 따른다.

🧑🏻‍💻중복 등록과 충돌😱❗️

컴포넌트 스캔에서 같은 빈 이름을 등록하면 충돌이 발생한다.
위에서 보았듯 컴포넌트 스캔으로 자동으로 스프링 빈을 등록하는 방법이 있고 수동으로 스프링 빈을 등록하는 방법이 있다.

충돌은 2가지 경우로 날 수 있다. 자동 빈 등록과 자동 빈 등록
그리고 수동 빈 등록과 자동 빈 등록에서 날 수 있다.


자동 빈 등록과 자동 빈 등록의 경우에서는 스프링은 오류를 발생시킨다. ConflictingBeanDefinitionException 예외가 발생하는 것이다.

수동 빈 등록과 자동 빈 등록의 경우에서는 수동 빈 등록이 우선권을 갖는다. 정확하게 이야기하면 수동 빈이 자동 빈을 오버라이딩 해버린다...

보통 실무에서 개발자가 의도적으로 설정해서 이런 결과가 나오진 않고 여러 설정이 꼬여서 이런 결과가 나온다고 한다😵‍💫
잡기 정말 어려운 버그가 되는 것이다😮‍💨...

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard