[Spring]스프링 핵심 원리(기본편) - 6. 컴포넌트 스캔

Wooyong Jung·2023년 9월 16일
0
post-thumbnail
post-custom-banner
  • 해당 게시물은 인프런 "스프링 핵심 원리 - 기본편" 강의를 참고하여 작성한 글입니다.
  • 자세한 코드 및 내용은 강의를 참고해 주시길 바랍니다.
    강의링크 -> 스프링 핵심 원리 - 기본편 (김영한)

Section6. 컴포넌트 스캔

  • 설정 정보 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔에 대해 알아봅니다.
  • 의존관계를 자동으로 주입하는 @Autorwired를 사용해봅니다.
  • 필터를 통해 컴포넌트 스캔에 제외할 대상, 추가할 대상으로 지정해봅니다.
  • 컴포넌트 스캔에서 빈 중복 등록과 충돌에 대해 알아봅니다.

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

기존의 AppConfig.java 대신 AutoAppConfig.java를 생성한다

@Configuration
@ComponentScan
public class AutoAppCOnfig {
}

AppConfig와 다르게 @Bean으로 등록한 클래스가 없다. 이 경우에는 @Bean 대신 클래스에 @Component을 직접 붙여준다. 컴포넌트 스캔은 @Component애노테이션이 붙은 클래스를 스캔해서 스프링 빈이 등록해주는 것이다.

@Component
public class MemberServiceImpl implements MemberService {

	private final MemberRepository memberRepository;
    
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
 		this.memberRepository = memberRepository;
 	}
}

AppConfig에는 @Bean으로 설정 정보를 직접 작성했을 뿐만 아니라, 의존관계도 직접 명시했다. AutoAppConfig에는 이런 설정 정보가 없기 때문에 의존관계 주입도 클래스 안에서 해결해야 하는데 @Autowired가 이를 해결해준다.

@ComponentScan

  • @ComponentScan@Component가 붙은 모든 클래스를 스프링 빈으로 등록
  • 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용 (직집 지정 가능)

@Autowired

  • 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
  • 기본 조회 전략은 타입이 같은 빈을 찾아서 주입

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리기 때문에 탐색 시작 위치를 지정할 수 있다.

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

basePackages : 탐색한 패키지의 시작 위치 지정
basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정
-> 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치

컴포넌트 스캔은 @Controller, @Service, @Repository, @Configuration도 추가로 대상에 포함하는데 이는 이들이 @Component를 포함하고 있기 때문이다.


📄 필터

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

컴포넌트 스캔에 대상에 추가할 애노테이션을 생성한다.

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

컴포넌트 스캔에서 제외할 애노테이션을 생성한다.

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

그리고@MyIncludeComponent 애노테이션을 적용한 BeanA 클래스와 @MyExcludeComponent 애노테이션을 적용한 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 {
    }
}

basePackages가 없으므로 ComponentFilterAppConfigTest 클래스가 포함된 패키지가 시작위치가 된다. 해당 패키지 안에 @Component 애노테이션을 포함한 클래스는 BeanABeanB인데 필터에 의해 BeanA가 스프링 빈에 등록되고 BeanB는 스프링 빈에 등록되지 않는다.


📄 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록할 수도 있다.

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

자동 빈 등록 vs 자동 빈 등록

ConflictingBeanDefinitionException 예외가 발생한다.

수동 빈 등록 vs 자동 빈 등록

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

profile
실패를 두려워하지 않는 백엔드 개발자가 되기 위해 노력하고 있습니다.
post-custom-banner

0개의 댓글