[스프링 핵심 원리 - 기본편] 컴포넌트 스캔 2

탐색 위치와 기본 스캔 대상

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

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

 

@ComponentScan(
        basePackages = "hello.core.member"
)

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

패키지 위치를 지정하지않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장합니다.

예를 들어 프로젝트 구조가

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

com.hello -> 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정정보를 두고, @ComponentScan 애노테이션을 붙이고,  basePackages 지정은 생략합니다.

 

이 설정은 com.hello 를 포함한 하위는 모두 컴포넌트 스캔대상이 됩니다. 

참고로 스프링 부트를 사용하면 대표시작 정보인  @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (  @SpringBootApplication   설정안에  ComponentScan 이 들어있습니다)

 

 

 

컴포넌트 스캔 기본 대상

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

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

 

해당 클래스의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있다.

 @Component
 public @interface Controller {
 }

 @Component
 public @interface Service {
 }

 @Component
 public @interface Configuration {
 }

 

참고 :사실 애노테이션은 상속관계라는 것이 없습니다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능이 아니라, 스프링이 지원하는 기능입니다.

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

 

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

---

필터

includeFilters : 컴포넌트 스캔 대상을 추가로 지정합니다.

excludeFilters :  컴포넌트 스캔 대상에서 제외할 대상을 지정합니다.

 

예제로 확인해 봅시다.

 

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

package hello.core.discount;



import java.lang.annotation.*;

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

 

 

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

package hello.core.discount;



import java.lang.annotation.*;

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

 

 

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

package hello.core.discount;

@MyIncludeComponent
public class BeanA {
}

• @MyIncludeComponent 적용

 

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

package hello.core.discount;

@MyExcludeComponent
public class BeanB {
}

• @MyExcludeComponent 적용

 

설정정보와 전체 테스트 코드

package hello.core.discount;


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;

public class ComponentFilterAppConfigTest {

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

        org.junit.jupiter.api.Assertions.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 ComponentFilter{

    }
}

 

 

includeFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA 가 스프링 빈에 등록되도록 합니다.

excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB 가 스프링 빈에 등록되지 않도록 합니다.

 

FilterType 옵션

• ANNOTATION : 기본값, 애노테이션을 인식해서 동작한다.
  • ex) ` org.example.SomeAnnotation `
• ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ex) ` org.example.SomeClass
• ASPECTJ: AspectJ 패턴 사용
  • ex) ` org.example..*Service+
• REGEX : 정규표현식
  • org\. example\. Default.*
• CUSTOM : TypeFilter라는 인터페이스를 구현해서 처리
  • ex)  ` org.example.MyTypeFilter `
• 예를 들어 BeanA 도 빼고 싶으면 다음과 같이 추가하면 됩니다.

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

    }

참고 : @Component 면 충분하기 때문에  includeFilters를 사용할 일은 거의 없다.

excludeFilters는 간혹 사용할 때가 있지만 많지 않습니다.

 

---

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까요?

 

두 가지 상황을 알아보자

1. 자동 빈 등록 VS 자동 빈 등록
2. 수동 빈 등록 VS 자동 빈 등록

 

자동 빈 등록 VS 자동 빈 등록

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

• ConflictingBeanDefinitionException 예외 발생

 

 

수동 빈 등록 VS 자동 빈 등록

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Configuration
@ComponentScan
@Controller
public class AutoConfig {
    @Bean(name = "memoryMemberRepository")
    MemoryMemberRepository memoryMemberRepository(){
        return new MemoryMemberRepository();
    }
}

 

이 경우 수동 빈 등록이 우선권을 가집니다. (수동 빈이 자동빈을 오버라이딩해 버립니다.)

 

해당 부분에서 오류가 발생하면 잡기 어려운 버그가 만들어진다.

그래서 최근 스프링 부트에서 수동 빈 등록과 자동 빈 등록이 충돌 나면 오류가 발생하도록 기본 값을 바꾸었다.

 

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러 ** ** Consider renaming one of the beans or enabling overriding by setting ` spring.main.allow-bean-definition-overriding=true

 

스프링 부트인 CoreApplication을 실행해 보면 오류를 볼 수 있다.