Spring Component Scan

Component Scan 과 의존관계 자동 주입

• 현재까지 알아본(Spring Container, Bean 편) Spring Bean 을 등록할 때는 자바 코드의 @Bean 이나 XML 의 <bean> 등을 통해서 설정 정보에 직접 등록할 Spring Bean 을 나열했다.
• 예제 속 등록해야할 빈의 개수는 몇개 되지 않아 문제가 없었지만, 실제 등록해야할 빈의 개수가 수십, 수백개가 되면 등록하기 굉장히 불편하고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
• 따라서, Spring 은 설정 정보가 없어도 자동으로 Spring Bean 을 등록하는 Component Scan 이라는 기능을 제공한다.
• 또한, 각 Component 에 필요한 의존관계도 자동으로 주입해주는 @Autowired 기능도 제공한다.

기존 Bean을 직접 등록했던 AppConfig

자동 컴포턴트 스캔 지원하는 AppConfig

Component Scan 기능

• Component Scan 기능을 사용하기 위해 @ComponentScan 어노테이션을 붙여준다.
• 기존의 AppConfig 와는 다르게 @Bean 으로 등록한 클래스가 현재 하나도 없다.
• Component Scan 기능은 @Component 애노테이션이 붙은 클래스를 스캔해서 Spring Bean 으로 등록한다.
  • 빈으로 등록하고 싶은 클래스에 @Component 어노테이션 붙여주자

• @ComponentScan
  • @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
    • 빈 이름 기본 전략: MemberServiceImpl 클래스 → memberServiceImpl (시작 글자 소문자로)
    • 빈 이름 직접 지정: 빈의 이름을 직정 지정하고 싶으면 @Component("지정 이름") 사용하여 부여
• @Autowired 의존관계 자동 주입
  • 의존관계가 필요한 Component 의 경우 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
    • applicationContext.getBean(MemberRepository.class) 와 동일 기능
    • 만약 생성자에 파라미터가 많더라도 다 찾아서 자동으로 주입한다.

 

Component Scan 탐색 위치와 기본 스캔 대상

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

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

@ComponentScan{
	basePackages = "hello.core"
}

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

권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스(AppConfig.class)의 위치를 프로젝트 최상단 에 두는 것이다.
최근 Spring Boot 역시 이 방법을 기본으로 제공한다.

예시로, 프로젝트가 다음과 같이 구조가 되어 있으면

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

com.hello → 프로젝트 시작 루트, 여기에 AppConfig 와 같은 메인 설정 정보를 두고, @Component 어노테이션을 붙이고, basePakages 지정은 생략한다.

이처럼 com.hello 를 포함한 하위는 모두 자동으로 컴포턴트 스캔의 대상이 되며 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트에 위치시키는 것이 좋다.

참고로, 스프링 부트 사용시 스프링 부트의 대표 시작 정보인 @SpringBootApplication 어노티에션을 해당 프로젝트 시작 루트 위치에 두는 것이 관례이다. (해당 어노테이션 설정 속에 @ComponentScan 이 포함되어 있음)

컴포넌트 스캔 기본 대상

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

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

@Configuration 어노테이션

각 어노테이션을 확인해보면 @Component 가 붙어 있는 것을 확인해볼 수 있다.

참고 사항

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

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

userDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.

 

필터

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포턴트 스캔에서 제외할 대상을 지정한다.
• FiterType 옵션
  • 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 는 여러가지 이유로 간혹 사용할 때가 있지만 이 역시 많지는 않다.

특히, 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 추천하는 방향은 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞춰 사용하는 것을 권장한다.

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하게 되는 두 가지 상황이 존재한다.

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

자동 빈 등록 vs 자동 빈 등록

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

• ConflictingBeanDefinitionException 예외 발생
• 스프링 자체에서 예외를 발생시켜주기 때문에 발생되기 어렵다.

수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌하면 어떻게 되는지 살펴보자

자동 스캔 대상 컴포넌트

수동 등록 컴포넌트

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

 

수동 빈 등록시 남는 로그

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

위와 같이 수동 빈으로 등록한 빈이 우선권을 갖는 형태를 의도하였다면 이는 문제가 없겠지만

수동 빈 등록과 자동 빈 등록에 의해 여러 문제점들이 야기될 수 있다. 이러한 문제점들을 정말 잡기 어려운 버그를 만들어낼 수 있다.

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

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

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 [/Users/we/Downloads/core/out/production/classes/hello/core/member/MemoryMemberRepository.class] and overriding is disabled.

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

"불명확한 코드는 나중에 큰 문제들을 야기할 수 있다."

 

참고

• 본 게시글은 김영한님의 스프링 핵심 원리 - 기본편을 바탕으로 작성되었음을 알립니다.
• 자세한 내용은 강의를 구매하시어 확인하는 것을 추천드립니다.