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

본 내용은 인프런 김영한T 스프링 핵심원리 - 기본편 강의를 정리한 내용입니다:)

 

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

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

지금까지 스프링 빈 등록은 @Bean을 이용했다. 근데 만약 수백개면 언제 일일히 등록할까...OTL 그래서 나온게 컴포넌트 스캔!

💚 컴포넌트 스캔

• 설정 정보가 없어도 자동으로 스프링 빈을 등록한다.
• 의존관계를 자동주입하는 @Autowired라는 기능도 제공한다.
• 컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 붙여주면 된다.

AppConfig.java는 남겨두고 새로운 AutoAppConfig.java를 만들자.

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

📌참고: 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilters 를 이용해서 이전 설정정보는 컴포넌트 스캔 대상에서 제외했다.

이어서, 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여준다.

( MemoryMemberRepository, RateDiscountPolicy,MemberServiceImpl 에 붙여준다.)

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

 

이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이런 설정 정보 자체가 없다.그래서 의존관계 주입도 이 클래스 안에서 해결해야 한다. @Autowired 는 의존관계를 자동으로 주입해준다.

@Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.

 

이어서 AutoAppConfig 동작 테스트를 해보면, 기존과 같이 잘 동작한다.

public class AutoAppConfigTest {
    @Test
    void basicScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(
                AutoAppConfig.class); // AppConfig 대신 AutoConfig를 넘겨준다.

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

ClassPathBeanDefinitionScanner - Identified candidate component class: .. RateDiscountPolicy.class .. MemberServiceImpl.class .. MemoryMemberRepository.class .. OrderServiceImpl.class

 

💚 컴포넌트 스캔 동작 원리

• @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 빈 이름 기본 전략: 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
• 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

💚 @Autowired 의존관계 자동 주입

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

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

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 아래처럼 꼭 필요한 위치부터 탐색하도록 시작
위치를 지정할 수 있다.

• 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

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

 

💚 권장방법

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장한다. 최근 스프링 부트도 이 방법을 기본으로 제공한다. 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다!)

 

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

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

해당 클래스의 소스 코드를 보면 @Component 를 포함하고 있다.

@Component
public @interface Controller {
}

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

 

💚 애노테이션 부가 기능  

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

 

 

⬛ 필터

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

간단한 테스트를 해보자. 먼저 테스트를 위해 컴포넌트 스캔 대상에 추가할 애노테이션과 제외할 애노테이션을 만들어준다.

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}
// 다른 파일..
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

그리고 컴포넌트 스캔 대상에 추가할 클래스와, 제외할 클래스를 만들어준다. 한쪽엔 Include 컴포넌트를 적용하고, 다른 한쪽엔 Exclude 컴포넌트를 적용한다.

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}
// 다른 파일..
package hello.core.scan.filter;
@MyExcludeComponent
public class BeanB {
}

 

이제 ComponentFilterAppConfig를 새로 만들어 적용해, 테스트를 진행해보자.

public class ComponentFilterAppConfigTest {
    @Test
    void filterScan() {
        AnnotationConfigApplicationContext 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

만약 위 테스트 예시에서 BeanA도 빼고싶으면 아래와 같이 추가하면 된다.

 excludeFilters = {
 @Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class),
 @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
 }

📌참고: @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다. > 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다

💥 중복 등록과 충돌

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

💚 자동 빈 등록 vs 자동 빈 등록

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

 

💚 수동 빈 등록 vs 자동 빈 등록

수동 빈이 자동 빈을 오버라이딩 해버린다. AutoAppConfig에 같은 빈을 등록하고 이전에만든 AutoAppConfigTest를 실행해보자.

@Configuration
@ComponentScan(
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =Configuration.class)
)
public class AutoAppConfig {
 @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