6. 컴포넌트 스캔

6. 컴포넌트 스캔

---

• 6. 컴포넌트 스캔
  • 핵심 정리
    • 핵심 요약:
    • 핵심 키워드 설명:
  • 컴포넌트 스캔과 의존관계 자동 주입 시작하기
    • 컴포넌트 스캔과 자동 의존관계 주입 작동 프로세스
  • 탐색 위치와 기본 스캔 대상
    • 탐색할 패키지의 시작 위치 지정
      • 컴포넌트 스캔 기본 대상
  • 필터
    • FilterType 옵션
  • 중복 등록과 충돌
    • 자동 빈 등록 vs 자동 빈 등록
    • 수동 빈 등록 vs 자동 빈 등록

---

핵심 정리

핵심 요약:

1. 컴포넌트 스캔과 의존관계 자동 주입:

   • 컴포넌트 스캔은 클래스에 @Component 애노테이션이 붙은 객체를 자동으로 스프링 빈으로 등록하는 기능이다. 이를 통해 별도의 설정 없이도 빈을 등록할 수 있다.
   • @Autowired는 의존관계를 자동으로 주입하는 애노테이션이다. 스프링이 자동으로 빈을 찾아 주입한다.
   • 스프링은 컴포넌트 스캔을 통해 빈을 등록할 때, 기본적으로 클래스 이름을 소문자로 변환한 이름을 빈의 이름으로 사용한다.

   컴포넌트 스캔 설정 코드:

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

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

   • basePackages 속성을 통해 스캔할 패키지의 시작 위치를 지정할 수 있다.
   • 기본적으로 @Component, @Controller, @Service, @Repository, @Configuration 애노테이션이 붙은 클래스들이 스캔 대상이 된다.
   • 스프링 부트에서는 @SpringBootApplication에 @ComponentScan이 포함되어 있어, 이 설정을 통해 최상위 패키지부터 스캔한다.

3. 필터:

   • includeFilters: 컴포넌트 스캔 대상에 추가할 애노테이션이나 클래스를 지정할 수 있다.
   • excludeFilters: 컴포넌트 스캔에서 제외할 애노테이션이나 클래스를 지정할 수 있다.

   필터 사용 예시:

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

4. 중복 등록과 충돌:

   • 자동 빈 등록 vs 자동 빈 등록: 이름이 같은 자동 빈을 등록하려 하면 ConflictingBeanDefinitionException이 발생한다.
   • 수동 빈 등록 vs 자동 빈 등록: 수동 빈과 자동 빈의 이름이 충돌하면 최근 스프링 부트에서는 기본적으로 오류가 발생한다. 이를 방지하려면 설정에서 spring.main.allow-bean-definition-overriding=true를 적용할 수 있다.

핵심 키워드 설명:

1. 컴포넌트 스캔:
   • @Component 애노테이션이 붙은 클래스들을 스프링이 자동으로 스캔하여 빈으로 등록하는 기능.
   • 별도의 설정 없이도 자동으로 의존성을 관리할 수 있어 개발 편의성이 높아진다.
2. 의존관계 자동 주입 (@Autowired):
   • 스프링 컨테이너가 관리하는 빈들 간의 의존성을 자동으로 연결해 주는 기능.
   • 생성자, 필드, 메서드에 적용할 수 있으며, 주로 생성자 주입을 권장한다.
3. 필터링 (includeFilters, excludeFilters):
   • 컴포넌트 스캔 대상에서 특정 클래스나 애노테이션을 포함하거나 제외시키는 기능.
   • 주로 예외적인 경우에 사용하며, 일반적으로는 기본 스캔 대상을 사용한다.
4. 빈 충돌:
   • 동일한 이름의 빈이 여러 번 등록될 때 발생하는 문제.
   • 수동 빈 등록과 자동 빈 등록의 충돌을 방지하려면 스프링 부트 설정에서 allow-bean-definition-overriding을 조정할 수 있다.

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

• 컴포넌트 스캔 : 설정 정보가 없어도 자동으로 스프링 빈을 등록
• @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))
public class AutoAppConfig {

}

• 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
  • 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다!
  • 컴포넌트 스캔은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

참고: 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다.

참고: @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @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;
    }
}

OrderServiceImpl @Component, @Autowired 추가

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

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

1. @ComponentScan
   1. 
   2. @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
   3. 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
      1. 빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl
      2. 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면
      3. @Component("memberService2") 이런식으로 이름을 부여하면 된다.
2. @Autowired 의존관계 자동 주입
   1. 
   2. 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
   3. 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다
3. 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다
   1. 

탐색 위치와 기본 스캔 대상

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

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

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

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

권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.

스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정 안에 바로 @ComponentScan 이 들어있다)

또는 프로젝트 시작 루트에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다. 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

컴포넌트 스캔 기본 대상

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

필터

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

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

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 {
}

@MyIncludeComponent 적용

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

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

@MyExcludeComponent 적용

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

package hello.core.scan.filter;

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(
        includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {
    }
}

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

참고: @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters
는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.

중복 등록과 충돌

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

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

Reference

• 인프런 김영한 강의 - 스프링 핵심 원리 - 기본편