[Spring] 컴포넌트 스캔

스프링 빈을 등록할 때는 @Bean 어노테이션이나 XML의 <bean> 태그를 통해 설정 정보에 직접 등록할 스프링 빈을 명시해주는 방법이 있는데요. 등록해야 할 빈이 많을 때는 일일이 등록하기에는 한계가 있고 누락문제도 발생할 수 있죠,,

그래서! 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공하고 있습니다. 또 의존관계도 자동으로 주입하는 @Autowired 기능도 제공합니다.

 

 

@ComponentScan

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

 

ComponentScan 애노테이션은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록합니다.

이 때 Filter를 이용하여 포함/제외 시키고 싶은 클래스를 명시할 수 있습니다.

Filter의 옵션으로는 type과 classes를 줄 수 있습니다.

FilterType.ANNOTATION이 기본값으로 애노테이션을 인식해서 동작합니다.

classes에는 포함/제외하고자 하는 클래스나 애노테이션을 명시할 수 있습니다.

예를 들어,,

package hello.core.scan.filter;
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent { }

위 코드는 사용자가 정의한 애노테이션입니다. @MyIncludeComponent 애노테이션을 특정 클래스 위에 명시해주면 그 클래스는 컴포넌트 스캔의 대상이 됩니다. 

 

 

 

 

 

기존의 @Bean 애노테이션으로 등록했던 것을 @Component 애노테이션을 이용하여 빈으로 등록 해보겠습니다.,,

 

MemoryMemberRepository @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용합니다.

빈 이름 기본 전략 : MemberServiceImpl -> memberServiceImpl

빈 이름 직접 지정 : 별도의 이름을 지정하고 싶으면 @Component("newName") 이런식으로 부여할 수 있습니다.

 

 

@Autowired

생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입합니다.

이 때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입합니다.

 

 

컴포넌트 스캔 대상 패키지

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

basePackages : 컴포넌트 스캔할 패키지의 시작 위치를 지정할 수 있습니다.

basePackages = {"hello.core", "hello.service"} 와 같이 시작 위치를 복수개로 지정할 수도 있습니다.

지정하지 않는다면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됩니다.

 

보통 프로젝트의 루트 패키지에 메인 설정 정보를 두고 @ComponentScan 애노테이션을 붙이고 basePackages는 생략하는 것을 추천한다고 합니다.

자동으로 @ComponentScan이 붙은 하위 패키지들은 컴포넌트 스캔의 대상이 되기 때문입니다.

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

 

 

컴포넌트 스캔 기본 대상은 다음과 같습니다.

 

@Component : 컴포넌트 스캔에서 사용

@Controller : 스프링 MVC 컨트롤러로 인식

@Service : 비지니스 계층으로 인식

@Repository : 스프링 데이터 접근 계층으로 인식한다.

@Configuration : 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 한다.