인프런 스프링 기본 강의 정리 #6

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

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서

설정 정보에 직접 등록할 스프링 빈을 나열했다. 이러한 과정을 생략하고자 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 또한  의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

 

이를 알아보고자 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고,

src/main/java에 새로운 AutoAppConfig 클래스를 생성한다.

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 : 스프링 애플리케이션에서 자동으로 컴포넌트를 검색하고, 해당 컴포넌트들을 스프링 애플리케이션 컨텍스트에 빈으로 등록하는 어노테이션이다. 이때 스캔 대상이 되는 컴포넌트들은 @Component 등이 붙은 클래스이다.

 

컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, 

excludeFilters를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.

 

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙인다.

MemoryMemberRepostiroy와 RateDiscountPolicy 클래스에 @Component 어노테이션을 추가한다.

@Component
public class MemoryMemberRepository implements MemberRepository {
}

 

@Component
public class RateDiscountPolicy implements DiscountPolicy{
}

 

MemberServiceImpl과 OrderServiceImpl 클래스에는 @Component와 @Autowired를 추가해준다.

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

    @Autowired // ac.getBean(MemberRepository.class)
    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;
    }
}

@Autowired : 스프링이 해당 타입의 빈을 찾아 의존성을 자동으로 주입하는 어노테이션이다. 

 

이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다.

이제는 이런 설정 정보 자체가 없기 때문에, @Autowired를 사용해서 의존관계를 자동으로 주입해준다.

 

이를 테스트하고자 src/test/java에 scan 패키지를 생성하고, AutoAppConfigTest 클래스를 생성한다.

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

AppConfig와 동일한 결과를 출력하는 것을 알 수 있다.

 

- @ComponentScan

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

- @Autowired 의존관계 자동 주입

스프링 컨테이너가 자동으로 타입이 같은 빈을 찾아서 주입한다.

-> getBean(MemberRepository.class) 와 동일

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

2. 탐색 위치와 기본 스킨 대상

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

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.                                         basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

@ComponentScan(
    basePackages = "hello.core",
    basePackageClasses = AutoAppConfig.class;
}

 

이 외에 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것도 좋은 방법이다.

프로젝트 시작 루트에 AppConfig와 같은 메인 설정 정보를 두고, @ComponentScan 어노테이션을 붙이면 basePackages 지정은 생략 가능하다. 이렇게 되면 하위 클래스까지 모두 자동으로 컴포넌트 스캔의 대상이 된다.

 

cf) 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위치에 두는 것이 관례이다.

 

- 컴포넌트 스캔 기본 대상

  다음 어노테이션들은 모두 소스 코드에 @Component를 포함하고 있다.

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

다음 어노테이션들은 컴포넌트 스캔의 용도 뿐만 아니라 스프링의 부가 기능을 수행한다. 참고로만 알아두자.

• @Controller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
• @Service : 특별한 처리를 수행하지 않지만, 비즈니스 계층을 인식하는데 도움이 됨

3. 필터

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

이를 확인해보기 위해 먼저 src/test/java/scan에 filter 패키지를 생성한다.

filter 패키지 안에 MyIncludeComponent와 MyExcludeComponent 어노테이션 클래스를 생성한다.

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented

public @interface MyIncludeComponent {

}

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented

public @interface MyExcludeComponent {

}

다음으로 각 인터페이스를 적용할 클래스인 BeanA와 BeanB 클래스를 filter 패키지에 생성한다.

@MyIncludeComponent
public class BeanA {

}

@MyExcludeComponent
public class BeanB {

}

 

이를 확인하기 위한 테스트 코드를 작성해보자.

src/test/java/scan/filter에 ComponentFilterAppConfigTest 클래스를 생성한다.

import org.junit.jupiter.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.assertThat;
import static org.springframework.context.annotation.ComponentScan.Filter;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class));
    }

    @Configuration
    @ComponentScan(
    
            //@MyIncludeComponent 어노테이션이 있는 클래스만 스캔 대상으로 지정
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            //@MyExcludeComponent 어노테이션이 클래스는 스캔에서 제외
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )

    static class ComponentFilterAppConfig {
    }
}

 

Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class));

assertThrows 메서드는 주어진 코드 블록(() -> ac.getBean("beanB", BeanB.class))이 예외를 발생시키는지를 테스트한다.

NoSuchBeanDefinitionException.class는 기대하는 예외의 타입을 나타냅니다. 즉, ac.getBean("beanB", BeanB.class)가 해당 빈을 찾을 수 없어서 NoSuchBeanDefinitionException 예외가 발생해야 한다는 것을 검증한다.

 

@ComponentScan(

 includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
 
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)

• includeFilters 에 MyIncludeComponent 어노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilters 에 MyExcludeComponent 어노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

- FilterType 옵션

• 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

ASSIGNABLE_TYPE을 이용해서 BeanA를 빼는 코드를 생성할 수 있다.

@ComponentScan(

 includeFilters = {
 @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
 },
 
 excludeFilters = {
 @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class),
 @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
 }
)

@MyIncludeComponent 애노테이션이 붙은 클래스들은 포함하고, @MyExcludeComponent 애노테이션이 붙은 클래스들 및 BeanA.class와 같은 특정 타입의 클래스들은 스캔 대상에서 제외하도록 설정한다.

 

4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름이 등록되는 경우가 발생할 수 있다.

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

- 자동 빈 등록 vs 자동 빈 등록

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

 

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

위 코드는 memoryMemberRepository라는 이름의 빈이 중복된 경우이다.

 

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

이 경우 위와 같은 로그가 출력되면서 값이 오버라이딩 됨을 알 수 있다.

 

그러나 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

그렇기 때문에 스프링 부트인 CoreApplication 을 실행해보면 오류가 발생한다.