[Spring] Basic, 컴포넌트 스캔

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

---

컴포넌트 스캔

이전 포스팅까지는 스프링 빈을 등록하기 위해 @Bean 어노테이션을 붙혀주거나 <bean>이라는 XML 태그를 붙혀서 직접 설정 정보에 스프링 빈을 나열했다. 하지만 내가 만들어야 할 스프링 빈이 수백 개가 된다면 어떨까? 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.

그래서 스프링에서는 이런 문제를 해결하기 위해 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

@ComponentScan이라는 어노테이션을 통해서 해당 기능을 사용하는데, 실제로 코드를 작성하며 살펴보자.

AutoAppConfig

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

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
• AutoAppConfig도 설정 파일이기에 @Configuration 어노테이션을 붙여준다.
• 기존에 작업했던 AppConfig와 충돌이 생길 수 있어 excludeFilter 속성으로 해당 클래스는 스캔하지 않도록 설정한다.

해당 @ComponentScan은 @Component 어노테이션이 붙은 클래스를 스캔해 스프링 빈으로 등록한다.
그렇기에 그다음으로 내가 등록해야 하는 스프링 빈 클래스들에 @Component를 붙여주자.

MemberServiceImpl

@Component
public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository;

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

OrderServiceImpl

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

RateDiscountPolicy

@Component
public class RateDiscountPolicy implements DiscountPolicy {

    private int discountPercent = 10;

    @Override
    public int discount(Member member, int price) {
        if (member.getGrade() == Grade.VIP) {
            return price * discountPercent / 100;
        }
        return 0;
    }
}

MemoryMemberRepository

@Component
public class MemoryMemberRepository implements MemberRepository{
    ...
}

코드를 잘 보면 @Autowired라는 어노테이션도 추가된 것을 확인할 수 있다. 이는 의존관계 주입을 명시적으로 하질 않고 있기 때문에 의존관계 주입도 클래스 내부에서 해결해야 하는데 이 @Autowired 어노테이션이 의존관계 주입을 자동으로 해주기 때문에 작성해 준 것이며 차후 이 어노테이션에 대해서도 알아본다.

테스트 케이스 작성

public class AutoAppConfigTest {

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

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

@ComponentScan

이 어노테이션은 @Component 어노테이션이 붙은 모든 클래스를 스프링 빈으로 등록하는데, 이때 스프링 빈의 이름을 설정하는 기본 설정은 클래스명에서 앞 글자를 소문자로 바꿔 사용하거나 직접 이름을 부여해서 등록할 수 있다.

• 만약 MemberServiceImpl이라는 클래스라면 memberSerivceImpl이라는 빈 이름으로 등록된다.
• 만약 해당 클래스에 @Component("service")처럼 속성이 설정되면 service라는 빈 이름으로 등록된다.

@Autowired

생성자(혹은 필드)에 @Autowired 어노테이션을 지정하면 스프링 컨테이너에서는 자동으로 해당 스프링 빈을 찾아 등록해 준다. 우리가 자주 사용한 ac.getBean(beanName, beanClass)와 같다.

이 어노테이션을 사용하기에 이전에 설정 정보에서 직접 필요한 의존관계 주입을 수동으로 해주던 것을 자동으로 할 수 있게 된다.

탐색 위치와 기본 스캔 대상

---

@ComponentScan을 통해 @Component 어노테이션이 부여된 클래스를 탐색하여 등록할 수 있다고 했다.
그럼 어디서부터 탐색할지에 대해 알아야 하는데, 기본 관례와 사용자 정의 방법에 대해 모두 알아보자.

1. 속성(basePackages)을 이용한 탐색 위치 지정

@ComponentScan(basePackages = "hello.core")

패키지 경로를 지정해 탐색할 패키지의 시작 경로를 지정할 수 있는데, 이 패키지를 포함해 하위 패키지를 모두 탐색한다. 더하여 {"hello.core", :"hello.servcie"} 이런 식으로 시작 위치를 여러 군데 둘 수도 있다.

• 여기서 basePackageClasses 속성을 사용하면 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

2. 기본 관례

속성을 따로 지정하지 않으면 해당 @ComponentScan 어노테이션이 존재하는 현재 패키지가 시작 위치가 된다.

@SpringBooApplication 에는 @ComponentScan이 부여되어 있으며 보통 해당 어노테이션이 붙어있는 클래스는 프로젝트 루트 경로에 위치해있고, 그렇게 유지 되는 게 좋다.

컴포넌트 스캔 기본 대상

스프링 프로젝트로 진행하다 보면 @Component 어노테이션을 붙이지 않았는데도 스프링빈에 제대로 등록돼서 사용이 가능한 경우가 있다. 이런 경우가 특정 어노테이션들은 기본적으로 같이 등록되기 때문인데, 사실 해당 기본 대상 어노테이션도 트레이싱 해서 살펴보면 @Component 어노테이션이 부여되어 있다.

• @Component : 컴포넌트 스캔 대상

• @Controller : 스프링 MVC 컨트롤러에서 사용

