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

[seyxxn]

6_컴포넌트 스캔

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

• 지금까지는 스프링 빈을 등록할 때, 자바코드의 @Bean이나 XML의 <bean>을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열하는 방식을 사용했다.
• 등록해야 할 빈이 많아지면 불편하기 때문에 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 또한 의존 관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

새로운 파일 AutoAppConfig.java

@Configuration
@ComponentScan(
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)       // 예제를 안전하게 유지하기 위해서 순수 AppConfig가 만들어질까봐 제외해주는 과정
public class AutoAppConfig {

}

• 컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 붙여준다.
• 기존의 AppConfig와 다르게 @bean으로 등록한 클래스가 없다.
• 컴포넌트 스캔을 사용하면 @Configuraton이 붙은 설정 정보도 자동으로 등록된다.
  • 앞서 만들었던 AppConfig, TestConfig 등 만들어둔 설정 정보가 함께 등록되고 실행되어버린다.
  • 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외한다.
  • 기존의 예제의 코드를 삭제하지 않을 것이기 때문에 이러한 과정이 필요하다.

컴포넌트 애노테이션 추가

• 컴포넌트 스캔은 @Component 애노테이션이 붙은 클래스를 스캔하여 스프링 빈으로 등록한다.
  • @configuration 소스 코드를 타고 들어가보면 @Component 애노테이션이 붙어있다. 그래서 컴포넌트 스캔의 대상이 되었던 것이다.
• MemoryMemberRepository, RateDiscountPOlivy, MemberServiceImpl, OrderServiceImpl
  -> 위 클래스들이 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 모두 붙여준다.

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

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

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

• MemberServiceImpl, OrderServiceImpl에서는 의존 관계를 주입해야하기 때문에 @Autowired 애노테이션도 붙여줘야 한다.

테스트 코드 AutoAppconfigTest.java 작성

public class AutoAppConfigTest {
    @Test
    void basicScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class); // 설정 정보로 AutoAppConfig 넘김
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

• AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일
• 설정 정보로 AutoAppConfig 클래스를 넘겨준다.

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

1. @componentscan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록
• 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞 글자만 소문자를 사용
  • MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정도 가능. @Component("지정이름")

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

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
• 타입이 같은 빈을 찾아서 주입하는 방식
  • getBean(MemberRepository.class)와 동일

• 생성자에 파라미터가 많아도 모두 찾아 자동으로 주입

탐색 위치와 기본 스캔 대상

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

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

@ComponentScan (
    basePackages = "hello.core",
)

• basePackages : 탐색할 패키지의 시작 위치 지정, 이 패키지를 포함한 하위 패키지 모두 탐색
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 지정 X : @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작위치로 지정
• 권장사항 ) 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것

컴포넌트 스캔 기본 대상

• 컴포넌트 스캔은 @Component 뿐만아니라 다음의 것들도 대상에 포함된다.
  • @Component : 컴포넌트 스캔에서 사용
  • @Controller : 스프링 MVC 컨트롤러에서 사용
  • @Service : 스프링 비즈니스 로직에서 사용
  • @Repository : 스프링 데이터 접근 계층에서 사용
  • @Configuration : 스프링 설정 정보에서 사용
  • 위의 것들의 소스 코드들을 타고 들어가보면 모두 @Component를 포함하고 있다.
  • 애노테이션은 상속관계가 없고, 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 스프링이 지원하는 기능이다.
• 애노테이션의 부가기능
  • @Controller : 스프링 MVC 컨트롤러로 인식
  • @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터계층의 예외를 스프링 예외로 변환해준다.**
  • @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
  • @Service : 특별한 처리는 하지 않지만, 비즈니스 로직을 담고 있고 비즈니스 계층을 인식하는데 도움을 준다.

필터

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

테스트 코드로 확인

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

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

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

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

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

@MyIncludeComponent
public class BeanA {
}

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

@MyExcludeComponent
public class BeanB {
}

설정 정보와 전체 테스트 코드 ComponentFilterAppConfigTest.java

package hello.core.scan.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가 스프링 빈에 등록되지 않는다.

중복 등록과 충돌

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

컴포넌트 스캔에서 같은 빈 이름을 등록하여 충돌하는 경우는 위와 같이 2가지 경우가 존재한다.

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 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();
    }
}

[seyxxn]

Filter Type 옵션 정리 누락 ...