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

  출처 : 인프런 - 스프링 핵심원리 - 기본편(유료) / 김영한님  
  유료 강의이므로 정리에 초점을 두고 코드는 일부만 인용  

https://inf.run/kCYMv

---

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

1) 의존관계 자동 주입 시작

• 자바코드에 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 스프링 빈을 등록 할 경우 등록해야할 빈이 수십, 수백개가 되면 일일이 등록하기가 번거롭고 누락 가능성이 높아짐
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 이라는 기능을 제공하며 의존관계도 자동으로 주입하는 @Autowired 기능도 제공함

(1) AutoAppConfig생성

• 기존의 AppConfig와 다르게 @Bean이 붙은 메서드가 하나도 없음
• 컴포넌트 스캔을 사용하려면  @ComponentScan을 클래스 위에 붙히면 됨
• 컴포넌트 스캔은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링빈으로 등록하며 @Configuration도 내부 구조를 살펴보면 @Component가 붙어있어으므로 컴포넌트스캔의 대상이 됨

** 참고

• 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 AppConfig, TestConfig등 앞서 만들어 두었던 설정 정보도 함께 등록되고 실행됨
• 그래서 excludeFilters라는 옵션을 사용하여 설정정보는 컴포넌트 스캔 대상에서 제외하였음
• 보통은 설정 정보를 컴포넌트 스캔에서 제외하진않지만 지금은 기존 예제 코드를 최대한 남기기 위해서 선택한 방법임
• @Filter는 @ComponentScan.Filter 처럼 작성해야하지만 스태틱 임포트를 하면 @Filter로 옵션을 적용할 수 있음

package hello.core;

import static org.springframework.context.annotation.ComponentScan.*;


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

 

(2) @Component 추가

• 컴포넌트 스캔의 대상으로 등록할 클래스에 @Component를 추가
• MemoryMemberRepository와 RateDiscountPolicy에 적용

@Component
public class MemoryMemberRepository implements MemberRepository{
   // ... 기존 코드 생략
}

@Component
public class RateDiscountPolicy implements DiscountPolicy {
   // ... 기존 코드 생략
}

 

(3) @Component, @Autowired 추가

• MemberServiceImpl과 OrderServiceImpl에는 @Component와 @Autowired를 둘다 적용
• AppConfig에서는 @Bean으로 직접 설정 정보를 작성하고 의존관계도 명시하였으나 지금은 설정클래스에 정보 자체가 없기 때문에 의존관계 주입도 해당 클래스안에서 해결해야함
• @Autowired는 의존관계를 자동으로 주입해주며 생성자에서 여러 의존 관계도 한번에 주입 받을 수 있음

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

    @Autowired // 의존관게 자동 주입
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    // ... 기존 코드 생략
}

@Component
public class OrderServiceImpl implements OrderService {

    // 객체를 직접 정하지 않고 생성자를 통해 주입 - DIP원칙을 지킴
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    // ... 기존 코드 생략
}

 

(4) AutoAppConfigTest

• test의 하위에 scan패키지를 생성하여 테스트 코드를 작성
• AnnotationConfigApplicationContext를 이용하여 설정정보로 AutoAppConfig.class를 넘겨줌
• 실행해보면 기존과 같이 잘 동작함

package hello.core.scan;

public class AutoAppConfigTest {
    @Test
    void basicScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

2) 컴포넌트 스캔과 자동 의존관계 주입 동작 설명

(1) @ComponentScan 동작 설명

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록
• 이름은 클래스 명으로 등록 되며 앞글자만 소문자로 변경 됨(메서드 처럼)
• 만약 직접 이름을 지정하고 싶으면 @Component("지정할 이름") 으로 직접 이름을 부여할 수 있음

 

(2) @Autowired 동작 설명

• 생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입하고 기본 조회 전략은 타입이 같은 빈을 찾아서 주입함
• .getBean(MemberRepository.class)와 동일한 메커니즘이며 생성자에 파라미터가 많아도 모두 찾아서 주입

좌) MemberServiceImpl에서의 작동 / 우) OrderServiceImpl에서의 작동

---

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

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

(1) 시작위치 지정 방법

• 모든 자바 클래스는 다 컴포넌트 스캔하면 시간이 오래걸리기 때문에 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있음
• basePackages : 탐색할 패키지의 시작 위치를 지정하고 해당 패키지를 포함해서 하위 패키지를 모두 탐색(여러개 지정 가능)
• basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 지정하지 않으면 @ComponentScan이 붙은 설정 정보의 클래스의 패키지가 시작 위치가 됨

@ComponentScan(basePackages = "hello.core")
@ComponentScan(basePackages = "hello.core", "hello.service") //시작위치를 여러개 등록

 

(2) 권장하는 방법

• 김영한님은 패키지 위치를 지정하지 않고 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 방법을 즐겨 사용한다고 함
• 최근 스프링부트도 이 방법을 기본으로 제공함