  • 해당 어노테이션을 붙이면 스프링 MVC 컨트롤러로 인식된다.

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

  • 특별한 처리는 하지 않고 그저 이 어노테이션이 부여된 클래스가 핵심 비즈니스 로직이 들어있다고 인식하도록 해주는 역할

• @Repository : 스프링 데이터 접근 계층에서 사용

  • 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해 준다.

• @Configuration : 스프링 설정 정보에서 사용

  • 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

위 컴포넌트 스캔 기본 대상 어노테이션들은 스캔 용도뿐 아니라 각각의 목적에 맞는 부가 기능을 수행한다.

필터

---

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

AutoAppConfig 클래스를 작성하며 어노테이션에서 기존에 작성한 AppConfig를 탐색하지 않기 위해 속성을 지정한 적이 있는데, 이를 필터라 한다. 이처럼 컴포넌트 스캔 대상을 추가 및 제외할 수 있다.

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

그럼 간단한 사용자 정의 어노테이션을 직접 만들어서 해당 필터에 등록해서 컴포넌트 스캔 대상에서 추가, 제외를 해보자.

MyIncludeComponent

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

MyExcludeComponent

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

BeanA

@MyIncludeComponent
public class BeanA {
}

BeanB

@MyExcludeComponent
public class BeanB {
}

ComponentFilterAppConfigTest

public class ComponentFilterAppConfigTest {

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

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

        assertThatThrownBy(()-> 
        ac.getBean("beanB", BeanB.class)).isInstanceOf(NoSuchBeanDefinitionException.class);

    }

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

테스트를 통해 우리는 includeFilters에 등록된 추가된 어노테이션(MyIncludeComponent)이 부여된 BeanA는 스프링 빈으로 등록되었고, excludeFilters에 등록된 추가된 어노테이션(MyExcludeComponent)이 부여된 BeanB는 스프링빈으로 등록되지 않은 것을 확인할 수 있다.

FilterType 옵션

---

include 혹은 excludeFilters에서 추가할 필터의 타입을 지정해 줄 수 있는데, 5가지 옵션을 제공한다.

• ANNOTATION : 기본값, 애노테이션을 인색해서 동작한다.
• ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.
• ASPECTJ : AspectJ 패턴 사용
• REGEX : 정규 표현식 사용
• CUSTOM : TypeFilter 인터페이스를 구현해서 처리한다.

✅ @Component 면 충분하기 때문에, includeFilters를 사용할 일은 거의 없다. excludeFilters
는 여러 가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기보다는 스프링의 기본 설정에 최대한 맞추어 사용하자

중복 등록과 충돌

---

예전 @Bean 어노테이션을 등록할 때와 마찬가지로 컴포넌트 스캔을 할 때 역시 빈 이름이 중복되는 상황이 생길 수 있다. 빈 등록 시 빈 이름은 관례에 따른 자동 빈 등록과, 수동으로 이름을 지정한 수동 빈 등록이 있을 텐데, 모든 충돌 상황에서 현재는 기본적으로 오류를 발생시킨다.

• ConflictingBeanDefinitionException

이전에는 자동 빈 등록과 수동 빈 등록으로 빈 이름 충돌이 생길 경우 수동 빈이 우선권을 가져서 수동빈이 자동빈을 오버라이딩 했으나 대부분 의도하지 않은 상태에서 오버라이딩이 되는 경우가 많기에 프로젝트에서 에러는 아니지만 의도한대로 동작하지않는 버그가 발생한다. 그렇기에 최근에는 기본적으로 오류를 발생하도록 변경되었다.