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

[6om1n]

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

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

• 코드로 컴포넌트 스캔과 의존 관계 자동 주입을 알아보자
• AutoAppConfig.java

package hello.core;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.*;

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

    }
}

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
• 기존의 AppConfig 와는 다르게 @Bean 으로 등록한 클래스가 하나도 없다.

📌 참고

컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
따라서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해 이 방법을 선택하였다.

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

📌 참고

@Configuration 이 컴포넌트 스캔의 대상이 된 이유도 Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.
@Component 를 사용하면 의존 관계 주입을 할 수 없기 때문에 자동 의존 관계 주입이 필요하다. @Autowired 필요 !!

• MemoryMemberRepository 에 @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

• RateDiscountPolicy 에 @Component 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

• MemberServiceImpl 에 @Component, @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

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

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

• 이전에 AppConfig 에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야한다.

• @Autowired 는 의존관계를 자동으로 주입해준다.

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

• AutoAppConfigTest.java

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class AutoAppConfigTest {

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

        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

• AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하다.
• 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
• 실행해보면 기존과 동일하게 동작하는 것을 확인할 수 있다.

로그를 통해 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다.

• 컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는 지 그림으로 확인해보자

1. @ComponentScan
   

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

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

  • 빈 이름 기본 전략 : MemberServiceImpl 클래스 ▶️ memberServiceImpl
  • 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶은 경우 @Component("memberService2") 이렇게 부여하면 된다.
  • 빈 이름 직접 지정은 구현체에다가 해주면 된다.

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

• 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 이 때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
  • getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.
  • MemberServiceImpl 의 생성자는 스프링 컨테이너에 있는 memberRepository 를 타입으로 찾는다.
  • 이 때, 같은 타입이 여러 개 일경우 충돌이 난다.

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

🐣 정리

• AutoConfig 를 보면 @ComponentScan 을 보고 자동으로 찾아서 안에 있는 것들을 스프링 빈에 저장해준다.
• @Component 가 붙은 걸 찾아서 스프링 컨테이너에 등록을 해준다.
• 이 때, 자동으로 등록했을 때의 문제점은 의존 관계를 주입할 수 있는 방법이 없다는 것이다.
• 따라서 @Autowired 를 통해서 의존 관계를 자동으로 등록해준다.
• 이 전에 수동으로 할 때는 설정정보에 다 저장해주었다.

---

탐색 위치와 기본 스캔 대상

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

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

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

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

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

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

📍 권장하는 방법

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장한다.
예를 들어서 프로젝트가 다음과 같은 구조로 되어있을 때

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

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

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

컴포넌트 스캔 기본 대상

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

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

📌 참고

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

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

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

📌 참고

useDefalutFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.

---

필터

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

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

• test/filter/MyIncludeCompoment

package hello.core.filter;

import java.lang.annotation.*;


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

}

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

• test/filter/MyExcludeComponent

package hello.core.filter;

import java.lang.annotation.*;


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

}

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

• test/filter/BeanA

package hello.core.filter;
@MyIncludeComponent
public class BeanA {
}

• @MyIncludeComponent 적용

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

• test/filter/BeanB

package hello.core.filter;
@MyExcludeComponent
public class BeanB {
}

• @MyExcludeComponent 적용

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

• test/filter/ComponentFilterAppConfigTest

package hello.core.filter;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

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

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

---

중복 등록과 충돌

• 컴포넌트 스캔에서 같은 빈 이름을 등록하는 경우는 두 가지 상황이 있다.

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

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

• 이 경우는 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다. )
• 수동 빈 등록시 남는 로그
  

• 물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다.
• 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다!
• 그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.
• 그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

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

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

🐣 정리

• 어설픈 추상화나 어설픈 우선순위보다 코드를 좀 더 길게 쓰더라도 명확하게 작성하거나 빨리 오류를 내서 튕기는 것이 낫다.

---