컴포넌트 스캔

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

- 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열

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

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

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

- 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 됨

- 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없음

 

※ 참고 : 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행됨

그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외.

보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위한 선택

 

- 컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록

 

※ 참고 : @Configuration이 컴포넌트 스캔의 대상이 되는 이유도 @Configuration 소스코드에  @Component 애노테이션이 붙어있기 때문

 

- 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주면 됨

@Component
public class MemoryMemberRepository implements MemberRepository {

@Component
public class RateDiscountPolicy implements DiscountPolicy{

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

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

 
}

- 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했음.

이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 내에서 해결해야 함

- @Autowired는 의존관계를 자동으로 주입

 

 

컴포넌트 스캔

- @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록

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

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

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

 

 

@Autowired 의존관계 자동 주입

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

- 이때 기존 조회 전략은 타입이 같은 빈을 찾아서 주입

    - getBean(MemberRepository.class)와 동일하다고 이해 가능

- 생성자에 파라미터가 많아도 다 찾아서 자동 주입

 

 

탐색 위치와 기본 스캔 대상

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

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

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

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

    - basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치 지정 가능

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

- 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨

 

※ 권장 방법 : 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 둠

 

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

 

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component뿐만 아니라 다음 내용들도 추가로 대상에 포함

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

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

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

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

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

 

※ 참고 : 사실 애노테이션에는 상속관계라는 것은 없음. 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능이 아닌 스프링이 지원하는 기능

 

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

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

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

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

- @Service : 특별한 처리를 하지 않음. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있구나라고 비즈니스 계층을 인식하는데 도움

 

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

 

 

필터

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

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

 

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

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

컴포넌트 대상에 제외할 애노테이션

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

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

@MyIncludeComponent
public class BeanA {
}

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

@MyExcludeComponent
public class BeanB {
}

- includeFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록됨

- excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않음

 

 

FilterType 옵션

- ANNOTATION: 기본값, 애노테이션을 인식해서 동작

- ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작

- ASPECTJ: AspectJ 패턴 사용

- REGEX: 정규식 표현

- CUSTOM: TypeFilters이라는 인터페이스를 구현해서 처리

 

※ 참고: @Component면 충분하기 때문에 includeFilters를 사용할 일 거의 없음, excludeFilters는 여러 이유로 간혹 사용됨. 특히 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로 옵션을 변경하며 사용하기 보다는 스프링의 기본 설정에 최대한 맞춰 사용을 권장

 

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록한다면?

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

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

 

 

자동 빈 등록 vs 자동 빈 등록

- 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류 발생

    - ConflictingBeanDefinitionException 예외 발생

 

 

수동 빈 등록 vs 자동 빈 등록

자동 빈 등록

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

- 수동 빈 등록이 우선권을 갖음 (수동 빈이 자동 빈을 오버라이딩 함)

 

- 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 갖는 것이 좋지만,

현실은 개발자의 의도적으로 설정해서 이런 결과가 만들어지기 보단 여러 설정들이 꼬여 이런 결과가 만들어지는 경우가 많음

- 그러면 정말 잡기 어려운 버그가 만들어짐 (항상 잡기 어려운 버그는 애매한 버그)

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

 

 

출처 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard