[Spring Boot][2] 6. 컴포넌트 스캔

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

역시 대단한 우리의 스프링은, 설정 정보 업시도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다👍🏻 이에 대해 알아보자 ❗️

✔️ AutoAppConfig.java 생성

package hello.core;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.springframework.context.annotation.ComponentScan.*;

// 설정정보이기 때문에 @Configuration 필요
@Configuration

// 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 됨
// @Component 라는 애노테이션이 붙은 클래스를 찾아 자동으로 스프링 빈에 등록해줌
@ComponentScan(
        // 제외할 필터 적용 : @Configuration 을 일단 제외(예제를 안전히 유지하기 위해서)
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))
public class AutoAppConfig {
}

📌 참고 : 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.
(보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다!)

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다 !

📌 참고 : @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다!

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여 수정해준다!
정리하는 데 시간이 넘 오래 걸려서 이제부터 코드는 최소한만 첨부하겠습니다😂

MemoryMemberRepository, RateDiscountPolicy, MemberServiceImpl, OrderServiceImpl 파일들에 @Component를 붙여 수정해줌!!

📌 MemberServiceImpl.java
⬆️ 이 전에는 AppConfig에서 @Bean 으로 설정정보를 작성하고 의존관계를 주입해줬는데 이제는 이런 설정정봊 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다!
@Autowired는 의존관계를 자동으로 주입해준다!

✔️ test/../scan/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() {
        // AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일
        // 대신 설정정보를 AutoAppConfig 로 설정
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        // 멤버 서비스 조회
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

⬆️ 실행해보면 기존과 같이 잘 동작하는 것을 확인 👍🏻

❗️ 컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자 ❗️

1️⃣ @ComponentScan

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

2️⃣ @Autowired 의존관계 자동 주입

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

---

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

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리므로 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다 !!
⬆️ 요렇게 !

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

💡권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것 ❗️
지금 우리 프로젝트의 경우라면, hello.core 여기에 AppConfig 파일을 생성한 후 @ComponentScan 애노테이션을 붙이는 것 !

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

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

• @Component : 컴포넌트 스캔에서 사용
• @Controlller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용

📌 참고 : 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다!

---

🏷 필터

⬆️ test 밑에 위와 같이 패키지, 클래스, 애노테이션 파일을 만든다

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

BeanA에 @IncludeFilters 애노테이션을 붙이고,
BeanB에 @ExcludeFilters 애노테이션을 붙여 코드를 완성한다!

✔️ ComponentFilterAppConfigTest.java

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.Filter;

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가 스프링 빈에 등록되지 않는다

---

🏷 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까🤔❓
두 가지 상황이 있다

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

1️⃣ 자동 빈 등록 vs 자동 빈 등록

간단히 MemberServiceImpl와 OrderServiceImpl 코드의 @Component 부분을 @Component("service") 로 바꿔서 테스트 해본 결과,

ConflictingBeanDefinitionException 라는 예외가 발생한다❗️
➡️ 스프링 빈 이름이 같아서 생기는 오류

보통 자동 빈 등록끼리 충돌 나는 일은 거의 없다고 봐도 됨!

1️⃣ 수동 빈 등록 vs 자동 빈 등록

이전에 우리가 MemoryMemberRepository 에 컴포넌트 등록을 했는데 이걸 똑같은 이름을 사용해 AutoAppConfig에 등록해보자면 어떻게 될까❓

✔️ AutoAppConfig.java 수정

.
.
@Bean(name = "memoryMemberRepository")
         public MemberRepository memberRepository() {
             return new MemoryMemberRepository();
         }
.
.

테스트를 진행해보면,

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

라는 로그가 뜨는데, 이는 수동 빈이 자동 빈을 오버라이딩 했다는 뜻!

💡 즉, 이런 경우 수동 빈이 우선권을 가지게 된다!

여기서 한번 더 대단한 스프링.......🤭❗️❗️
최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생해 튕겨버리도록 기본 값을 바꾸었다....!!!!

스프링 부트의 CoreApplication을 실행해보면 실제로,

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

⬆️ 이런 오류를 볼 수 있다!

---

스프링 너도 자러가라 이제.