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

이번 챕터는 컴포넌트 스캔에 대해 알아본다.




***

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

• 지금까지는 스프링 빈을 등록할 때 자바코드의 @Bean이나 XML의 등을 통해 설정 정보에 직접 등록할 빈을 나열했다.
• 하지만 실무에서는 수백개의 빈이 존재하며, 누락될 수 있다.
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 또한, 의존관계도 자동으로 주입하는 @Autowired기능도 제공한다.

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,classes = Configuration.class)
) //스프링 빈을 긁어서 컨테이너에 등록, @Component애노테이션이 들어간 클래스를 찾아 빈으로 등록한다.
public class AutoAppConfig {

}

참고 : 컴포넌트 스캔 사용시 AppConfig같은 수동으로 지정해주어야 하는 설정 정보도 자동으로 등록되기 때문에,컴포넌트 스캔 대상에서 제외한다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않는다.

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. 이제 각 클래스가 컴포넌트 대상이 되도록 애노테이션을 붙여본다.

하지만 문제가 발생했다!
기존은 AppConfig를 통해 어떤 구현체를 쓸지, 의존관계 주입을 명시화 화였는데 이렇게 되면 명시화 할 방법이 없다. 그래서 스프링에서는 @Autowired를 제공한다.

• @Autowired는 의존관계를 자동으로 주입해준다. 아래와 같이 여러 개의 생성자도 자동으로 주입해준다.

이제 컴포넌트 스캔과 의존관계 주입이 어떻게 동작하는지 알아보자.

1. @ComponentScan

• @ComponentScan은 @Component가 붙은 클래스를 찾아 스프링 컨테이너에 빈으로 등록한다.
• 이 때, 빈의 이름은 클래스 명의 첫글자를 소문자화하여 등록된다. (@Component는 구현체에만 붙여주기)
  • 예시 : MemberServiceImpl클래스 -> memberServiceImpl로 등록
  • 이름을 지정하고 싶을 경우@Component("변경하고자 하는 이름")으로 지정하면 된다.

2. @Autowired의존관계 주입

• 생성자에 @Autowired를 입력하면, 스프링 컨테이너가 빈을 찾아 해당 타입과 같은 빈을 자동으로 주입해준다.
  • ac.getBean(MemberService.Class)와 비슷한 맥락이라고 볼 수 있다.

***

탐색 위치와 기본 스캔 대상

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

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

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

• 위와 같이 basePackages를 통해 탐색할 패키지의 시작 위치를 지정할 수 있다. 이 패키지 포함 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core","hello.service"} 이렇게 여러 시작 위치를 지정할 수 있다.
• basePackageClasses : AppConfig.class : 지정한 클래스의 패키지를 탐색한다.
• 만일 지정하지 않는다면, @ComponentScan이 붙은 설ㅈ어 정보 클래스의 패키지가 시작 위치가 된다.
  
  권장사항
  패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 최상단에 두자.

컴포넌트 스캔 기본 대상

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

@Controller소스를 타고타고 들어가보면 @Component를 포함하고 있는 것을 알 수 있다. 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식하는 것은 자바 언어가 아니고, 스프링이 지원하는 기능이다.

필터

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

@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애노테이션을 추가하여 BeanA가 스프링 빈에 등록된다.
  
  

FilterType의 5가지 옵션

• ANNOTATION : 기본값, 애노테이션을 인식하여 동작
• ASSIGNBLE_TYPE : 지정한 타입과 자식타입을 인식
• ASPECTJ : AspectJ 패턴 사용
• REGEX : 정규 표현식
• CUSTOM : TypeFilter

참고 : @Component면 충분하기 때문에, includeFilters를 사용할 일은 거의 없다고 한다. excludeFilters는 여러 이유로 간혹 사용할 수는 있다.
특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 강사님 입장에서는 옵션을 변경하여 사용하기 보다는 스프링 기본 설정에 최대한 맞추어 사용하는 것을 권장한다고 한다.

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까 ?
아래 두가지 상황이 존재할 수 있다 :

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

자동 빈 등록 vs 자동 빈 등록

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

자동 빈 등록 vs 수동 빈 등록

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

수동 빈 등록시 남는 로그

 Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing ..

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동보다는 수동이 우선권을 가지는 것이 좋다. 하지만 대부분은 의도적으로 설정하기 보다는 여러 설정이 꼬여 확인하기 어려운 버그가 발생한다.
그래서 최근 스트링 부트에서는 수동 빈 등록과 자동 빈 등록시 충돌나면 오류가 발생하도록 기본 값이 바뀌었다.

앞선 내용은 김영한 강사님의 스프링 핵심 원리 기본편 강의를 들으며 정리한 내용입니다.