[ Spring ] Component Scan

---

Component Scan

 

컴포넌트 스캔이란 스프링이 스프링 빈(Bean)으로 등록될 준비가 된 클래스들을 스캔하여 빈(Bean)으로 등록해 주는 과정을 말합니다.

 

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>등을 통해서 설정 정보에 직접 등록한 빈을 나열했는데, 만약 스프링 빈이 수십, 수백 개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생합니다.

 

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공합니다. 또 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공합니다.

 

그럼 예제 코드는 AutoAppConfig.java 파일을 생성해서 진행하겠습니다.

 

AutoAppConfig.java

 

package hello.core;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.springframework.context.annotation.ComponentScan.*;

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

 

컴포넌트 스캔을 사용하려면 위 예제 코드처럼 @ComponentScan을 설정 정보에 붙여줘야 합니다.

 

참고로 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에, 이전에 Config 파일을 설정 정보에 등록되어 있다면, 같이 실행되어 버립니다. 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했습니다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법도 사용할 수 있습니다.

 

그럼 다음으로 클래스를 스프링 빈으로 등록해 보겠습니다. 컴포넌트 스캔은 이름 그대로 @Component 애노테이션을 활용하시면 됩니다.

 

MemoryMemberRepository.java

 

@Component
public class MemoryMemberRepository implements MemberRepository {}

 

RateDiscountPolicy.java

 

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

MemberServiceImpl.java

 

@Component
public class MemberServiceImpl implements MemberService {
 private final MemberRepository memberRepository;
 
 @Autowired
 public MemberServiceImpl(MemberRepository memberRepository) {
 this.memberRepository = memberRepository;
 }
}

 

이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했습니다. 컴포넌트 스캔은 그러한 설정 정보 자체가 없기 때문에, 의존관계 주입도 클래스 안에서 해결해야 합니다.

 

@AutoWired는 의존관계를 자동으로 주입해 줍니다. 

 

OrderServiceImpl.java

 

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

 

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

 

그렇다면 정상적으로 동작하는지 테스트 코드를 통해서 알아봅시다.

 

AutoAppConfigTest.java

 

package hello.core.scan;
import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;

public class AutoAppConfigTest {

 @Test
 void basicScan() {
 ApplicationContext ac = new
AnnotationConfigApplicationContext(AutoAppConfig.class);
 MemberService memberService = ac.getBean(MemberService.class);
 assertThat(memberService).isInstanceOf(MemberService.class);
 }
}

 

AnnotationConfigApplicationContext를 사용하는 것은 이전 포스팅에서 알아본 스프링 빈 테스트와 동일합니다.

 

스프링 빈에 대해서 궁금하신 분들은 아래 포스팅 참고해 보시면 좋을 거 같습니다.

[ Concept ] 스프링 컨테이너와 스프링 빈

 

설정 정보로 AutoAppConfig 클래스를 넘겨주고 실행시켜 보면 기존과 같이 잘 동작하는 것을 확인할 수 있습니다.

정상적인 출력은 콘솔창에 나오는 로그를 보시면 확인할 수 있습니다.

 

ClassPathBeanDefinitionScanner - Identified candidate component class:
.. RateDiscountPolicy.class
.. MemberServiceImpl.class
.. MemoryMemberRepository.class
.. OrderServiceImpl.class

 

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

 

@ComponentScan

 

 

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

 

@Autowired 의존 관계 자동 주입

 

 

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

---

마치며

 

오늘은 컴포넌트 스캔에 대해서 알아봤습니다.

김영한 님 강의를 중점으로 보면서 실무에 필요한 기술 및 개념에 대해서 공부하다 보니

메모를 하는 날이 많아지는 거 같습니다..^^ 

다음 포스팅에서 뵙겠습니다.