[Spring] Component Scan과 의존관계 자동 주입

지금까지 스프링 빈을 등록할 때는 @Bean 애너테이션이나 XML의 <Bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했습니다. 하지만 이렇게 수동으로 등록하다보면 등록해야 하는 스프링 빈이 수십, 수백개가 되었을 때 일일이 등록하기도 귀찮고 설정 정보도 커지는 문제점이 발생합니다.

따라서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 Component Scan이라는 기능을 제공합니다.

또한 의존관계도 자동으로 주입하는 @Autowired도 제공합니다.

ComponentScan, Autowired

@Configuration
// 컴포넌트 스캔을 사용하려면 애너테이션을 붙이면 됩니다.
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
	// bean을 따로 등록해 줄 필요가 없습니다.
}

@ComponentScan을 @Configuration 설정 정보에 붙여주면 빈을 따로 등록할 필요가 없습니다.

참고: 컴포넌트 스캔을 사용하면 `@Configuration` 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 `excludeFilters` 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다.

 

컴포넌트 스캔은 이름 그대로 @Component 애너테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록합니다. 간단한 예시를 보면

@Component
public class MemoryMemberRepository implements MemberRepository {}

이런식으로 사용하는 Class에 애너테이션을 붙여주면 됩니다.

 

의존 관계의 경우 Autowired를 사용하면 됩니다.

@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;
    }

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

 

연결이 잘 되어있는지 한번 테스트해 보겠습니다.

public class AutoAppConfigTest {

    @Test
    void basicScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

테스트 코드를 실행해 봤을 때, 잘 동작하는 것을 알 수 있습니다.

또한, 의존성도 알아서 다 연결되는 것을 알 수 있습니다.

ComponentScan의 동작 방식

1. ComponentScan 동작

• @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
  • 빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl
  • 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

2. Autowired 의존관계 자동 주입

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
  • getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

탐색 위치와 기본 스캔 대상

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸립니다. 따라서 꼭 필요한 위치부터 탐색하도록 시작 위치를 설정할 수 있습니다.

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

 

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"} ` 이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

하지만 이 옵션은 많이 사용하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이 좋습니다.

또한, 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 프로젝트 시작 루트 위치에 두는 것이 관례입니다. 또한 애너테이션 안에 @ComponentScan이 들어 있습니다.

컴포넌트 스캔 기본 대상

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

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

참고 : 애너테이션에는 상속관계라는 것이 없습니다. 그래서 이렇게 애너테이션이 특정 애너테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 것이 아닌 스프링에서 지원하는 기능입니다.
또한 useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외됩니다.

Scan Filter

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

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("beanB", BeanB.class));
    }

    @Configuration // type은 생략해도 된다.
    @ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class), 
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class))
    static class ComponentFilterAppConfig {}
}

 

Filter Type 옵션

• ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
  • ex) org.example.SomeAnnotation
• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ex) org.example.SomeClass
• ASPECTJ: AspectJ 패턴 사용
  • ex) org.example..*Service+
• REGEX: 정규 표현식
  • ex) org\.example\.Default.*
• CUSTOM: `TypeFilter` 이라는 인터페이스를 구현해서 처리
  • ex) org.example.MyTypeFilter

주로 1번과 2번만 사용합니다. 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록한다면??

• 자동 빈 등록 vs 자동 빈 등록 :  ConflictingBeanDefinitionException 예외 발생
• 수동 빈 등록 vs 자동 빈 등록 : 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)
  • 단, 대부분은 이러한 관계는 의도적으로 만든 것이라기 보다는 여러 설정이 꼬인 결과이다.
  • 따라서 스프링 부트에서는 수동 빈 등록과 자동 빈 충돌이 나면 오류가 발생하도록 기본 값을 변경하였습니다.

참고

스프링 핵심 원리 - 기본편 강의 - 인프런