Spring - 컴포넌트 스캔

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

 

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

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

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
        // 예제 코드를 살리기 위해 Configuration를 설정하면 빈이 전부 등록되기 때문에 임시로 제외한다.
)
public class AutoAppConfig {
   }
}

- @ComponentScan을 설정 정보에 붙여주면 된다.

- 기존의 방식과 다르게 @Bean으로 등록한 클래스가 하나도 없다.

- ComponentScan은 이름 그대로 @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 // 자동으로 의존성을 주입해준다. (ac.getBean(MemberRepository.class) 한 것과 유사하다.
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
       
--------------------------

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    //    private final DiscountPolicy discountPolicy = new FixDiscountPolicy();
    //    private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

- 위와 같이 @Component를 붙여주고, @Autowired를 통해 생성자의 의존성을 주입해준다.

public class AutoAppConfigTest {

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

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

- Test 코드를 통해 현재 빈에 등록된 객체가 무엇이 있는지 확인해본다.

- 출력 결과 위와 같이 설정한 객체들이 출력되는 것을 볼 수 있다.

---

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

- @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.

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

- 빈 이름을 직접 지정하고 싶다면 @Component("사용하고 싶은 이름")을 부여하면 된다.

- 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

- 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

- 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

---

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

 

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

- 위와 같이 탐색 범위를 지정할 수 있는데 

- 범위를 지정하게 될 경우 위와 같이 해당 범위의 @Component 어노테이션이 붙은 클래스만 찾는다.

 

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

1. @Component : 컴포넌트 스캔에서 사용

2. @Controlller : 스프링 MVC 컨트롤러에서 사용 : 스프링 MVC 컨트롤러로 인식

3. @Service : 스프링 비즈니스 로직에서 사용

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

5. @Configuration : 스프링 설정 정보에서 사용 : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

---

- 필터

 

- 임시로 2개의 어노테이션을 생성하였다고 가정한다. MyIncludeComponent, MyExcludeComponent

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

- 각 어노테이션에 클래스를 하나씩 생성해준다.

 

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext 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 {
    }
}

1. includeFilters 에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.

2. excludeFilters 에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

---

- 중복 등록과 충돌

 

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

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

 

- 자동 빈 등록 vs 자동 빈 등록

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

2. ConflictingBeanDefinitionException 예외 발생

 

- 수동 빈 등록 vs 자동 빈 등록

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

 

 

 

 

 

 

 

 

 

 

 

출처 : 인프런 - 우아한 형제들 기술이사 김영한의 스프링 완전 정복 (스프링 핵심원리 - 기본 편)