Spring/김영한 스프링 핵심원리 - 기본편

[섹션6-1] 컴포넌트 스캔과 의존관계 자동주입

보름달빵 2024. 2. 20. 18:49

 

 

컴포넌트 스캔이 필요한 이유?

 

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

 

 

 

컴포넌트 스캔과 @Autowired

 

 

 

 

 

AutoAppConfig

  • 먼저 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig.java를 만들자. 
  • AutoAppConfig = 컴포넌트 스캔을 이용하는 설정 클래스 
@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION,classes = Configuration.class
        )
)
public class AutoAppConfig {
      // 설정 정보가 아무것도 없다!
}

 

  • AutoAppConfig 클래스도 설정 클래스 이므로 @Configuration 어노테이션을 사용한다. 
  • 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
  • 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION,classes = Configuration.class)
       )

 

이 코드는 @Configuration이 붙은 클래스는 스프링 빈으로 등록시키지 말라는 의미이다. 

 

컴포넌트 스캔이란? 
@Component 어노테이션이 붙은 클래스를 스캔해서 자동으로 스프링 빈으로 등록시켜주는 기능이다.  

 

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록  @Component 어노테이션을 붙여주자.

 

 

※ 참고 

 

 

그렇다면 AutoAppConfig는 어떨까? AutoAppConfig클래스에도 @Configuration을 붙여줬으므로 AppConfig 또한 빈으로 등록이 안되는걸까? 

 

테스트 실행을 통해 알아보자 

 

 

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
    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 는 의존관계를 자동으로 주입해준다.

 

AppConfig의 경우,  memberService ( )처럼 메서드를 호출하여 의존관계가 있는 객체를 주입해줬지만,  컴포넌트 스캔을 이용하는 AutoAppConfig의 경우 설정 정보 자체가 없다.  @Component을 보고 빈으로 등록해줄 뿐 의존관계를 주입해주라는 정보는 없다. 그래서 자동으로 의존관계를 주입해주는 방법이 필요하다.  ▶  @ Autowired  

 

 

 

 

 

AutoAppConfigTest 

  •  테스트 코드를 통해 컴포넌트 스캔을 통해서도 빈들이 잘 등록 되었는지 확인해보자 
public class AutoAppConfigTest {

    @Test
    @DisplayName("컴포넌트 스캔해서 스프링 빈 등록하기")
    void basicScan(){

        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(AutoAppConfig.class);

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

        // 등록된 모든 빈 조회하기
        for (String beanDefinitionName : ac.getBeanDefinitionNames()) {
            System.out.println("등록된 빈 = " + beanDefinitionName);
        }


    }
}

 

//실행결과 
등록된 빈 = org.springframework.context.annotation.internalConfigurationAnnotationProcessor
등록된 빈 = org.springframework.context.annotation.internalAutowiredAnnotationProcessor
등록된 빈 = org.springframework.context.annotation.internalCommonAnnotationProcessor
등록된 빈 = org.springframework.context.event.internalEventListenerProcessor
등록된 빈 = org.springframework.context.event.internalEventListenerFactory
등록된 빈 = autoAppConfig
등록된 빈 = rateDiscountPolicy
등록된 빈 = memberServiceImpl
등록된 빈 = memoryMemberRepository
등록된 빈 = orderServiceImpl

 

AutoAppConfigTest  실행 결과 빈들이 잘 등록되었음을 알 수 있다.

 

또한 로그를 보면 컴포넌트 스캔이 잘 작동하는 것을 알 수 있다. 

 

 

 // @Autowired 생성자 주입
 Autowiring by type from bean name 'memberServiceImpl' via constructor to bean named 'memoryMemberRepository'
 Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
 Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'

 

 

아까 위에서 @Configuration이 있는 클래스는 빈으로 등록하지않는 조건을 작성했는데 

AutoAppConfig는 왜 @Configuration 어노테이션이 있음에도 빈으로 등록되었을까? 

 

그 이유는 바로,  스프링 컨테이너의 설정정보로 AutoAppConfig를 전달해줬기 때문이다. 

 

 AnnotationConfigApplicationContext ac= new AnnotationConfigApplicationContext(AutoAppConfig.class);

 

AnnotationConfigApplicationContext는 Java 기반의 설정 클래스를 스캔하고 해당 클래스에서 정의된 빈들을 컨테이너에 등록하는 역할을 합니다. 그래서 AutoAppConfig 클래스를 전달하면, 이 클래스에서 정의된 빈들이 스프링 컨테이너에 등록된다. 

 

즉, @Configuration 어노테이션이 붙어 있더라도 스프링은 이를 구성 클래스로 간주하고 빈으로 등록하는 것이다. 

 

 

 

 

 

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

 

 

1. @ComponentScan

  • @ComponentScan은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
          - 빈 이름 기본 전략: MemberServiceImpl 클래스 →  memberServiceImpl 
          - 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름           을 부여하면 된다.

※ 참고 AppConfig 를 설정 클래스로 할때에는 메서드의 이름을 빈 이름으로 설정했었다. 

 

 

 

 

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

 

  • 생성자에  @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다. →  getBean(MemberRepository.class) 와 동일하다고 이해하면 된다
  • 하지만 타입으로 빈을 조회하는 방법에는 문제점이 있었다. 바로 같은 타입의 빈이 여러개인 경우 였다. 

 

그런데 같은 타입의 빈이 여러개인 경우 어떤 빈을 주입해줄까?  그리고 빈 이름을 지정해서 주입해줄 수는 없을까? 

 

이와 관련된 문제는 뒤에서 배워보도록 하자. 

 

 

  • 또한 생성자에 주입해줘야하는 객체가 여러개여도 다 찾아서 자동으로 주입해준다.