Spring - 컴포넌트 스캔(컴포넌트 스캔과 의존관계 자동 주입 시작하기, 탐색 위치와 기본 스캔 대상)

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

• 지금까지 스프링 빈 등록할 때 자바 코드의 @Bean이나 XML의 <bean> 등을 통해 직접 나열했다.
  • 이렇게 등록할 스프링 빈이 기하급수적으로 많아지면 등록하기 귀찮으며 누락될 수 있다.
  • 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공함
  • 또 의존관계를 자동으로 주입하는 @Autowired라는 기능도 제공한다

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))
// (excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))는 원래 AppConfig를 제외하기 위함
public class AutoAppConfig {

}

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다
• 기존 AppConfig와 다르게 @Bean으로 등록한 클래스가 하나도 없다.
• (excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))
  • 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동 등록되기 때문에 AppConfig, TestConfig등 앞에 만들었던 설정 정보도 함께 등록이 되기 때문에 excludeFilters를 사용하여 설정 정보는 컴포넌트 스캔 대상에서 제외
  • 보통은 설정 정보를 컴포넌트 스캔 대상에서 제외하지 않지만 기존 예제를 유지하기 위해 씀.
• @ComponentScan은 말 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다
  • @Configuration이 컴포넌트 스캔의 대상이 된 이유도 @Configuration를 열어보면 @Componenet가 붙어있기 때문.

@Component, @Autowired

• MemoryMemberRepository @Component 추가
• RateDiscountPolicy @Component 추가
• MemberServiceImpl @Component, @Autowired 추가
• OrderServiceImpl @Component, @Autowired 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy{
    /*
    ...
    */

@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는 자동으로 의존관계를 주입한다.
  • 생성자에 붙여줘야 하며, 여러 의존관계도 한번에 주입받을 수 있다.

테스트

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를 사용하는 것은 기존과 동일
• 설정 정보로 AutoAppConfig를 넘겨줌

동작 방식

1. @ComponentScan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록함.
• 스프링 빈의 기본 이름은 클래스명을 사용하되, 맨 앞글자만 소문자를 사용
  • 기본 : MemberServiceImpl 클래스 -> memberServiceImpl
  • 직접 지명 : @Component("memberService2")와 같이 부여하면 됨.

2. @Autowired

• 생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
• 기본 조회 전략은 타입이 같은 빈을 찾아서 주입
  • getBean(XXX.class)와 동일하다고 이해하자

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

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치를 지정할 수 있다.

모든 자바 클래스를 스캔하려면 오래 걸리기 때문에 꼭 필요한 위치부터 탐색하도록 시작 위치를 정할 수 있음.

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

• basePackages
  • 탐색할 패키지의 시작 위치 지정
  • 해당 패키지 포함 하위 패키지 모두 탐색
  • basePackages = {"hello.core", "hello.service"}와 같이 여러 시작 위치 지정 가능.
• basePackageClasses
  • 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 지정하지 않을 때는 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨.

권장

어차피 지정하지 않을 때는 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 되기 때문에 설정 정보 클래스의 위치를 프로젝트 최상단에 두도록 하자.

프로젝트가 다음과 같이 구성되어 있을 때

• com.hello
• com.hello.serivce
• com.hello.repository

com.hello에 설정 정보 클래스룰 두고 basePackages지정을 생략!

참고

스프링 부트를 사용할 때 @SpringBootApplication가 붙은 클래스가 프로젝트 최상단에 있다.
이유는 @SpringBootApplication에 @ComponentScan이 붙어있기 때문!

컴포넌트 스캔의 기본 대상

컴포넌트 스캔은 @Component뿐 아니라 다음 내용도 추가로 포함한다. 또 다음 어노테이션들은 부가 기능을 수행한다

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

출처 : 인프런 김영한 지식공유자님의 스프링 완전 정복 로드맵 강의