이전까지는 @Configuration과 @Bean을 이용하여 설정 정보에 직접 등록할 스프링 빈을 나열하였다.
만약 등록해야 할 스프링 빈이 더 많아진다면 어떻게 처리해야 할까?
1. @ComponentScan
설정 정보가 없어도 자동으로 스프링 빈을 등록하는 기능
의존 관계를 자동으로 주입해주는 @Autowired와 같이 사용
코드 예시
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.springframework.context.annotation.ComponentScan.*;
@Configuration
@ComponentScan(
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}참고 :
@Configuration소스코드를 열어보면@Component애노테이션이 붙어있어@ComponentScan을 사용하면@Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 위 예시에서는 앞서 만들어두었던 설정 정보를 스캔 대상에서 제외하기 위해서excludeFilters를 이용하였다.
컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
@Autowired를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다
2. 동작 방식
2-1. @ComponentScan
@ComponentScan은@Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.- 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
- 빈 이름 기본 전략: MemberServiceImpl 클래스 -> memberServiceImpl
- 빈 이름 직접 지정:@Component("memberService2")와 같이 이름을 부여
2-2. @Autowired 의존관계 자동 주입
- 생성자에
@Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. - 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
-getBean(MemberRepository.class)와 동일 - 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.
3. 탐색 위치와 기본 스캔 대상
3-1. 탐색 위치
필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.
예시 코드
@ComponentScan(
basePackages = "hello.core"
}basePackages: 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
-basePackages = {"hello.core", "hello.service"}와 같이 여러 시작 위치를 지정할 수도 있다.basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다- 만약 지정하지 않으면
@ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
권장하는 방법
- 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트
최상단에 두는 것이다. - 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.
3-2. 컴포넌트 스캔 기본 대상
컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.
@Component: 컴포넌트 스캔에서 사용@Controlller: 스프링 MVC 컨트롤러에서 사용@Service: 스프링 비즈니스 로직에서 사용@Repository: 스프링 데이터 접근 계층에서 사용@Configuration: 스프링 설정 정보에서 사용
참고: 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.
@Controller: 스프링 MVC 컨트롤러로 인식@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.@Configuration: 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.@Service: 사실@Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.
4. 필터
includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.
예시 코드
@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)FilterType 옵션
ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
- ex)org.example.SomeAnnotationASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
- ex)org.example.SomeClassASPECTJ: AspectJ 패턴 사용
- ex)org.example..*Service+REGEX: 정규 표현식
- ex)org\.example\.Default.*CUSTOM:TypeFilter이라는 인터페이스를 구현해서 처리
- ex)org.example.MyTypeFilte
5. 중복 등록과 충돌
같은 빈 이름으로 생기는 충돌에는 두가지 상황이 있다.
1. 자동 빈 등록 vs 자동 빈 등록
2. 수동 빈 등록 vs 자동 빈 등록
5-1. 자동 빈 등록 vs 자동 빈 등록
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 ConflictingBeanDefinitionException 예외 오류를 발생시킨다.
5-2. 수동 빈 등록 vs 자동 빈 등록
이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다)
수동 빈 등록시 남는 로그
Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing자동 보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.
그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.
스프링 부트인 CoreApplication 을 실행해보면 오류를 볼 수 있다.
수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러
Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true
