7. 컴포넌트 스캔

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

  • 컴포넌트 스캔은 @Component 가 붙은 클래스를 스캔해서 스프링 빈으로 등록해준다.
  • (1) @ComponentScan
    • @ComponentScan@Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
    • 이때 스프링 빈의 기본이름은 클래스 명을 사용하되 맨 앞 글자만 소문자를 사용한다.
      • ex) MemberServiceImpl.class → memberServiceImpl
      • 빈이름을 직접 지정 : ex) @Component(”memberService2”)
  • (2) @Autowired 의존관계 자동 주입
    • 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입해준다.
    • == getBean(MemberRepository.class)와 동일하다고 생각하면 된다.

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

  1. 탐색할 패키지의 시작 위치 지정
@ComponentScan(
          basePackages = "hello.core",
}
  • basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해 하위 패키지를 모두 탐색한다.
    • basePackages = {"hello.core", "hello.service"} : 이렇게 여러 시작 위치를 지정 가능
  • basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정
  • 지정하지 않으면, @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
  • 권장하는 방법 : 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
    • 스프링 부트도 이 방법을 기본으로 제공한다.
    • @SpringBootApplication (스프링부트의 대표 시작 정보)을 이 프로젝트의 시작 루트 위치에 두는 것이 관례이다. 이 설정 안에 @ComponentScan 이 들어있다.
  1. 컴포넌트 스캔 기본 대상

컴포넌트 스캔의 대상

  • @Component : 컴포넌트 스캔에서 사용
  • @Controlller : 스프링 MVC 컨트롤러에서 사용
  • @Service : 스프링 비즈니스 로직에서 사용
  • @Repository : 스프링 데이터 접근 계층에서 사용
  • @Configuration : 스프링 설정 정보에서 사용
  1. 필터
    • includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
    • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
  2. 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

3. 중복 등록과 충돌

  1. 자동 빈 등록 vs 자동 빈 등록
    • 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
    • ex) @Component(”nameA”) 가 또 있을 경우
    • ConflictingBeanDefinitionException 예외 발생
  2. 수동 빈 등록 vs 자동 빈 등록
@Component //memoryMemberRepository
public class MemoryMemberRepository implements MemberRepository {}
@Configuration
  @ComponentScan(
          excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
  Configuration.class)
  )
  public class AutoAppConfig {
      @Bean(name = "memoryMemberRepository")
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
      }
}

이 경우 수동 빈 등록이 우선권을 가진다. (아래 꺼)

(수동 빈이 자동 빈을 오버라이딩 해버린다. but!!! 스프링 부트는 오류가 발생하도록 해준다.)

//spring - error message
Overriding bean definition for bean 'memoryMemberRepository' with a different
  definition: replacing
//spring boot - error message
Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true

본 포스팅은 김영한 선생님의 강의를 보고 정리한 글입니다.

Comments