본문 바로가기
스프링 핵심원리 - 기본편

컴포넌트 스캔

by leko 2023. 5. 17.

1. 컴포넌트 스캔과 의존관계 자동주입 시작하기

- 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML -> 설정 정보에 직접 등록할 스프링 빈을 나열했다.

- 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다

- 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

@Configuration
@ComponentScan(
        basePackages = "hello.core.member",
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
                Configuration.class))
public class AutoAppConfig {

}

 

-  컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다

- 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다

 

MemoryMemberRepository @Component 추가

RateDiscountPolicy @Component 추가

MemberServiceImpl @Component, @Autowired 추가

OrderServiceImpl @Component, @Autowired 추가

 

- @Autowired 는 의존관계를 자동으로 주입해준다.

- @Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다

 

public class AutoAppConfigTest {
    @Test
    void basicScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService memberService = ac.getBean(MemberService.class);

        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

 

AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일, 설정 정보로 AutoAppConfig 클래스를 넘긴다.

 

 1. @ComponentScan

@ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.

빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl

만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다

 

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

생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

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

생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

2. 탐색위치와 기본 스캔 대상

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸림 ->  필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다

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

basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다

basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정한다 

 

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

@Controlller : 스프링 MVC 컨트롤러에서 사용 스프링 MVC 컨트롤러로 인식

@Component : 컴포넌트 스캔에서 사용

@Service : 스프링 비즈니스 로직에서 사용

@Repository : 스프링 데이터 접근 계층에서 사용, 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다

@Configuration : 스프링 설정 정보에서 사용, 이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리

 

@Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

3. 필터

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

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

 

컴포넌트 스캔 대상에 추가할 애노테이션

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

컴포넌트 스캔 대상에서 제외할 애노테이션

package hello.core.scan.filter;
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

컴포넌트 스캔 대상에 추가할 클래스

@MyIncludeComponent
public class BeanA {
}

컴포넌트 스캔 대상에서 제외할 클래스

@MyExcludeComponent
public class BeanB {
}

전체 코드

@Test
 void filterScan() {
 ApplicationContext ac = new
AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
 public class ComponentFilterAppConfigTest {
 BeanA beanA = ac.getBean("beanA", BeanA.class);
 assertThat(beanA).isNotNull();
 Assertions.assertThrows(
 NoSuchBeanDefinitionException.class,
 () -> ac.getBean("beanB", BeanB.class));
 }
 @Configuration
 @ComponentScan(
 includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyIncludeComponent.class),
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class)
 )
 static class ComponentFilterAppConfig {
 }
 }
 @ComponentScan(
 includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
 
MyIncludeComponent.class),
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
 
MyExcludeComponent.class)
)

FilterType 5가지 옵션

ANNOTATION: 기본값, 애노테이션을 인식해서 동작

org.example.SomeAnnotation

ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작

org.example.SomeClass

ASPECTJ: AspectJ 패턴 사용

org.example..*Service+

REGEX: 정규 표현식

org\.example\.Default.*

CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리

org.example.MyTypeFilter

 

4. 중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

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

 

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까? 이 경우 수동 빈 등록이 우선권을 가진다.

수동 빈이 자동 빈을 오버라이딩 해버린다

 

수동 빈 등록시 남는 로그

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing