[Spring 기본] 6. 컴포넌트 스캔

안녕하세요!

이번에는 컴포넌트 스캔에 대해서 공부하고 왔습니다.

그럼 시작해볼게요!!

고고!!

---

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

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했습니다.

예제에서는 4개정도밖에 안 되어서 괜찮았지만, 이렇게 등록해야 할 스프링 빈이 수십 수백 개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고 누락하는 문제도 발생합니다.

그래서, 스프링은 설정 정보가 없어도 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공합니다.

또, 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공합니다.

 

코드로 알아보겠습니다.

먼저, 기존 AppConfig.java는 과거 코드와 테스트를 위해 남겨두고, 새로운 AutoAppConfig.java를 만들어보겠습니다.

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

}

✔️@ComponentScan은 @Component가 붙은 클래스들을 찾아서 자동으로 스프린 빈으로 등록을 해 줍니다.

그리고, excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)는 @Component가 붙은 클래스들을 찾긴 찾는데, 제외할 클래스를 필터링(@Configuration이 붙은 클래스를 제외) 해 줍니다.

왜 제외하는지는 밑 참고에서 설명할 것입니다.

 

지금까지 한 것을 다시 설명하자면, 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 됩니다.

그리고, 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없습니다!!

참고!! 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고 실행되어 버립니다.
AppConfig 같은 클래스는 빈을 일일이 등록해서 수동으로 돌려버리기 때문에 오늘 하는 거랑 충돌이 날 수 밖에 없습니다.
그래서, excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했습니다.
보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했습니다.

 

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록합니다

참고!! @Configuration이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문입니다.

 

이제, 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주도록 하겠습니다. (구현체들에만 붙힙니다!)

우선, MemoryMemberRepository 클래스로 이동해서 @Component를 추가해보겠습니다.

@Component
public class MemoryMemberRepository implements MemberRepository{
    private static Map<Long, Member> store = new HashMap<>();
    @Override
    public void save(Member member) {
        store.put(member.getId(), member);
    }

    @Override
    public Member findById(Long memberId) {
        return store.get(memberId);
    }
}

그리고, RateDiscountPolicy 클래스, MemberServiceImpl로 이동해서 똑같이 위에 @Component를 추가해주면 됩니다.

 

근데, 이렇게 자동으로 스프링 빈이 등록되면 설정 정보 자체가 없는데, 의존관계 주입을 어떻게 해줄 수 있을까요?

✔️그래서! 자동 의존관계 주입인 @Autowired가 필요합니다.

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

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

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }

    //테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

요렇게 말이죠!

@Autowired는 마치.. ac.getBean(MemberRepository.class)처럼 동작합니다.

더 자세한 내용은 밑에서 설명하도록 하겠습니다.

 

그리고, OrderServiceImpl에도 @Component와 @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;
    }

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);

        return new Order(memberId, itemName, itemPrice, discountPrice);
    }

    //테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

@Autowired를 사용하면 생성자에서 여러 의존관계도 한 번에 주입받을 수 있습니다.

 

테스트 코드를 한 번 짜보도록 하겠습니다.

test 패키지의 hello.core에서 scan이란 패키지를 만들고, 그 안에 AutoAppConfigTest라는 클래스를 만들어보겠습니다.

public class AutoAppConfigTest {

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

        //빈 조회
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

테스트를 실행해보겠습니다.

AutoAppConfigTest 실행 결과

AppConfig 때 처럼 잘 작동하는 것을 볼 수 있습니다.

 

 

1-1. 컴포넌트 스캔과 자동 의존관계 주입 동작 방법 그림

그럼 컴포넌트 스캔과 자동 의존관계 주입은 어떻게 동작할까요?

그림으로 동작하는 과정을 봐보도록 하겠습니다.

 

1-1(1). @ComponentScan

1. @ComponentScan

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록합니다. (당연히 싱글톤으로 등록!)

이 때, 스프링 빈의 기본 이름은 클래스 명을 사용하되, 맨 앞 글자만 소문자를 사용합니다. (주의할 점⚠️)

• 빈 이름 기본 전략: MemberServiceImpl 클래스 👉🏻 memberServiceImpl
• 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면, @Component("memberService2") 이런 식으로!
  • 꼬옥 구현체에 해야 합니다.
  • 특수한 경우에만 직접 지정하면 됩니다.

 

1-1(2). @Autowired 의존관계 자동 주입

2. @Autowired 의존관계 자동 주입

생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입합니다.

이 때, 기본 조회 전략은 타입이 같은 빈을 찾아서 주입합니다. (ex. MemberRepository와 타입이 같은 것은 MemoryMemberRepository)

• getBean(MemberRepository.class)와 동일하다고 보면 됩니다.
• 더 자세한 내용은 뒤에서 설명할 예정

2. @Autowired 의존관계 자동 주입

생성자에 파라미터가 많아도 다 찾아서 자동으로 주입합니다.

---

2. 탐색 위치와 기본 스캔 대상

2-1. 탐색할 패키지의 시작 위치 지정

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸립니다.

그래서, 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있습니다.

AutoAppConfig 클래스로 이동해보겠습니다.

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

}

✔️basePackages는 탐색할 패키지의 시작 위치를 지정합니다. 즉, 이 패키지를 포함해서 하위 패키지를 모두 탐색합니다.

basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있습니다.

@Configuration
@ComponentScan(
        basePackages = "hello.core",
        basePackageClasses = AutoAppConfig.class,
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {

}

✔️basePackageClasses는 지정한 클래스의 패키지를 탐색 시작 위치로 지정합니다.

만약에 지정하지 않으면, @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됩니다.

<권장하는 방법>

개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것입니다.
최근 스프링 부트도 이 방법을 기본으로 제공합니다.

ex ) 프로젝트가 다음과 같은 구조로 되어 있다고 가정해보겠습니다.
- com.hello
- com.hello.service
- com.hello.repository

com.hello👉🏻 프로젝트 시작 루트
여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략합니다.
(우리가 하는 예제로는 AutoAppConfig가 여기에 해당)

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 됩니다.
그리고, 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다고 생각합니다.
참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례 입니다. (이 설정 안에 @ComponentScan이 들어있기 때문입니다.)

 

 

2-2. 컴포넌트 스캔 기본 대상

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

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

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

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}

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

 

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

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

참고!! useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외됩니다.
그냥 이런 옵션이 있구나.. 정도 알고 넘어가면 됩니다.

---

3. 필터

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

필터는 이렇게 2가지 종류가 있고, 빠르게 예제로 확인해보도록 하겠습니다.

3-1. 예제

test 패키지의 hello.core의 scan 이라는 패키지에 filter라는 패키지를 만들어보겠습니다.

그리고, 이 패키지 안에 MyIncludeComponent라는 Annotation을 만들어보겠습니다.

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

이 애노테이션은 컴포넌트 스캔 대상에 추가할 애노테이션 입니다.

 

요번에는 이름을 MyExcludeComponent로 애노테이션 명을 지정해볼게요.

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

이 애노테이션은 컴포넌트 스캔 대상에서 제외할 애노테이션 입니다.

 

그리고, filter 패키지 안에 클래스를 2개 만들어볼거에요.

클래스 명은 BeanA, BeanB로 해보겠습니다.

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

그리고, 테스트 코드를 만들어보겠습니다.

Filter 패키지 안에 ComponentFilterAppConfigTest 클래스를 만들어보겠습니다.

public class ComponentFilterAppConfigTest {

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

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

이 클래스 안에 static으로 해서 ComponentFilterAppConfig 설정 정보 클래스를 만들어줬습니다.

위에는 @ComponentScan으로 해서 아까 만들었던 MyIncludeComponent, MyExcludeComponent를 사용했습니다.

@ComponentScan.Filter를 static import 해서 @Filter로 줄여도 됩니다.

 

우선, beanA를 조회했습니다.

beanA는 결과가 어떻게 나오는지 봐보겠습니다.

beanA 조회 결과

이 상태에서 beanB를 조회하는 코드를 추가해보겠습니다.

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

테스트 결과는 어떻게 나올까요?

beanB 조회 결과

BeanB가 없다고 나옵니다.

왜냐하면, BeanB를 MyExcludeComponent해서 excludeFilter로 지정해놨기 때문에 컴포넌트 스캔 제외 대상이 되어버려서 이렇게 NoSuchBeanDefinitionException 이라는 오류가 뜨게 됩니다.

 

BeanB도 검증 코드를 추가해보겠습니다.

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

이 에러가 나야 테스트 성공인데

beanB 검증 테스트 결과

테스트가 아주 잘 실행이 되었습니다.

 

정리를 해보자면..

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

• includeFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록됩니다.
• excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않습니다.

 

3-2. FilterType 옵션

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

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

예를 들어서 BeanA도 빼고 싶으면 다음과 같이 추가하면 됩니다.

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

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

---

4. 중복 등록과 충돌

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

상황은 총 2가지가 있습니다.

 

4-1. 자동 빈 등록 vs 자동 빈 등록

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

• ConflictingBeanDefinitionException 예외 발생
• ex) MemberService의 @Component("Service")가 있는데, OrderService의 @Component("Service")로 똑같이 이름을 지었을 때
• 근데, 거의 일어나지 않습니다.

 

4-2. 수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까요?

@Component
public class MemoryMemberRepository implements MemberRepository {}

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

		@Bean(name = "memoryMemberRepository")
        public MemberRepository memberRepository() {
        	return new MemoryMemberRepository();
        }
}

이 경우 수동 빈 등록이 우선권을 가집니다.

(수동 빈이 자동 빈을 오버라이딩 해버립니다.)

<수동 빈 등록 시 남는 로그⚠️>

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

몰론 개발자가 의도적으로 이런 결과를 기대했다면, 자동보다는 수동이 우선권을 가지는 것이 좋습니다.

하지만, 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분입니다.

그렇게 되면 정말 잡기 어려운 버그가 만들어집니다. 항상 잡기 어려운 버그는 애매한 버그다..!!

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

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

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

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

 

중요한거..

명확하지 않은 것은 하지 맙시다!! 애매하고 아리까리한 것은 집어치워!

---

오늘도 이렇게 끝이 났습니다!!

다음 섹션에서는 의존관계 자동 주입에 관해서 해볼 것입니다.

중요한 만큼 무진장 길어요..ㅎ 공부하기 시르다.. 흑

그럼 안뇽!!