컴포넌트 스캔(Component Scan)

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

컴포넌트 스캔이란?

@ComponentScan 은 설정 파일에 사용되며, 이 어노테이션을 사용하면 해당 패키지 하위 모든 클래스 중 @Component 가 붙은 클래스를 스캔하여 스프링 빈으로 자동 등록 한다.

 

지금까지 예제처럼 스프링 빈을 등록할 때 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 스프링 빈을 등록 한다면, 등록해야 할 스프링 빈이 수십, 수백개가 되면 설정 정보가 커지고, 누락하는 문제도 발생하게 된다. 그래서 스프링은 설정 정보없이도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 또한 의존관계도 자동으로 주입하는 @Autowired 기능도 제공한다.

 

AutoAppConfig.java

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 을 설정 정보에 붙여주면 된다.
• 기존의 AppConfig와는 다르게 @Bean을 등록하지 않아도 된다.

@Component 추가

MemoryMemberRepository

@Component
public class MemoryMemberRepository implements MemberRepository {}

RateDiscountPolicy

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

MemberServiceImpl @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

    @Autowired // ac.getBean(MemberRepository.class)
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

OrderServiceImpl @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 를 사용하면 생성자의 파라미터가 여러개 있더라도 각각에 대해 자동으로 주입된다. 스프링 컨테이너는 파라미터 타입에 맞는 빈을 찾아서 주입해준다.

---

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

@ComponentScan

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

이때 스프링 빈의 기본 이름은 클래스명을 사용하며, 맨 앞글자만 소문자로 사용한다.

• 빈 이름 규칙 : MemberServiceImpl -> memberServiceImpl
• 빈 이름 직접 지정 : @Component("customBeanName") 처럼 직접 이름을 지정할 수 있다.

 

@AutoWired 의존관계 자동 주입

생성자에 @Autowried 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

---

탐색 위치와 기본 스캔 대상

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

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

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

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

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

basePackagesClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

 

만약 지정하지 않는다면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 컴포넌트 스캔 방식

설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공하고 있다.

• com.hello
• com.hello.service
• com.hello.repository

위와 같은 프로젝트 구조에서 "com.hello" 아래에 메인 설정 정보(AppConfig)를 두게되면 "@ComponentScan" 애노테이션만 붙여도 "basePackages"의 지정 없이 아래의 모든 패키지들이 컴포넌트 스캔의 대상이 된다.

 

이러한 방식은 스프링 부트에서도 동일하게 적용되며, 프로젝트 시작 위치에 "@SpringBootApplication" 어노테이션을 두는 것이 일반 적이다.

---

컴포넌트 스캔 기본 대상

스프링은 단순히 "@Component" 어노테이션만 스캔하는 것이 아니다. 여러 다른 어노테이션들도 함께 추가로 대상에 포함한다.

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

다음과 같은 소스 코드를 보면 @Component 를 포함하고 있다.

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}

어노테이션에는 상속관계라는 것이 없다. 위와 같이 어노테이션이 특정 어노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능이 아니고, 스프링에서 지원 하는 기능이다.

 

 

컴포넌트 스캔의 용도 뿐만 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.

• @Contoller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
• @Service : @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직, 계층을 인식하는데 도움이 된다.

---

컴포넌트 스캔 필터 

@ComponentScan 은 스프링 빈을 자동으로 등록하지만, 특정 빈을 포함하거나 제외하고 싶을 때 사용된다.

 

필터의 종류

• 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;

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 {
}

설정 정보와 테스트 코드

package hello.core.scan.filter;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        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{

    }
}

• includeFilters 에 MyIncludeConponent 어노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilters 에 MyExcludeConponent 어노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

 

FilterType 옵션

FilterType은 다양한 옵션을 제공하여 더욱 세밀한 설정이 가능하다.

• ANNOTATION : 애노테이션 기반의 필터링
• ASSIGNABLE_TYPE : 특정 타입과 그 하위 타입을 대상으로 필터링
• REGEX : AspectJ 패턴을 사용한 필터링
• CUSTOM : 사용자 정의 필터 : "TypeFilter" 인터페이스를 구현해서 처리

 

스프링 부트는 컴포넌트 스캔을 기본적으로 제공하기 때문에. 커스텀 필터 옵션을 사용하기보다는스프링의 기본 설정에 최대한 맞추어 사용하는 것이 바람직하다.

---

스프링 빈 중복 등록 및 충돌 문제

스프링의 컴포넌트 스캔 및 등록 기능은 개발의 편의성을 극대화 해주지만, 편리한 기능에도 주의해야 할 부분이 있다.

 

빈의 중복 등록

스프링에서 빈의 이름이 중복되는 경우에 대한 대응은 크게 두 가지 상황이 있다.

• 자동 빈 등록 vs 자동 빈 등록 : 두 빈이 자동으로 등록될 때 이름이 중복되면, ConflictionBeanDefinitionException 예외가 발생 한다.
• 수동 빈 등록 vs 자동 빈 등록 : 만약 수동으로 빈을 등록하면 자동으로 등록되는 빈과 이름이 충돌한다면, 수동 빈 등록이 우선권을 가진다. 이 경우 수동 빈이 자동 빈을 Override 한다.

 

개발자가 명확한 의도를 가지고 빈을 중복 등록하는 경우는 드물고, 대부분의 경우, 설정의 꼬임 혹은 실수로 인한 결과이다. 이런 상황은 매우 애매하며, 잡기 어려운 버그를 유발할 수 있다.

 

이러한 문제를 인식하고, 스프링 부트는 이러한 중복 등록 문제에 대해 오류를 발생 시키는 방향으로 기본 설정을 변경하였다.

 

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

이를 통해, 개발자는 빠르게 문제의 원인을 파악하고 해결할 수 있다.

 

 

 

출처 : 인프런 - 🔗 스프링 핵심원리 - 기본편by 우아한형제 김영한님