[Spring core basic] 29 - 컴포넌트 스캔 범위와 기본 스캔 대상
참고
Spring core basic 시리즈는 김영한 님의 "스프링 핵심 원리 - 기본편" 강의를 정리한 글입니다. 글에 첨부된 사진은 해당 강의의 강의 자료에서 캡쳐한 것입니다. 제 Github에만 올려뒀다가, 정보 공유와 강의 홍보(?)를 위해 블로그에도 업로드합니다. 마크다운을 잘 쓰지 못해서 가독성이 조금 떨어지는 점 양해 바랍니다.
스프링 핵심 원리 - 기본편 - 인프런 | 강의
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...
www.inflearn.com
컴포넌트 스캔 범위와 기본 스캔 대상
컴포넌트 스캔 대상 패키지 지정
프로젝틍 존재하는 모든 자바 클래스를 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 위치를 지정할 수 있다.
@Configuration
@ComponentScan(
basePackages = "com.kloong.corebasic1.member",
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}
basePackages
를 통해 탐색할 패키지를 지정한다. 이 패키지를 포함한 하위 패키지를 모두 탐색한다.basePackages = {"package1", "package2"}
이렇게 여러 위치를 지정할 수도 있다.
basePackageClasses
를 통해 지정한 클래스의 패키지를 탐색 시작 위치로 지정할 수 있다.- default 탐색 시작 위치는
@ComponentScan
이 붙은 설정 정보 클래스의 패키지이다.
권장하는 방법 (일반적인 방법)
컴포넌트 스캔 대상 패키지를 따로 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
예를 들어서 프로젝트가 다음과 같은 구조라면
- com .hello
- com.hello.serivce
- com.hello.repository
프로젝트의 루트인 com.hello에 AppConfig 같은 메인 설정 정보를 두고, 따로 basePackages 지정은 하지 않는다.
이렇게 하면 com.hello 를 포함한 하위 패키지는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.
참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication
이 붙은 클래스를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (이 annotation 안에 바로 @ComponentScan
이 들어있다! 그래서 반대로 말하면, 이 annotation이 붙은 설정 정보를 쓰면 @ComponentScan
을 따로 사용할 필요가 없다는 뜻이기도 하다.)
컴포넌트 스캔 기본 대상
컴포넌트 스캔은 @Component
뿐만 아니라 다음 annotation에 대해서도 스캔 대상에 포함한다.
@Controlller
: 스프링 MVC 컨트롤러에서 사용@Service
: 스프링 비즈니스 로직에서 사용@Repository
: 스프링 데이터 접근 계층에서 사용@Configuration
: 스프링 설정 정보에서 사용
위 annotation의 소스 코드를 살펴보면 @Component
를 포함하고 있다는 것을 알 수 있다.
*참고: 사실 annotation에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고
있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
컴포넌트 스캔의 용도 뿐만 아니라 다음 annotation이 있으면 스프링은 부가 기능을 수행한다.
@Controller
: 스프링 MVC 컨트롤러로 인식한다.@Repository
: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.@Configuration
: 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.@Service
: 사실@Service
는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.
*참고: useDefaultFilters
옵션에 의해 기본 스캔 대상이 적용되는 것이다. 기본적으로 켜져있고, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나 정도 알고 넘어가자.