Spring/컴포넌트 스캔/@ComponentScan

@ComponentScan

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에

직접 등록할 스프링 빈을 나열했다. 예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도

귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다. 역시 개발자는 반복을 싫어한다. 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다. 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다. 기존의 AppConfig와는 다르게 @Bean으로 등록할 필요가 없다.

 

컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에(@Configuration에 @Component 애노테이션붙어있음), AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 

 

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. AppConfig(설정 정보)에 @Component를 붙여주자. 

 

컴포넌트 스캔 기본 대상

아래 모두 @Component를 내장하고 있음

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

@Controlller : 스프링 MVC 컨트롤러에서 사용

@Service : 스프링 비즈니스 로직에서 사용(특별한 처리를 하거나 그러진 않음. '비즈니스 로직이 있구나'를 인식하기 위함)

@Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.

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

 

 

필터

includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.

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

@ComponentScan(
	includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyIncludeComponent.class),
	excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class)

*옵션

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는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다. 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

 

중복 등록과 충돌

1. 자동 빈 등록 vs 자동 빈 등록 (이름이 같은 경우 스프링은 오류를 발생시킨다.)

2. 수동 빈 등록 vs 자동 빈 등록 (수동 빈 등록이 우선권을 가진다. 수동이 우선권을 가지는 것이 좋으나, 설정이 꼬여서 이런 결과가 나오는 경우가 대부분 -> 그래서 요즘에는 그냥 오류가 발생하도록 기본 값을 바꿈)

 

 

 

 

정리

1. AppConfig(설정 정보)클래스 위에 @ComponentScan을 붙여준다.

2. 클래스마다 @Component 애노테이션을 붙여주면 되고(@Configuration 내부에도 @Component가 있어서 AppConfig도 빈으로 등록됨), 클래스 내의 생성자에도 @Autowired를 지정하여 스프링 빈을 주입 받을 수 있도록 한다. 생성자가 한 개밖에 없는 경우 @Autowired를 생략할 수 있다.

3. AppConfig에 메서드마다 @Bean을 할 필요도 없이 클래스들을 스캔해서 스프링 빈을 등록하여 사용할 수 있다. (이름 지정 가능)

4. 탐색을 할 때는 시작 위치를 지정할 수 있으며, 시작 패키지를 포함해서 하위 패키지를 모두 탐색한다.

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

basePackages = {"hello.core", "hello.service"} //이렇게 여러 패키지도 가능

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