컴포넌트 스캔 (Component Scan)

1. Component Scanning

설정 정보(AppConfig.class)가 없어도 자동으로 스프링 빈을 등록하는 기능

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

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

• Component Scan을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다. 
• @Bean으로 등록한 클래스가 없다.
• Component Scan을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 빈으로 등록되기 때문에 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행된다. 그래서 excludeFilters를 이용해서 다른 설정 정보는 컴포넌트 스캔 대상에서 제외

각 클래스가 ComponentScan 대상이 되도록 @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를 사용해서 의존관계를 자동으로 주입해준다.

 

2. ComponentScan과 자동 의존관계 주입 동작과정

(1) @ComponentScan

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

 

(2) @Autowired 의존관계 자동 주입

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

 

3. ComponentScan의 추가 기능

(1) 탐색 위치와 기본 스캔 대상

• 모든 자바 클래스를 다 ComponentScan을 하면 시간이 오래 걸린다. 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

@ComponentScan(
	basePackages = {"hello.core", "hello.service"}
)

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

권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 프로젝트 시작 루트 위치에 두는 것이 관례이다.
@SpringBootApplication 안에 @ComponentScan이 들어있다.

 

(2) ComponentScan 기본 대상

• ComponentScan은 @Component 뿐만 아니라 추가 대상이 있다.
  • @Component : ComponentScan에서 사용
  • @Controller : 스프링 MVC 컨트롤러에서 사용
  • @Service : 스프링 비즈니스 로직에서 사용
  • @Repository : 스프링 데이터 접근 계층에서 사용
  • @Configuration : 스프링 설정 정보에서 사용
• ComponentScan의 용도뿐만 아니라 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.
  • @Controller : 스프링 MVC 컨트롤러로 인식
  • @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration : 스프링 설정 정보를 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
  • @Service : 특별한 처리는 없지만 개발자들이 핵심 비즈니스 계층을 인식하는데 도움이 된다.

 

(3) Filters (필터)

• includeFilters : ComponentScan 대상을 추가로 지정한다.
• excludeFilters : ComponentScan에서 제외할 대상을 지정한다.

 

• 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

 

4. 빈 중복 등록과 충돌

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

• ComponentScan에 의해 자동으로 스프링 빈이 등록되는데, 이름이 같은 경우 스프링은 오류 발생
  • ConflictingBeanDefinitionException 예외 발생

 

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

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

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing
수동 빈 등록시 어버라이딩 했다고 로그가 남는다.

• 최근 스프링 부트에서 수동 빈 등록과 자동 빈 등록이 충돌 나면 오류가 발생하도록 기본값(default)으로 바뀌었다.

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

• application properties 설정을 바꿔주면 오버라이딩 가능하게 만들어 줄 수 있다.

spring.main.allow-bean-definition-overriding=true => 수동 빈 VS 자동 빈 충돌 나도 에러 X
spring.main.allow-bean-definition-overriding=false => Default 값 , 충돌시 에러 발생

---

본 글은 김영한 님의 "스프링 핵심 원리"(인프런) 유료 강의를 들으며 요약, 정리하고 일부 정보를 추가 작성한 것입니다.