[Spring] @ComponentScan

 

 

 

 

 

 

 

@ComponentScan

@ComponentScan은 @Component 및 @Service, @Repository, @Controller, @Configuration등과 같이 @Component가 붙어있는 Class들을 자동으로 Scan하여 스프링 Bean으로 등록해주는 역할을 수행합니다.

 

@Component는 클래스에 사용되며, 빈으로 등록될 때에는 클래스명을 사용하여 등록합니다.
이때, 클래스의 맨 앞글자만 소문자로 바꿔서 저장합니다.

 

만약 Member 클래스의 경우에는 Bean으로 등록되는 경우 member로 등록되는 것입니다.

 

 

 

 

 

 

 

 

 

@ComponentScan의 범위

기본 값으로는 @ComponenetScan이 사용된 패키지를 시작 위치로 하여, 해당 패키지와 하위 디렉토리를 모두 탐색합니다.

 

만약 탐색의 기준이 되는 패키지를 직접 지정해주고 싶다면 basePackages 옵션을 사용할 수 있습니다.

@ComponentScan( basePackages = "hello.core" }

이러면 hello.core 패키지를 포함해서 하위에 있는 모든 패키지를 탐색합니다.

 

또한 basePackageClasses 속성을 통해 클래스를 지정하면, 지정한 클래스의 패키지를 탐색 시작 위치로 지정할 수 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

빈 이름이 중복되는 경우

빈 이름이 중복되는 경우에는 두 가지 상황이 있습니다.

자동 빈 등록 vs 자동 빈 등록 

ConflictingBeanDefinitionException 오류가 발생합니다

 

 

 

 

수동 빈 등록 vs 자동 빈 등록

기본적으로는 수동 빈 등록이 우선권을 가집니다. (수동 빈이 자동 빈을 오버라이딩)
그러나 스프링 부트에서는 오류가 발생하도록 기본 값을 바꾸었습니다.(원하면 설정 변경이 가능합니다)

 

 

 

 

 

 

 

 

 

 

 

 

 

스캔 기본 대상

• @Componet - 기본
• @Controller - 스프링 MVC 컨트롤러에서 사용
• @Service - 스프링 비즈니스 로직에서 사용, 특별한 기능은 없으나 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 하고 인식하는 용도
• @Repository - 스프링 데이터 접근 계층에서 사용, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuraton - 스프링 설정 정보에서 사용. 스프링 빈이 싱글톤을 유지하도록 추가 처리

 

해당 어노테이션들은 모두 내부적으로 @Componet가 붙어있는 어노테이션들입니다.

 

 

 

 

 

 

 

 

 

 

 

대상에서 제외하거나, 포함시키고 싶은 경우

Filter를 사용합니다.

 

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

 

 

 

 

예시

컴포넌트 스캔 대상에 추가하는 경우

import java.lang.annotation.*;

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

@CustomIncludeComponent
public class IncludeClass {
}

 

 

 

 

컴포넌트 스캔 대상에서 제외하는 경우

import java.lang.annotation.*;

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

 

@CustomExcludeComponent
public class ExcludeClass {
}

 

 

 

 

 

적용

@ComponentScan(
	includeFilters = {
		@ComponentScan.Filter(type=FilterType.ANNOTATION, classes=CustomIncludeComponent.class)
	},
	excludeFilters = {
		@ComponentScan.Filter(type=FilterType.ANNOTATION, classes=CustomExcludeComponent.class)
	}
	)
@Configuration
public class CustomConfig {
}

 

 

 

 

 

FilterType의 옵션

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

 

 

 

 

 

 

 

Reference

스프링 핵심 원리 - 기본편 - 인프런 | 강의