Component Scan

Component Scan 과 의존관계 자동 주입 시작

• Spring Bean 을 등록할 때는 자바 코드의 @Bean 이나 XML 의 <bean> 을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열한다.
• 등록해야 할 스프링 빈이 수십, 수백 개가 되면 일일히 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

package hello.core;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.*;

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

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

}

 

• 컴포넌트 스캔을 사용하려면 먼저 @Configuration 을 설정 정보에 붙여주면 된다.
• @Bean 으로 등록한 클래스가 하나도 없다.

참고
컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilter 를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외할 수 있다.

 

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

 

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

 

그래서 생성자에는 @Autowired 를 붙여 자동으로 의존관계를 주입하고, 필요한 클래스에 컴포넌트 애노테이션을 붙여주면 된다.

 

1️⃣ @Component Scan

• @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이 때, 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
• 만일 스프링 빈의 이름을 지정하고 싶으면 @Component("memberService2") 이렇게 이름을 부여하면 된다.

 

@Autowired 의존관계 자동 주입

• 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
• getBean() 과 동일하다고 이해하면 된다.

 

탐색 위치와 기본 스캔 대상

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

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

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

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

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장한다. 최근의 스프링 부트도 이 방법을 기본으로 제공한다.

 

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

 

2️⃣ 컴포넌트 스캔 기본 대상

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

위의 클래스 소스 코드들을 확인해보면 @Component 를 포함하는 것을 알 수 있음.

 

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

 

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

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

필터

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

 

1️⃣ 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

 

최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 추세이다.

 

중복 등록과 충돌

1️⃣ 자동 빈 등록 vs 자동 빈 등록

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

2️⃣ 수동 빈 등록 vs 자동 빈 등록

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

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Configuration
@ComponentScan(
Configuration.class)
		excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
)
public class AutoAppConfig {
		@Bean(name = "memoryMemberRepository")
		public MemberRepository memberRepository() {
		return new MemoryMemberRepository();
		}
}

 

3️⃣ 수동 빈 등록시 남는 로그

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

 

개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다. 그러면 정말 잡기 어려운 버그가 만들어지는데, 항상 잡기 어려운 버그는 애매한 버그다. 

 

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