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

이글은 스프링핵심원리-기본편-인프런 강의를 학습 후 
나중에 다시 복습하기 위해 정리한 글입니다.
문제시 비공개로 처리하겠습니다. 

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

목차

1. 컴포넌트 스캔과 의존관계 자동 주입
2. 탐색 위치와 기본 스캔 대상
3. 필터
4. 중복 등록과 충돌

---

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

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

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서

설정 정보에 직접 등록할 스프링 빈을 나열했다.

 

실무에선 등록해야 할 스프링 빈이 수십,수백개가 되면 등록하기도 귀찮고, 설정 정보도 커지고,

누락하는 문제도 발생 할 수 있다. ㅠ

 

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

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

 

일단 기존 AppConfig.java 는 과거 코드와 테스트를 위해 나두고,

새로운 AutoAppConfig.java 를 만들어보자

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

}

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

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

 

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

 

참고 : @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 소스 코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.

이제 @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;}
...
}

MemberServiceImpl , OrderServiceImpl 에서 @Autowired로 의존관계를 자동으로 주입한다.

자세한건 조금 뒤에서 다뤄보도록 하자.

• test

public class AutoAppConfigTest {

    @Test
    void basicScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);

        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

/*
01:45:53.909 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.event.internalEventListenerProcessor'
01:45:53.913 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.event.internalEventListenerFactory'
01:45:53.915 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.annotation.internalAutowiredAnnotationProcessor'
01:45:53.918 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.annotation.internalCommonAnnotationProcessor'
01:45:53.936 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'autoAppConfig'
01:45:53.943 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'rateDiscountPolicy'
01:45:53.946 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memberServiceImpl'
01:45:53.969 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'memoryMemberRepository'
01:45:53.970 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Autowiring by type from bean name 'memberServiceImpl' via constructor to bean named 'memoryMemberRepository'
01:45:53.971 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'orderServiceImpl'
01:45:53.974 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
01:45:53.974 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'

Process finished with exit code 0
*/

로그를 잘 보면 컴포넌트 스캔이 잘 동작한 것을 확인할 수 있다.

조금 더 자세히 알아보자면

 

1. @ComponentScan

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

(@ComponentScan 클래스 패키지 포함 모든 하위 패키지에서 @Component 가 붙은 클래스를 찾아서)

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

• 빈 이름 기본 전략: MemberServiceImpl 클래스 → memberServiceImpl
• 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면
  • @Component("memberService2") 이런식으로 이름을 부여하면 된다.

2. @Autowired

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

이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

• getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.
• 상속 구조로 MemberRepository를 구현한 MemoryMemberRepository가 주입된다 생각하면 된다. 실제로도 MemoryMemberRepository에 @Component를 했다.

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

정리

@ComponentScan 으로 해당 패키지 포함 모든 하위 모든 패키지의 @Component들을 찾아 스프링 빈으로 등록한다.

그리고 @Autowired로 의존관계를 설정해준다.

의존관계도 스프링 빈으로 등록이 되있어야 해준다.

 

근데 만약에 RateDiscountPolicy 뿐만 아니라 FixDiscountPolicy 에도 @Component를 붙이면

어떻게 될까???

결론적으로 OrderServiceImpl 에서 의존관계를 주입받는 도중에 오류가 발생한다.

당연한 부분이다.

스프링 컨테이너는 OrderServiceImpl 에 RateDiscountPolicy이걸 주입할지 FixDiscountPolicy 이걸 주입할지 모른다.

→ 오류 뻥!!!

 

의존관계가 겹칠 때 뭘 디폴트로 설정하는 방법도 예전에 배웠던 것 같은데 ...

일단은 다시 @Component를 지우고 , 다음 으로 넘어가자 👉👉👉

---

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

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

모든 자바 클래스를 다 컴포넌트로 스캔하면 시간이 오래 걸린다.

그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정 할 수 있다.

@ComponentScan(

        basePackages = "hello.core",

        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,
                classes = Configuration.class)

)

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

