Component Scan

스프링의 유용한 기능인 컴포넌트 스캔에 대해 정리하였습니다.

 

 

---

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

스프링 빈을 등록할 때, 일반적으로 자바 어노테이션의 @Bean이나 XML의 <bean> 태그를 사용하여 직접 등록해야 합니다. 그러나 서비스의 규모가 커질수록 등록해야 할 스프링 빈의 수가 증가하여, 설정 정보가 누락될 가능성이 높아집니다.

이를 해결하기 위해 스프링은 컴포넌트 스캔 기능을 제공하며, 이를 통해 스프링 빈을 자동으로 등록할 수 있습니다.

스프링은 또한 스프링 빈 간의 의존 관계를 자동으로 주입해주는 기능도 제공합니다.  

 

• 설정 파일에 @ComponentScan 어노테이션을 사용하여 컴포넌트 스캔 기능을 활성화합니다.
• 컴포넌트 스캔은 프로젝트 내에서 @Component 어노테이션이 붙은 클래스를 모두 찾아 스프링 빈으로 자동 등록합니다.
• 스프링 빈들 간의 의존 관계는 @Autowired 어노테이션을 통해 자동으로 주입할 수 있습니다.

 

Ex)

AutoAppConfig.java

package hello.core;

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

 

< 참고 >
컴포넌트 스캔을 사용할 경우 @Configuration 어노테이션이 붙은 설정 정보도 자동으로 스캔되어 빈으로 등록됩니다. 이로 인해 AppConfig나 TestConfig와 같은 기존의 설정 정보도 함께 등록되고 실행될 수 있습니다. 이를 방지하기 위해, excludeFilters를 사용하여 특정 설정 정보를 컴포넌트 스캔 대상에서 제외하였습니다.

 

MemoryMemberRepository.java

package hello.core.member;

@Component
public class MemoryMemberRepository implements MemberRepository {
}

 

 

RateDiscountPolicy.java

package hello.core.discount;

@Component
public class RateDiscountPolicy implements DiscountPolicy{
}

 

MemberServiceImpl.java

package hello.core.member;

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

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

 

OrderServiceImpl.java

package hello.core.order;

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

 

 

---

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

#1. 컴포넌트 스캔 @ComponentScan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록합니다.
• 스프링 빈의 기본 이름은 클래스명을 그대로 따르되, 맨 앞글자만 소문자로 변환해서 사용
  
  • 빈 이름 기본 지정 : MemberServiceImpl 클래스 → memberServiceImpl
  • 빈 이름 직접 지정 : 스프링 빈의 이름을 직접 지정하고 싶은 경우 @Component("memberService2") 이렇게 지정할 수 있습니다.

 

#2. 의존관계 자동 주입 @ComponentScan

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

 

• 의존관계가 많아도 모두 찾아 자동으로 주입합니다.

 

 

---

< 탐색 위치 >

모든 자바 클래스를 컴포넌트 스캔하는 대신, 스캔할 패키지의 시작 위치를 지정하여  애플리케이션의 성능을 최적화하고 불필요한 클래스 스캔을 피할 수 있습니다.

 

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

• basePackages : 컴포넌트 스캔의 시작 위치로 지정할 패키지를 설정합니다. 지정된 패키지와 그 하위 패키지 모두를 탐색하게 됩니다.
• basePackages = {"hello.core", "hello.service"} 처럼 여러 패키지를 시작 위치로 지정할 수도 있습니다.
• basePackageClasses : 스캔 시작 위치로 사용할 패키지를 특정 클래스의 패키지로 지정합니다. 해당 클래스가 속한 패키지부터 탐색을 시작합니다.
• 지정하지 않은 경우, @ComponentScan 어노테이션이 붙은 설정 정보 클래스의 패키지가 스캔의 시작 위치가 됩니다.

 

---

[ 권장 방법 ]

보편적으로 쓰이는 방법은 패키지 위치를 명시적으로 지정하지 않고, 설정 정보 클래스를 프로젝트의 최상단에 배치하는 것입니다. 이는 최근 스프링 부트에서도 기본으로 제공하는 방식입니다.

 

 

예를 들어, 프로젝트가 다음과 같은 구조를 갖는다면, `AppConfig`를 `com.hello` 패키지에 위치시키고, `basePackages` 지정은 생략합니다:

• com.hello
• com.hello.serivce
• com.hello.repository

 

 

---

< 기본 스캔 대상 >

스프링의 컴포넌트 스캔은 @Component 어노테이션뿐만 아니라, 다음과 같은 어노테이션을 대상으로도 컴포넌트 스캔이 이루어집니다. 이러한 어노테이션들은 기본적으로 @Component를 메타 어노테이션으로 포함하고 있기 때문에, 컴포넌트 스캔 시 자동으로 스프링 빈으로 등록됩니다.

 

