[Spring Boot] 컴포넌트 스캔

• 스프링 빈을 등록할 때는 @Bean이나 XML의 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
• 하지만, 등록해야 할 스프링 빈이 많아지면 설정 정보도 커지고, 누락하는 문제도 발행한다.
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 또 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

@ComponentScan

AutoAppConfig.java

@Configuration  // 싱글톤 유지
@ComponentScan
public class AutoAppConfig {
 
}

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

@Component

@Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

---

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

@Component, @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

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

• @Autowired는 의존관계를 자동으로 주입해준다.
• AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.
• 여기서는 설정 정보로 AutoAppConfig 클래스를 넘겨준다.

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

@ComponentScan

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

@Autowired 의존관계 자동 주입

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

탐색 위치와 기본 스캔 대상

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

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

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

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

권장하는 방법

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것.
• ex)
  • com.hello
  • com.hello.service
  • com.hello.repository
  • com.hello -> 여기에 AppConfig같은 메인 설정 정보를 둔 뒤 @ComponentScan을 붙이고, basePackages지정은 생략
  • 이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

[참고]
스프링 부트의 대표 시작 정보인 @SpringBootApplicaion을 프로젝트 시작 루트 위치에 두는 것이 관례.(이 설정 안에 @ComponentScan이 들어있다.)

컴포넌트 스캔 기본 대상

• @Component: 컴포넌트 스캔에서 사용
• @Controller: 스프링 MVC 컨트롤러에서 사용
• @Service: 스프링 비즈니스 로직에서 사용
• @Repository: 스프링 데이터 접근 계층에서 사용
• @Configuration: 스프링 설정 정보에서 사용

애노테이션의 부가 기능

• @Controller: 스프링 MVC 컨트롤러로 인식
• @Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 해준다.
• @Service: 개발자들이 비즈니스 계층을 인식하는데 도움이 된다.

필터

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

• excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정

• 컴포넌트 스캔 대상에 추가할 클래스 : @MyIncludeComponent적용
• 컴포넌트 스캔 대상에서 제외할 클래스 : @MyExcludeComponent적용

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

FilterType 옵션

• ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
  • ex) org.example.SomeAnnotation
• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ex) org.example.SomeClass

[참고] @Component면 충분하기 때문에 includeFilters를 사용할 일은 거의 없다. excludeFilters는 여러 이유로 간혹 사용할 때가 있지만 많지는 않다.

중복 등록과 충돌

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

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

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

<출처 : 인프런 - 스프링 핵심 원리 기본편(김영한)>