[Spring] 기본편 06. 컴포넌트 스캔

이 글은 스프링 [핵심원리 - 기본편]을 듣고 정리한 내용입니다.

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

• 지금까지는 스프링 빈을 등록할 때,자바코드의 @Bean이나 XML의 <bean>을 통해 설정 정보(appConfig)에 직접 등록할 스프링 빈을 나열했다.

• 스프링 빈이 많아지면 설정 정보도 커지고 누락 위험이 있다.

• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 이라는 기능을 제공한다.

• 의존관계를 자동을 주입하는 @Autowired라는 기능도 제공한다.

• AutoAppConfig.class

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
// 기존 AppConfig.java는 과거 코드와 테스트를 위해 남겨두기 위한 코드
        excludeFilters =  @ComponentScan.Filter(type= FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
// 텅 비어있음

}

• 컴포넌트 스캔을 사용하려면 먼저 클래스 앞에 @ComponentScan을 설정 정보에 붙여주면 된다.
• 코드르 보면 기존 AppConfig코드와 다르게 @Bean으로 등록한 클래스가 하나도 없다.
• *참고 : 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정정보도 자동으로 등록되기 때문에, excludeFilters를 이용해서 이전 설정정보들을 컴포넌트 스캔 대상에서 제외했다.
• 이제 빈으로 등록하려던 각 클래스에 컴포넌트 스캔의 대상이 되도록 @Component를 붙인다.

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

• 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성하고, 의존관계도 직접 명시했었다.
• 이제는 이런 설정정보 자체가 없으므로 @Autowired 를 통해 의존관계 주입을 각 클래스 내에서 해결 해야한다.
• OrderServiceImpl에도 @Component, @Autowired 추가

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;
  
    @Autowired // 생성자에서 여러 의존관계도 한번에 주입 받을 수 있음.
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

}

• AutoAppConfigTest.class

package hello.core.scan;

public class AutoAppConfigTest {

    @Test
    void basicScan(){
    //AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일.
    //설정정보로 AutoAppConfig 클래스를 넘겨준다.
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

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

• 기존과 같이 테스트가 잘 동작한다.

• 로그를 살펴보면
  
• autoAppConfig, rateDiscountPolicy, memberServiceImpl, memoryMemberRepository가 싱글톤 빈으로 잘 생성되었다고 나온다
• 또 로그 아래 더 읽어보면 Autowired에 대한 정보도 나온다.

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

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 스프링 빈의 기본 이름은 클래스명을 사용하되, 맨 앞글자를 소문자로 쓴다.
  • 빈 이름 기본 전략 : MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정 : 스프링 빈의 이름을 직접 지정할수 있는데 @Component("memberService2 이런식으로 괄호안에 이름을 부여하면 된다

• 테스트를 돌려보면 부여한 이름이 잘 출력되는것을 볼 수 있다.
  

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 이때 기본적으로 타입이 같은 빈을 찾아서 주입한다.
  - getBean(MemberRepository.class) 기능과 동일하다고 이해하자.
  

• 생성자에 파라미터가 많아도 알아서 여러개를 자동으로 주입해준다.

📌 탐색 위치와 기본 스캔 대상

• 탐색할 패키지의 시작 위치 지정 - 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래걸리므로, 필요한 위치부터 탐색하도록 지정할 수 있다.

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

• basePackages: 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
• basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• Default: 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

@ComponentScan( // 만약 다음과 같이  memberPackages를 지정하면
        basePackages =   "hello.core.member", 

• 다음과 같이 member 패키지의 하위 패키지를 탐색한 결과가 나온다.

🌱 권장하는 방법

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두기. (스프링 부트도 이 방법을 기본으로 제공한다.)
• 현재 코드에서 AppConfig를 com.hello 패키지(프로젝트 시작 루트)에 두고, @ComponentScan 어노테이션을 붙이고, basePackages 지정은 생략.
• *참고: 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 을 이 프로젝트 시작 루트 위치에 두는것이 관례이다.
  ( 이 설정 안에 @ComponentScan이 들어있다.)

🌱 컴포넌트 스캔 기본 대상

• 컴포넌트 스캔은 @Component뿐만 아니라 다음 내용도 추가로 대상에 포함한다.
  • @Component: 컴포넌트 스캔에서 사용
  • @Controller: 스프링 MVC 컨트롤러에서 사용
  • @Service: 스프링 비즈니스 로직에서 사용
  • @Repository: 스프링 데이터 접근 계층에서 사용
  • @Configuration: 스프링 설정 정보에서 사용
• 해당 클래스의 소스코드에 들어가보면 @Component를 포함하고 있다.

@Component
public @interface Controller{
}

@Component
public @interface Service{
}

@Component
public @interface Configuration {
}

• *참고 : 어노테이션에는 상속 관계라는 것이 없다. 어노테이션이 특정 어노테이션을 포함하고 있는 것을 인식할 수 있는것은 자바 언어가 지원하는 기능이 아니라, 스프링이 지원하는 기능이다.

• 컴포넌트 스캔의 용도 뿐만 아니라 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.

  • @Controller: 스프링 MV 컨트롤러로 인식
  • @Repository: 스플이 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지할수 있도록 추가 처리를 한다.
  • @Service: 특별한 처리를 하지 않는 대신 개발자들이 핵심 비즈니스 로직이 여기에 있음을 인식하게 해준다.

  ---

📌 필터

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

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

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent { //컴포넌트 스캔 대상에 추가할 어노테이션

}

• 컴포넌트 스캔 대상에서 제외할 어노테이션

package hello.core.scan.filter;

import java.lang.annotation.*;

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

}

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

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

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

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

• 설정 정보와 전체 테스트 코드

package hello.core.scan.filter;

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)
            // includeFilter에 MyIncludeComponent 어노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
            // escludeFilter에 MyExcludeComponent에 어노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

    )
    static class ComponentFilterAppConfig{

    }

}

