ComponentScan

컴포넌트 스캔

컴포넌트 스캔 & 의존관계 자동주입

매번 @Bean이나 XML 파일로 스프링 빈을 직접 등록해주면 매우 번거로움

✔ 컴포넌트 스캔: 설정 정보가 없어도 자동으로 스프링빈을 등록해주는 기능

✔ 의존 관계 자동 주입: @Autowired

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {

}

✔ @ComponentScan을 설정 정보에 붙여주면 @Component annotation이 붙은 클래스를 스캔해서 스프링 빈으로 동록한다

@Bean으로 따로 클래스를 등록하지 않아도 된다

// MemoryMemberRepository.java

@Component
public class MemoryMemberRepository implements MemberRepository {}

// RateDiscountPolicy.java

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

// MemberServiceImpl.java

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

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

설정정보(이전의 Appconfig)이 따로 없기 때문에 의존관계 주입도 클래스 안에서 해결해야 한다

@Autowired의존관계 자동 주입

테스트 코드

public class AutoAppConfigTest {

    @Test
    void basicScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

ClassPathBeanDefinitionScanner - Identified candidate component class:
.. RateDiscountPolicy.class
.. MemberServiceImpl.class
.. MemoryMemberRepository.class
.. OrderServiceImpl.class

컴포넌트 스캔이 잘 동작한다

컴포넌트 스캔의 원리

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 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

✔ 권장 방법: 패키지 위치를 지정하지 않고 설정 정보 클래스의 위치를 프로젝트 최상단에 둔다(스프링부트)

컴포넌트 스캔 기본 대상

컴포넌트 스캔의 스캔 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controlller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용

기본적으로 애노테이션은 상속관계가 없다 -> 위와 같은 기능은 자바가 아니라 스프링에서 자체적으로 지원하는 기능

※ 참고: 애노테이션의 기능

• @Controller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
• @Service : 특별한 처리를 하지 않지만, 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하도록 도움

필터

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

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

package hello.core.scan.filter;

import java.lang.annotation.*;

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

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


package hello.core.scan.filter;

import java.lang.annotation.*;

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

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

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

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

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

// 테스트코드

public class ComponentFilterAppConfigTest {

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

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

        org.junit.jupiter.api.Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class));
    }

    @Configuration
    @ComponentScan(
            includeFilters =  @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig{

    }
}

테스트 코드를 실행해보면 BeanA는 등록되고 BeanB는 등록되지 않는다.

FilterType 옵션

5가지 옵션 존재

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

일단은 기본 설정으로 사용하는 것 권장!

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

ConflictingBeanDefinitionException 예외 발생

수동 빈 등록 vs 자동 빈 등록

수동 빈 등록이 우선권을 가지나 권장하지는 않는다!!

스프링부트에서는 에러처리!