// 패키지 경로
com.hello
com.hello.service
com.hello.repository

• 위 처럼 프로젝트의 구조가 되어있다고 가정했을 때 com.hello(프로젝트 시작 루트)에 AppConfig같은 메인 설정 정보를 두고 @ComponentScan 애노테이션을 붙히고 basePackages 지정은 생략하는 방식임
• 이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이되며 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 시작 루트 위치에 두는 것이 좋다고 생각된다고 함
• 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인  @SpringBootApplication을 프로젝트 시작 루트에 두는 것이 관례이며 그 설정 안에 @ComponentScan이 이미 들어있기때문에 사실 직접 @ComponentScan을 사용할일이 없고 필요할때 excludeFilters를 이용하여 등록 대상을 제외하면 됨

스프링부트로 프로젝트를 생성하여 만들어진 CoreApplication클래스에 @SpringBootApplacation 애노테이션이 붙어있음

@SpringBootApplication 애노테이션 안에 들어가보면 @ComponentScan이 있음

 

2) 컴포넌트 스캔 기본 대상

(1) 컴포넌트 스캔은 @Component뿐 아니라 아래의 애노테이션도 추가로 대상에 포함함

• 해당 애노테이션의 내부에 @Component를 포함하고 있음
• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration` : 스프링 설정 정보에서 사용

** 참고

• 애노테이션에는 상속관계라는 것이 없기 때문에 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바가아니라 스프링이 지원하는 기능임

 

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

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

** 참고

• useDefaultFilters 옵션은 기본으로 켜져있는데 해당 옵션을 끄면 기본 스캔 대상들이 제외됨

---

3.필터

1) 컴포넌트 스캔의 필터 옵션

(1) 종류

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

2) 예제로 확인

• test하위에 생성한 scan 패키지에 filter 패키지를 추가로 생성하여 코드를 작성

(1) 컴포넌트 스캔 대상에 추가할 애노테이션 생성

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

 

(2) 컴포넌트 스캔 대상에 제외할 애노테이션 생성

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

 

(3) 컴포넌트 스캔 대상에 추가 및 제외할 클래스 생성

• BeanA, BeanB 클래스를 생성하여 위에서 직접 생성한 애노테이션을 각각 적용

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

 

(4) 테스트 실행 코드

• includeFilters에 MyIncludeComponent애노테이션을 추가하여 BeanA가 스프링 빈에 등록됨
• excludeFilters에 MyExcludeComponent애노테이션을 추가하여 BeanBrk 스프링 빈에 등록 되지 않음
• type = FilterType.ANNOTATION은 기본값이 애노테이션으로 인식하므로 생략해도 됨

package hello.core.scan.filter;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        assertThatThrownBy(() -> ac.getBean("beanB", BeanB.class))
                .isInstanceOf(NoSuchBeanDefinitionException.class);
    }

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

 

(5) FilterType옵션

• ANNOTATION: 기본값, 애노테이션을 인식해서 동작
• ASSGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작
• ASPECTJ: AspectJ 패턴 사용
• REGEX: 정규 표현식
• CUSTOM: TypeFilter라는 인터페이스를 구현해서 처리

(6) BeanA도 스캔 대상에서 제외하고 싶을 경우

• { }중괄호(배열)을 사용하여 @Filter의 값을 여러개 지정할 수 있음

@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면 충분하기 때문에 다른 필터들은 사용할 일이 거의 없으며 excludeFilters는 간혹 사용하지만 빈도가 많지 않음
• 이미 스프링부트가 컴포넌트 스캔을 기본으로 제공하기때문에 옵션을 변경하면서 사용하는 것 보다는 기본 설정에 최대한 맞추어 사용하는 것을 권장하며 김영한님도 이것을 선호한다고 함

---

4. 중복 등록과 충돌

1) 같은 빈 이름을 등록하는 두가지 상황

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

• 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록 될 때 이름이 같은 경우 ConflictingBeanDefinitionException 예외 발생
• 거의 일어날 일이 없음

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

• 수동 빈 등록이 우선권을 가짐 (수동 빈이 자동 빈을 오버라이딩 해버림)

(3) 주의사항

• 개발자가 의도적으로 설정해서 이런 결과를 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분임
• 이렇게 되면 정말 잡기 어려운 버그가 만들어지며 항상 잡기 어려운 버그는 애매한 버그임
• 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본값을 변경함
• @Component에 수동으로 동일한 빈이름을 등록하도록 설정하고 애플리케이션을 실행 해보면 오류가 발생 하는 것을 확인 할 수 있음
• 혼자 개발하는 것이 아니기 때문에 코드를 생략하고 간편하게 하는 것보다 명확하게 하는 것이 훨씬 좋은 코드이며 사실 혼자 개발해도 개발은 명확하게 해야함

** 수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

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