컴포넌트 스캔

유병익·2022년 10월 17일
Spring
0

스프링 핵심 원리

목록 보기
6/9
post-thumbnail

0. Review

  • 스프링 빈을 등록할 때는 자바 코드의 @Bean 또는 XML의 <bean> 등을 사용
  • 설정 정보에 직접 등록할 스프링 빈을 나열
  • 등록해야 할 스프링 빈이 수십, 수백개 → 등록하기 어려움, 설정 정보 누락 등 문제 발생

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

1.1 Component Scan

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

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

  1. 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
  2. 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주자.
  3. @Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.
  • Example
    • 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 {
 
}
    • MemoryMemberRepository
      @Component
public class MemoryMemberRepository implements MemberRepository {}
    • RateDiscountPolicy
      @Component
public class RateDiscountPolicy implements DiscountPolicy {}
    • MemberServiceImpl
      @Component
public class MemberServiceImpl implements MemberService {

		 private final MemberRepository memberRepository;

		 @Autowired
		 public MemberServiceImpl(MemberRepository memberRepository) {
				 this.memberRepository = memberRepository;
		 }
}
    • OrderServiceImpl
      @Component
public class OrderServiceImpl implements OrderService {

		 private final MemberRepository memberRepository;
		 private final DiscountPolicy discountPolicy; 

		 @Autowired  // @Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.
		 public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
				 this.memberRepository = memberRepository;
				 this.discountPolicy = discountPolicy;
		 }
}
  • Test Code
    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.1.1 컴포넌트 스캔 & 의존관계 주입 동작 과정

  1. @ComponentScan

  • @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.

💡 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

MemberServiceImpl 클래스 → memberServiceImpl

스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이렇게 이름을 부여하면 된다.

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

  • 생성자에 @Autowired 를 지정 →스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입

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

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

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

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

  • basePackages

    • 탐색할 패키지의 시작 위치를 지정
    • 이 패키지를 포함해서 하위 패키지를 모두 탐색
    • basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

  • basePackageClasses

    • 지정한 클래스의 패키지를 탐색 시작 위치로 지정
    • 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치

  • 권장하는 방법

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

2.2 컴포넌트 스캔 기본 대상

  • 컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.
    • @Component : 컴포넌트 스캔에서 사용
    • @Controlller : 스프링 MVC 컨트롤러에서 사용
    • @Service : 스프링 비즈니스 로직에서 사용
    • @Repository : 스프링 데이터 접근 계층에서 사용
    • @Configuration : 스프링 설정 정보에서 사용

💡 useDefaultFilters 옵션을 끄면 기본 스캔 대상들이 제외된다.

3. Filter

  • includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.
  • excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다
  • Example
    • 컴포넌트 스캔 대상에 추가할 애노테이션
      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;

@MyIncludeComponentpublic 
public class BeanA {
}
    • 컴포넌트 스캔 대상에서 제외할 클래스
      package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}
    • 설정 정보와 전체 테스트 코드
      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 {
		 }

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

💡 includeFilters에 MyIncludeComponent애노테이션을 추가 → BeanA가 스프링 빈 등록 O
excludeFilters에 MyExcludeComponent애노테이션을 추가 → BeanB는 스프링 빈 등록 X

3.1 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는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
스프링의 기본 설정에 맞추어 사용하는 것을 권장

4. 중복 등록 & 충돌

4.1 자동 빈 등록 vs 자동 빈 등록

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

4.2 수동 빈 등록 vs 자동 빈 등록

  • Example
    @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();
		 }
}
  • 이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩)
💡 대부분의 경우, 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분

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

profile
유병익
Backend 개발자가 되고 싶은
이전 포스트

싱글톤 컨테이너

다음 포스트

의존관계 자동 주입

0개의 댓글