[스프링 핵심 원리 - 기본편] #6. 컴포넌트 스캔

[chaelink]

섹션 6. 컴포넌트 스캔

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

등록해야 하는 빈이 수십 수백개가 된다면 일일이 등록하기가 힘들어 진다.

• 컴포넌트 스캔 : 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 스프링 기능

• @Autowired : 의존관계 자동 주입

AutoAppConfig

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

• 컴포넌트 스캔을 사용하려면 @ComponentScan 을 설정 정보에 붙여주면 된다
• 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다

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

컴포넌트 스캔은 이름 그대로 @component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다
각 클래스에 @component 애노테이션을 붙여주자

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

 @Autowired
 public MemberServiceImpl(MemberRepository memberRepository) {
     this.memberRepository = memberRepository;
    }
}

public class AutoAppConfigTest {

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

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

• 기존과 동일하게 AnnotationConfigApplicationContext 사용
• 설정 정보로 AutoAppConfig 전달

• @componentscan 은 @component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
• 빈 이름 기본 전략 : MemberServiceImpl 클래스 memberServiceImpl
• 빈 이름 직접 지정 :@component("memberService2") 방식 사용

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

2. 탐색 위치와 기본 스캔 대상

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

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

권장하는 방법

패키지 위치를 지정하지 말고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 방법
예를 들어, 아래 같은 프로젝트 구조일때

1. 프로젝트 시작 루트인 com.hello에 AppConfig 같은 메인 설정 정보를 둔다.
2. @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.
3. 이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
4. • 스프링 부트를 사용하면 @SpringBootApplication 을 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

컴포넌트 스캔 기본 대상

• @component : 컴포넌트 스캔에서 사용
• @controlller : 스프링 MVC 컨트롤러에서 사용, 컨트롤러로 인식
• @service : 스프링 비즈니스 로직에서 사용, 특별한 처리는 하지 않지만 개발자들이 여기에 핵심 비즈니스 로직이 있음을 인식하는데 도움을 줌
• @repository : 스프링 데이터 접근 계층에서 사용, 데이터 계층의 예외를 스프링 예외로 변환해준다
• @configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리

소스코드를 보면 @component를 포함하고 있다

애노테이션에는 상속 관계가 없으므로 애노테이션이 특정 애노테이션을 들고 있는 것을 확인할 수 있는 건 스프링이 지원하는 기능이다

3. 필터

includeFilters
컴포넌트 스캔 대상을 추가로 지정

excludeFilters
컴포넌트 스캔 제외 대상 지정

컴포넌트 스캔 대상에 추가할 클래스

@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();
        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 {
    }
}

@ComponentScan
( includeFilters = @Filter(type = FilterType.ANNOTATION, classes =MyIncludeComponent.class),
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =MyExcludeComponent.class))

FilterType
5가지 옵션

• 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

4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면?

1) 자동 빈 등록 vs 자동 빈 등록

스프링이 오류를 발생시킨다
ConflictingBeanDefinitionException 예외 발생

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

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

최근 스프링 부트는 수동 빈과 자동 빈이 충돌하면 오류가 나도록 설정

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