컴포넌트 스캔

 

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

스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다

이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀 찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다

 

아래 코드처럼 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.

@Configuration
//@ComponentScan: 스프링 빈을 다 끌어다가 자동으로 스프링 빈으로 끌어올리는..
@ComponentScan(
        //스프링 빈 등록에서 제외할 것
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)

public class AutoAppConfig {}

컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록된다.

 

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

클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주자.

이전에 등록한 빈이 MemberServiceImpl, OrderServiceImpl, MemoryMemberRepository, RateDiscountPolicy이므로 해당 클래스에 @Component를 붙여준다.

 

AppConfig에서 @Bean으로 직접 등록할 때는 의존관계도 직접 명시했는데 이제는 클래스 안에서 해결해야 한다.

→  의존관계 주입이 필요한 클래스에 @Autowired 활용해서 의존관계를 자동으로 주입한다.

 

OrderServiceImpl에서 @Autowired 추가

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

 

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

1. @ComponentScan

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

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

 

빈 이름 직접 지정:
만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

 

2. @Autowired 의존관계 자동 주입

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

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

위 사진에서는 MemberRepository에 MemberRepository의 구현체인 memmoryMemberRepository를 주입했다

 

탐색 위치와 기본 스캔 대상

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

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

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

basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

• basePackages로 여러 시작 위치를 지정할 수 있다. ( basePackages = {"hello.core", "hello.service"} )

basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

 

만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상 단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

 

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다)

 

컴포넌트 스캔 기본 대상

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

@Controller : 스프링 MVC 컨트롤러에서 사용

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

@Repository : 스프링 데이터 접근 계층에서 사용

@Configuration : 스프링 설정 정보에서 사용

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하는 2가지 상황

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

 

자동 빈 등록 vs 자동 빈 등록

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

 

수동 빈 등록 vs 자동 빈 등록

이 경우 수동 빈 등록이 우선권을 가진다.

이 경우 개발자가 의도적으로 수동빈을 등록하려고 했다면 문제가 없지만 여러 설절이 꼬여서 원치않게 수동 빈이 등록되는 경우가 발생하면 정말 잡기 어려운 버그이다.

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

스프링 부트인 CoreApplication을 실행하면 나오는 오류