권장하는 방법

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

최근 스프링 부트도 이 방법을 기본으로 제공한다.

 

ex) 아래와 같은 구조에선

• com.hello
• com.hello.service
• com.hello.repository

com.hello → 프로젝트 시작루트, 여기에 AppConfig같은 메인 설정 정보를 두고,

@ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

 

이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다고 생각한다.

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

뭐 어차피 처음 프로젝트 만들 때 시작 루트에 잘 들어가 있다.

그리고 @SpringBootApplication 내부를 보면

@ComponentScan이 있는걸 확인 할 수 있다.

컴포넌트 스캔 기본 대상

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

• @Component : 컴포넌트 스캔에서 사용
• @Controlller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용

해당 클래스의 소스 코드를 보면 @Component 를 포함하고 있는 것을 알 수 있다.

@Component
public @interface Controller {
}
@Component
public @interface Service {
}
@Component
public @interface Configuration {
}

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

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

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

참고: useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나 정도 알고 넘어가자.

---

3. 필터

필터

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

ex)

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

@Target(ElementType.TYPE) // class level 에 붙음
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {

}

• 컴포넌트 스캔 대상에 제외할 에노테이션

@Target(ElementType.TYPE) // class level 에 붙음
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {

}

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

@MyIncludeComponent
public class BeanA {
}

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

@MyExcludeComponent
public class BeanB {
}

• 테스트

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);

        Assertions.assertThat(beanA).isNotNull();
        assertThrows(NoSuchBeanDefinitionException.class,
                ()-> ac.getBean("beanB",BeanB.class));
    }

    @Configuration
    @ComponentScan(
            includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,
            classes = MyIncludeComponent.class),
            excludeFilters = @ComponentScan.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 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.

특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데,

개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

---

4. 중복 등록과 충돌

자동 빈 등록 VS 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데,

그 이름이 같은 경우 스프링은 오류를 발생시킨다.

→ ConflictingBeanDefinitionException 예외 발생

@Component("service")
public class MemberServiceImpl implements MemberService{}

@Component("service")
public class OrderServiceImpl implements OrderService{}

수동 빈 등록 VS 자동 빈 등록

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

@ComponentScan
@Configuration
public class AutoAppConfig {

    @Bean(name="memoryMemberRepository")
    MemberRepository memberRepository(){
        return new MemoryMemberRepository();
    }
}

@Component
public class MemoryMemberRepository implements MemberRepository{
...
}


//04:57:49.622 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing [Generic bean: class [hello.core.member.MemoryMemberRepository]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in file [C:\Users\kwons\Desktop\study\git_project\spring_basic\core\out\production\classes\hello\core\member\MemoryMemberRepository.class]] with [Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=autoAppConfig; factoryMethodName=memberRepository; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AutoAppConfig]

딱히 오류가 안나긴 하는데 ...

뭔가 오버라이딩 된다고 메시지를 보여주긴 한다.

 

물론 개발자가 의도적으로 이런 결과를 기대했다면,

자동 보다는 수동이 우선권을 가지는 것이 좋다.

 

하지만 !!

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

그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

참고 : 어설픈 추상화를 하지말자. 코드 양이 좀 더 나오더라도 명확하게 코딩하는 것이 좋다. 애매한 상황과 코드는 피해야 한다. 애매한 버그가 제일 잡기 어렵기 때문이다. 그리고 개발은 혼자 하는게 아니기 때문이다.

→ 좋은 개발 습관을 체득할 수 있도록 부단히 노력해야 겠다. 👍

 

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

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

Description:

The bean 'memoryMemberRepository', defined in class path resource [hello/core/AutoAppConfig.class], could not be registered. A bean with that name has already been defined in file [C:\Users\kwons\Desktop\study\git_project\spring_basic\core\out\production\classes\hello\core\member\MemoryMemberRepository.class] and overriding is disabled.

Action:

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


Process finished with exit code 1

내용은 뭐 memoryMemberRepository가 중복된다는 얘기다.