🗺 RoadMap/Spring

[기본] #6 컴포넌트 스캔 (@ComponentScan, @Autowired)

an2z 2022. 2. 25. 18:28
본 포스팅은 인프런 - 스프링 핵심 원리(기본편)을 강의를 바탕으로 공부하고 정리한 글입니다.

 

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

이전에는 스프링 빈으로 등록하기 위해 자바 코드의 @Bean이나 XML의 <bean>을 통해서 직접 설정 정보를 입력해주고, 의존관계도 직접 명시했다.

하지만, 그렇게 작업하기에는 추후 등록해야 할 스프링 빈이 수십~수백 개가 되면 너무 많은 작업이 소요된다. 

스프링은 이러한 과정을 생략할 수 있도록 설정 정보 없이 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

 

적용

  • @ComponentScan : 컴포넌트 스캔 사용, 설정 정보에 명시
  • @Component : 스프링 빈 등록
  • @Autowired : 의존관계 자동 주입

 

👉🏻 기존 Bean 등록과 의존 관계 주입 방식

더보기

📁 AppConfig

@Configuration
public class AppConfig {
    @Bean // 스프링 빈으로 등록
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean // 스프링 빈으로 등록
    public MemberRepository memberRepository() {
        System.out.println("call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

    @Bean // 스프링 빈으로 등록
    public OrderService orderService() {
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean // 스프링 빈으로 등록
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

 

👉🏻 컴포넌트 스캔, 자동 의존관계 주입 사용

📁 AutoAppConfig

@Configuration
@ComponentScan
public class AutoAppConfig {

}
  • 컴포넌트 스캔을 사용하기 위해 설정 정보에 @ComponentScan을 붙여준다. 
  • 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 없다.

📁 member/MemoryMemberRepository

@Component
public class MemoryMemberRepository implements MemberRepository { ... }
  • 컴포넌트 스캔을 사용하면 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 알아서 등록해준다.

📁 member/MemberServiceImple

@Component
public class MemberServiceImpl implements MemberService {

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    
    ...
}
  • @Autowired를 통해 의존관계를 자동으로 주입해준다.
  • 기존에는 AppConfig에서 @Bean으로 직접 설정 정보를 작성하면서 의존관계도 직접 명시해줬지만, 컴포넌트 스캔 사용 시 이런 설정 정보가 없기 때문에 의존관계 주입도 @Autowired를 통해 클래스 안에서 해결한다.

📁 order/OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
    
    ...
}

📁 discount/RateDiscountPolicy 

@Component
public class RateDiscountPolicy implements DiscountPolicy { ... }

 

👉🏻 컴포넌트 스캔 테스트

📁 test/scan/AutoAppConfigTest

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

        MemberService memberService = ac.getBean(MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

  • AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.
  • 설정 정보로 @ComponentScan을 사용한 AutoAppConfig 클래스를 넘겨준다.
  • 실행 로그를 보면 @Component가 붙은 클래스들이 스프링 빈으로 잘 등록된 것을 확인 할 수 있다.(싱글톤 사용)

 

동작 원리

💡 @ComponentScan 스프링 빈 등록

  • @ComponentScan을 사용하면 스프링이 @Component가 붙은 모든 클래스를 찾아 스프링 빈으로 등록한다.
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
    • 빈 이름 기본 전략 : MemberServiceImple 클래스 → memberServiceImple
    • 빈 이름 직접 지정 : @Component("memberService2") 이런식으로 이름을 직접 지정할 수도 있다.

 

💡 @Autowired 의존관계 자동 주입

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

 

 

컴포넌트 스캔의 속성

@ComponentScan을 통해 자동 스캔할 때, 다양한 속성을 지정해 줄 수 있다.

탐색 위치 지정

@ComponentScan(
    basePackages = "hello.core",
    // basePackages = {"hello.core", "hello.service"} // 여러 개 지정 가능
    basePackageClasses = AutoAppConfig.class
}
  • basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해 하위 패키지를 모두 탐색한다.
  • basePakageClasses : 지정한 클래스의 패키지를 탐색 위치로 지정한다.
  • 탐색 위치를 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

💡 권장 방법

  • 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장한다.
  • 프로젝트 시작 루트에 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고 basePakages 지정은 생략하면 모든 하위 패키지가 컴포넌트 스캔의 대상이 된다.
  • 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 위치에 두는 것이 관례인데, 이 설정 안에 바로 @ComponentScan이 들어있다.

 

컴포넌트 스캔 대상

애노테이션 설명
@Component • 컴포넌트 스캔에서 사용
@Controller • 스프링 MVC 컨트롤러에서 사용
@Service • 스프링 비즈니스 로직에서 사용
• 특별한 처리를 하지는 않음. 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나
   인식하는데 도움이 됨
@Repository • 스프링 데이터 접근 계층에서 사용
• 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration • 스프링 설정 정보에서 사용
• 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
  • 이러한 애노테이션이 있으면 스프링은 컴포넌트 스캔 뿐만 아니라 부가 기능 또한 수행한다.

 

필터 (includeFilters, excludeFilters)

필터를 사용해 컴포넌트 스캔에서 추가/제외 대상을 지정할 수 있다.

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

 

👉🏻 컴포넌트 스캔 대상에 추가, 제외할 애노테이션

📁 test/scan/filter/MyIncludeComponent

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

📁 test/scan/filter/MyExcludeComponent

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

 

👉🏻 컴포넌트 스캔 대상에 추가, 제외할 클래스

📁 test/scan/filter/BeanA

@MyIncludeComponent
public class BeanA {
}

📁 test/scan/filter/BeanB

@MyExcludeComponent
public class BeanB {
}

 

👉🏻 설정 정보와 전체 테스트 코드

📁 test/scan/filter/ComponentFilterAppConfigTest

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

        // includeFilters의 BeanA는 스프링 빈에 등록 됨
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        // excludeFilters의 BeanB는 스프링 빈에 등록되지 않음
        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 {
    
    }
}
  • includeFilters에 MyIncludeComponent 애노테이션을 추가해 BeanA가 스프링 빈에 등록된다.
  • excludeFilters에 MyExcludeComponent 애노테이션을 추가해 BeanB는 스프링 빈에 등록되지 않는다.
    • getBean으로 조회시 스프링 빈이 없기 때문에 NoSuchBeanDefinitionException 발생

 

FilterType 옵션

FilterType은 5가지 옵션이 있다.

옵션 설명
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

👉🏻 예시 코드 (excludeFilter에서 ASSIGNABLE_TYPE을 통해 BeanA를 제외)

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

 

 

빈 중복 등록과 충돌

컴포넌트 스캔시 주의 해야 하는 부분 중 하나가 이름이다.

 

이름이 중복되는 경우는 다음 두가지 상황이 있다.

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

 

자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 이름이 같은 경우 스프링은 오류(ConflictingBeanDefinitionException)를 발생시킨다.

 

수동 빈 등록 vs 자동 빈 등록

@Component에 의한 자동 빈 등록과 @Bean에 의한 수동 빈 등록에서 이름이 중복될 경우, 수동 빈 등록이 우선권을 가진다.

  • 수동 빈이 자동 빈을 오버라이딩 함
  • 수동 빈 등록(AppConfig - @Configuration, @Bean) > 자동 빈 등록 (@Component, @Autowired)

이때 여러 설정들이 꼬여서 수동 빈이 자동 빈을 오버라이딩 한 상황이 발생하면 정말 잡기 어려운 버그가 만들어지게 된다.

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