[Spring] 6.컴포넌트 스캔

[Spring] 6.컴포넌트 스캔

 

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

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

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

- 의존관계도 자동으로 주입하는 @Autowired 기능 제공

 

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

AutoAppConfig

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

- @ComponentScan : @Component 붙은 클래스 자동으로 찾아서 스프링 빈으로 등록

- exludeFilters -> 뺄거 지정 (Configuration 기존 예제 때문에)

 

@Component추가

- MMRepo, DiscountPolicy, ServiceImpl(Member, Order)

 

@Autowired추가 (자동 의존관계 주입)

- ServiceImpl (Member, Order)

 

테스트

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은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록

- 이때 스프링 빈의 기본 이름은 클래스 명으로 등록하되 맨 앞글자 소문자로 사용

   빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl

   빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

 

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

- 생성자에 @Autowired 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈 찾아서 주입

- 기본 전략 : 타입이 같은 빈 찾아서 주입

- getBean(MemberRepository.class) 와 동일하다고 이해하면 됨

 

- 생성자 많아도 다 찾아서 주입해줌

---

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

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

- 꼭 필요한 위치부터 탐색 시작하도록 설정 가능

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

- basePackages : 탐색할 패키지의 시작 위치 지정 / 이 패키지를 포함해서 하위 패키지를 모두 탐색

- 여러 위치도 설정 가능 (basePackages = {"hello.core", "hello.service"})

- basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위로 지정

 

권장법 -> 패키지 위치 지정X,설정 정보 클래스 위치를 프로젝트 최상단에 두기

* 참고) 스프링부트 : @SpringBootApplication (스프링부트 대표 시작 정보)를 프로젝트 시작 루트 위치에 두는 것이 관례

-> 이 설정 안에 @CompentScan이 들어있음

 

컴포넌트 스캔 기본 대상 

- @Component : 컴포넌트 스캔에 사용

- @Controller : 스프링 MVC 컨트롤러에 사용

- @Service : 스프링 비즈니스 로직에 사용

- @Repository : 스프링 데이터 접근 계층에서 사용

- @Configuration : 스프링 설정 정보에서 사용

 

 * 참고) 스프링에는 상속관계 없음

 

부가 기능

- @Controller : 스프링 MVC 컨트롤러로 인식

- @Repository : 스프링 데이터 접근 계층으로 인식 / 데이터 계층 예외를 스프링 예외로 변환

- @Configuration : 스프링 설정 정보로 인식 / 스프링 빈이 싱글톤 유지하도록 추가 처리

- @Service : 특별 처리 없음 / 개발자들이 핵심 비즈니스 로직 인식 쉽게

 

* 참고) useDefaultFilters : 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외 

---

3. 필터

종류

- includeFilters : 컴포넌트 스캔 대상을 추가로 지정

- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정

 

컴포넌트 스캔 대상에 추가할 annotation

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

컴포넌트 스캔 대상에 제외할 annotation

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

컴포넌트 스캔 대상에 추가할 class

@MyIncludeComponent
public class BeanA {
  }

컴포넌트 스캔 대상에 제외할 class

@MyExcludeComponent
public class BeanB {
  }

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

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 옵션 (5가지)

- 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

 

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

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

> 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

---

4. 중복등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

1) 자동 빈 등록 vs 자동 빈 등록

2) 수동 빈 등록 vs 자동 빈 등록

 

1) 자동 빈 등록 vs 자동 빈 등록

-> 멤버서비스와 오더서비스 둘다 @Component("sevice") 중복

-> ConflictingBeanDefinitionException 예외 발생

 

2) 수동 빈 등록 vs 자동 빈 등록

->

  @Configuration
  @ComponentScan(
          excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
  )
  public class AutoAppConfig {
      @Bean(name = "memoryMemberRepository")
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
      }
  }

이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)

* 수동 빈 등록시 남는 로그

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

* 스트링부트에서 수동 빈 vs 자동 빈 충돌나면 오류가 발생하도록 변경

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

스프링 부트인 CoreApplication 을 실행해보면 오류를 볼 수 있다.