[Spring] 컴포넌트 스캔

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

스프링 컨테이너와 스프링 빈에서는 스프링 빈을 등록할 때 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열해야 했다. 이렇게 등록해야 할 스프링 빈이 수십 수백개가 되면 일일이 등록하기도 귀찮고 설정 정보도 커지고 누락하는 문제도 발생한다.

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

@Configuration
@ComponentScan
public class AutoAppConfig {
}

@Component
public class MemberServiceImpl implements MemberService {
	
    private final MemberRepository memberRepository;
    
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
    	this.memberRepository = memberRepository;
    }
}

1. @ComponentScan

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다. 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

• 빈 이름 기본 전략: MemberServiceImpl 클래스 → memberServiceImpl
• 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

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

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

• getBean(MemberRepository.class)와 동일하다고 이해하면 된다.

탐색 위치와 기본 스캔 대상

탐색 시작 위치 지정

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

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

• basePackages
• basePackageClasses
• 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
  • 보통 위치를 직접 지정하지 않고 설정 정보 클래스의 위치를 프로젝트 최상단에 둔다. 스프링 부트도 이 방법을 기본으로 제공한다.

기본 스캔 대상

컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.

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

실제 해당 클래스의 소스 코드를 보면 다음과 같이 @ComponentScan을 포함하고 있다.

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Repository {
}

@Component
public @interface Configuration {
}

참고: 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

컴포넌트 스캔의 용도뿐만 아니라 다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.

• @Configuration: 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
• @Controller: 스프링 MVC 컨트롤러로 인식한다.
• @Service: @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나라고 비즈니스 계층을 인식하는 데 도움이 된다.
• @Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해 준다.

필터

다음 옵션들을 @ComponentScan에 적용하여 필터를 적용할 수 있다.

• includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.

중복 등록과 충돌

자동 빈 등록 vs. 자동 빈 등록

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

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

이 경우 수동 빈이 자동 빈을 오버라이딩 해버려 수동 빈 등록이 우선권을 가진다. 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분인데 그러면 정말 잡기 어려운 버그가 만들어진다. 그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

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