스프링 기본원리(7)
컴포넌트 스캔
스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의
앞에서 설명한 AppConfig파일을 지우고 다음과 같은 AutoAppConfig.java 파일을 만든다.
@Configuration
@ComponentScan
public class AutoAppConfig {
}
- 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
- 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.
컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. @Component 를 붙여주자.
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
@Override
public Order createOrder(Long memberId, String itemName, int itemPrice) {
Member member = memberRepository.findById(memberId);
int discount = discountPolicy.discouont(member,itemPrice);
Order order = new Order(memberId,itemName,itemPrice,discount);
return order;
}
}
- 이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
- @Autowired 는 의존관계를 자동으로 주입해준다.
다음은 컴포넌트 스캔을 이용한 예제 코드이다.
@Test
void basicScan(){
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
MemberService bean = ac.getBean(MemberService.class);
Assertions.assertThat(bean).isInstanceOf(MemberService.class);
}
- AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하다.
- 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
컴포넌트 스캔과 자동 의존관계 주입 동작 방식
- 스프링 컨테이너에 빈 이름은 MemberServiceImpl 이라면 앞 글자를 소문자로 바꿔 memberServiceImpl로 등록된다.
- 빈 이름을 직접 설정하려면 @Component(“설정할이름”)과 같이 설정한다.
Autowired자동 의존관계 주입
- 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
- 기본 조회 전략은 타입이 같은 빈을 찾아서 주입하며 getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.
탐색위치와 기본 스캔 대상
모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작
@ComponentScan(
basePackages = "hello.core",
}
- basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
- basePackages = {“hello.core”, “hello.service”} 이렇게 여러 시작 위치를 지정할 수도 있다.
- basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
- 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
권장하는 방법 : 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
만약 다음과 같은 구조로 되있다하자
- practice.scan
- practice.scan.service
- practice.scan.repository
practice.scan -> 프로젝트 시작 루트 여기에 AutoAppConfig와 같은 메인 설정 정보를 둔다.
참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다!) -> 그러면 AutoAppConfig와 같은 설정 파일을 두지 않아도 된다.
컴포넌트 스캔 기본 대상
컴포넌트 스캔은 @Component뿐만 아니라 다음과 같은 내용도 추가로 포함한다.
- @Component : 컴포넌트 스캔에 사용
- @Controller : 스프링 MVC 컨트롤러에서 사용, 스프링 MVC 컨트롤러로 인식
- @Service : 스프링 비즈니스 로직에서 사용, 특별한 로직은 없지만 개발자들이 비즈니스 계층을 인식하는데 도움을 준다.
- @Repository : 스프링 데이터 접근 계층에서 사용, 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
- @Configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리
참고 : 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
컴포넌트 스캔 필터
- includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
테스트를 위해 새로운 애노테이션을 만들어 보자
컴포넌트 스캔 대상에 추가
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}
컴포넌트 스캔 대상에 제외
// 컴포넌트 스캔 대상에 추가
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}
사용할 때는 아래와 같은 코드로 사용한다.
@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyIncludeComponent.class),
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class)
)
중복 등록과 충돌
- 자동 빈 등록 vs 자동 빈 등록 : 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다. ConflictingBeanDefinitionException 예외 발생
- 수동 빈 등록 vs 자동 빈 등록 : 이 경우 수동 빈 등록이 우선권을 가진다, 하지만 스프링 부트에서는 이러한 에러는 잡기 어려우므로 에러를 낸다.
출처 : 인프런 김영한의 스프링 핵심원리 기본편
Leave a comment