• @Component: 컴포넌트 스캔에 의해 스프링 빈으로 등록됩니다.
• @Controller: 스프링 MVC에서 컨트롤러로 인식됩니다.
• @Service: 특별한 처리를 하지는 않지만, 개발자가 이 클래스에 핵심 비즈니스 로직이 있다고 인식하는 데 도움을 줍니다.
• @Repository: 데이터 접근 계층으로 인식되며, 데이터 관련 예외를 스프링 예외로 변환합니다.
• @Configuration: 스프링 설정 정보로 인식되고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 수행합니다.

 

Controller의 소스 코드

 

< 참고 >
1. 애노테이션에는 상속 개념이 없습니다. 따라서 한 애노테이션이 다른 애노테이션을 포함하고 있는 것을 인식하는 기능은 자바 언어의 기본 기능이 아니라, 스프링이 제공하는 기능입니다.
2. `useDefaultFilters` 옵션은 기본적으로 활성화되어 있습니다. 이 옵션을 비활성화하면 기본 스캔 대상이 제외됩니다. 이러한 옵션이 존재한다는 정도만 알고 넘어가면 됩니다.

 

 

---

< 필터 >

필터 옵션을 사용하여 스캔의 대상으로 포함할 항목과 제외할 항목을 지정할 수 있습니다.

 

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

 

Ex)

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

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 {

}

 

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

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {

}

 

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

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {

}

 

설정 정보 :

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

}

 

테스트 코드 :

package hello.core.scan.filter;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

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

 

 

---

[ FilterType 옵션 ]

FilterType에는 5가지 옵션이 있습니다.

 

1. ANNOTATION: 애노테이션을 기준으로 필터링합니다. 기본값으로 사용됩니다.

- 예: `org.example.SomeAnnotation`

 

2. ASSIGNABLE_TYPE: 특정 클래스 타입과 그 자식 타입을 기준으로 필터링합니다.

- 예: `org.example.SomeClass`

 

3. ASPECTJ: AspectJ 패턴을 사용하여 필터링합니다.

- 예: `org.example..*Service+`

 

4. REGEX: 정규 표현식을 사용하여 필터링합니다.

- 예: `org.example.Default.*`

 

5. CUSTOM: 커스텀 로직을 구현하여 필터링합니다. `TypeFilter` 인터페이스를 구현해야 합니다.

- 예: `org.example.MyTypeFilter`

 

< 참고 >
일반적으로 @Component로 대부분의 빈 등록 작업이 충분히 가능하기 때문에, `includeFilters`를 사용할 필요는 거의 없습니다. `excludeFilters`는 특정 상황에서 사용할 수 있으나, 그 빈도는 높지 않습니다. 특히, 최근 스프링 부트는 컴포넌트 스캔을 기본 설정으로 제공하기 때문에, 가능하면 이러한 기본 설정을 그대로 사용하는 것이 좋습니다.

 

 

---

< 중복 등록과 충돌 >

#1. 자동 빈 등록 vs 자동 빈 등록

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

 

#2. 수동 빈 등록 vs 자동 빈 등록

# 2-1. 예전 방식

과거에는 스프링 빈 등록 시 수동 빈 등록과 자동 빈 등록 간에 빈 이름이 충돌하면, 수동 빈 등록이 우선권을 가졌습니다. 즉, 수동으로 등록한 빈이 자동으로 등록된 빈을 오버라이딩합니다. 이러한 상황에서는 다음과 같은 경고 로그가 남습니다:

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

 

 

이 방식은 개발자가 의도적으로 수동 빈 등록을 통해 자동 등록된 빈을 대체하려고 할 때 유용할 수 있습니다. 그러나 실제 개발에서는 의도하지 않은 설정의 중첩으로 인해 이러한 결과가 발생할 수 있으며, 이는 매우 어렵게 잡히는 버그로 이어질 수 있습니다.

 

# 2-2. 최근 스프링 부트 방식

최근의 스프링 부트는 이러한 문제를 방지하기 위해 수동 빈 등록과 자동 빈 등록 간의 충돌이 발생할 경우 오류가 발생하도록 기본 설정을 변경했습니다. 만약 수동 빈 등록과 자동 빈 등록이 충돌하면, 스프링 부트는 다음과 같은 오류 메시지를 출력합니다:

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

 

이는 두 빈 중 하나의 이름을 변경하거나, 필요에 따라 오버라이딩을 허용하는 설정인 `spring.main.allow-bean-definition-overriding=true`를 통해 해결할 수 있습니다. 이 설정 변경은 개발자가 명시적으로 빈 오버라이딩을 의도하지 않는 한 권장되지 않습니다.

 

 

 

 

 

 

 

 

---

해당 글에 포함된 코드나 그림은 김영한님이 제공해주신 자료를 바탕으로 작성되었습니다.

스프링 핵심 원리 - 기본편 강의 | 김영한 - 인프런

스프링 핵심 원리 - 기본편 강의 | 김영한 - 인프런