[작성일: 2023. 08. 10]
컴포넌트 스캔
컴포넌트 스캔과 의존관계 자동 주입
등록해야 할 스프링 빈이 많아지면 등록하기 힘들어지고 누락하는 문제도 발생한다. 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈으로 등록하는 컴포넌트 스캔 기능을 제공한다. 의존관계도 자동으로 주입하는 @Autowired 기능도 제공한다.
컴포넌트 스캔을 사용하려면 @ComponentScan을 작성해 주면 된다. 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.
컴포넌트 스캔은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.
@Configuration
@ComponentScan(
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
/*
컴포넌트 스캔을 사용하면 앞서 만든 AppConfig나 TestConfig 등이 함께 등록되고 실행되어버린다.
excludeFilters를 이용해 설정정보는 컴포넌트 스캔 대상에서 제외한다.
기보통은 설정 정보를 제외하지 않지만 기존 예제 코드를 남기기 위해 사용했다.
*/
)
public class AutoAppConfig {
}
@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다. 이때 스프링 빈의 기본 이름은 클래스 명을 사용하되, 맨 앞글자만 소문자를 사용한다.
- 빈 이름 기본 전략: MemberServiceImpl 클래스 -> memberServiceImpl
- 빈 이름 직접 지정: @Component("memberService2")
생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입하고, getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
생성자에 파라미터가 많아도 알아서 찾아 주입한다.
컴포넌트 스캔 탐색 위치
@ComponentScan(
basePackages = "hello.core.member", // 어디서부터 찾을지 지정 가능
basePackageClasses = AutoAppConfig.class, // 지정한 클래스의 패키지를 탐색 시작 위치로 지정 가능
)
모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리기 때문에 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.
basePackages = {"hello.core", "hello.service"} 처럼 여러 시작 위치를 지정할 수도 있다. basePackageClasses를 사용해서 지정한 클래스의 패키지를 탐색 시작 위치로 지정할 수도 있다. 만약에 아무것도 지정하지 않는다면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
제일 권장하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두면 된다. (스프링부트도 이 방법을 기본으로 제공하고 있다.) 스프링부트의 대표 시작 정보인 @SpringBootApplication을 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.
컴포넌트 스캔 기본 대상
컴포넌트 스캔은 @Component 뿐 아니라 다음과 같은 내용도 추가 대상에 포함되며 다음 애노테이션이 있으면 스프링 부가 기능을 수행한다.
- @Component : 컴포넌트 스캔에서 사용
- @Controller
- 스프링 MVC 컨트롤러에서 사용
- 스프링 MVC 컨트롤러로 인식
- @Service
- 스프링 비즈니스 로직에서 사용
- 의외로 특별한 처리를 하지는 않지만 핵심 비즈니스 로직이 이 곳에 있다는 것을 인식하는데 도움이 된다.
- @Repository
- 스프링 데이터 접근 계층에서 사용
- 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
- @Configuration
- 스프링 설정 정보에서 사용
- 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
필터
@Component 를 사용하면 충분하기 때문에 includeFilters를 사용할 일은 거의 없고, excludeFilters는 간혹 사용하기도 한다.
스프링부트는 컴포넌트 스캔을 기본으로 제공하는데 개인적으로 옵션을 변경해서 사용하기보단 기본 설정에 최대한 맞추어 사용하는 것을 권장한다.
- includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
FilterType 옵션
- ANNOTATION : 기본 값으로 애노테이션을 인식해서 동작한다.
- ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.
- ASPECTJ : AspectJ 패턴을 사용한다.
- REGEX : 정규 표현식
- CUSTOM : TypeFilter라는 인터페이스를 구현해서 처리한다.
중복 등록과 충돌
컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?
자동 빈 등록 vs 자동 빈 등록
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데 그 이름이 같은 경우 ConflictingBeanDefinitionException 예외가 발생한다.
수동 빈 등록 vs 자동 빈 등록
이 경우 수동 빈 등록이 우선권을 가지며, 수동 빈이 자동 빈을 오버라이딩 해버린다.
!! 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본값으로 바꾸었다.
🐣 출처: 인프런 김영한님 강의
이 글은 인프런의 김영한님 스프링 강의를 보고 작성한 글입니다.
강의를 들으면서 정리한 글이므로 틀린 내용이나 오타가 있을 수 있습니다.