🌱 FilterType 옵션

• FilterType은 5가지가 있다.
  -
  - ANNOTATION: 기본값, 어노테이션을 인식해서 동작한다.
  • ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ASPECTJ: AspectJ 패턴 사용
  • REGEX: 정규 표현식
  • CUSTOM: TpyeFilter라는 인터페이스를 구현해서 처리
• *참고: @Component만 해도 충분해서, includeFilters를 사용할 일은 거의 없다. excludeFilters는 간혹 사용할 때도 있으나 거의 없긴함.
• 스프링 부트는 컴포넌트 스캔을 기본로 제공하는데, 기본 옵션을 사용하는것이 권장된다.

📌 중복 등록과 충돌

• 컴포넌트 스캔에서 같은 빈 이름 등록하는 경우

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

• 자동 빈 등록 vs 자동 빈 등록
  -> 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데 오류가 발생한다
  -> ConflictingBeanDefinitionException 예외 발생

• 수동 빈 등록 vs 자동 빈 등록

// 자동 빈 등록
@Component //memoryMemberRepository라는 이름으로 빈 등록됨. (클래스 이름에서 맨앞글자만 소문자니까)
public class MemoryMemberRepository implements MemberRepository {

// 수동 빈 등록
@Configuration
@ComponentScan(
        basePackages =   "hello.core.member",
        basePackageClasses = AutoAppConfig.class,
        excludeFilters =  @ComponentScan.Filter(type= FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
    @Bean(name="memoryMemberRepository")
    MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

}

• 이 경우 수동 빈 등록이 우선권은 가진다 -> 수동 빈이 자동 빈을 오버라이딩 해버린다.

• 수동 빈 등록시 남는 로그
  

• *주의:개발자가 의도적으로 수동빈을 등록한 거일수도 있지만, 현실은 개발자가 의도적으로 설정해서보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 많다.

• 그럼 정말 잡기 힘들어지는 버그이므로, 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌되면 오류가 발생하도록 기본값을 바꾸었다.

• CoreApplication(스프링 부트)을 실행하면 다음과 같은 오류가 나온다.
  
• 로그에 써있는 것처럼 application.properties 파일에 spring.main.allow-bean-definition-overriding=false 를 등록하면 오류가 발생하지 않는다.
• 이와 같이 스프링부트가 수동 빈 등록, 자동 빈 등록 오류시 오류를 발생시킨다.