컴포넌트 스캔

최주영·2024년 3월 15일
0

스프링 핵심 원리

목록 보기
6/9
post-custom-banner

스프링 빈을 등록할 때
자바코드의 @Bean 이나 XML의 <bea> 으로 직접 스프링 빈을 등록하였다

하지만 이러한 것들이 쌓이면 귀찮고, 누락 시키는 경우가 발생한다. 그래서

스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 이라는 기능을 제공
추가로 의존관계도 자동으로 주입하는 @Autowired 기능도 제공


@Component

  • @ComponentScan이 실행되서 빈으로 등록하기 전 스캔의 대상이 되게 하는 어노테이션

@Autowired

  • 의존 관계를 자동으로 주입해줌 (여러 의존관계도 한번에 가능)

ex)

// MemoryMemberRepository
@Component
public class MemoryMemberRepository implements MemberRepository {

}
// MemberServiceImpl
@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}
// OrderServiceImpl
@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;
    }

이전에는 AppConfig 클래스에서 @Bean 을 직접 설정해서 등록하고, 의존 관계도 직접 명시했지만
위 코드들을 보면 @Component 로 빈 등록 후, @Autowired로 의존관계를 주입해준다

ComponentScan

  • @Component 가 붙은 모든 클래스를 스프링 빈으로 등록
  • 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록됨
    -> @Configuration 안에도 @Component가 붙어있기 때문에
  • 빈 이름은 기본적으로 클래스명에서 맨 앞글자만 소문자로 바뀐 상태로 지정된다
  • 스프링 빈의 이름을 직접 지정 가능 ex) @Component("memberService2")
  • 싱글톤으로 저장됨
  • 생성자에 @Autowired 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
  • 기본 조회 전략은 타입이 같은 빈을 찾아서 주입
  • getBean(MemberRepository.class) 와 비슷함
  • 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입

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

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

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

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

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

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

  • com.hello
  • com.hello.serivce
  • com.hello.repository

com.hello -> 프로젝트 시작 루트, 여기에 이전 강의에서 작성했던 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에
프로젝트 시작 루트 위치에 두는 것이 좋다고 생각한다.

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


✅ 필터

  • includeFilters : 컴포넌트 스캔 대상을 추가로 지정
  • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정
    @Configuration
    @ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )

✅ 빈 이름 중복 등록과 충돌

2가지 상황 이 존재함

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

  • 수동 빈 등록이 우선권을 가짐 (수동 빈이 자동 빈을 오버라이딩 해버린다)
profile
우측 상단 햇님모양 클릭하셔서 무조건 야간모드로 봐주세요!!
post-custom-banner

0개의 댓글