Spring 기본 18 - 탐색 위치와 기본 스캔 대상

탐색 위치와 기본 스캔 대상

탐색 위치와 기본 스캔 대상

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

basePackages = "hello.core.member"

@Configuration
@ComponentScan(
        basePackages = "hello.core.member",
        excludeFilters = @ComponentScan.Filter( type = FilterType.ANNOTATION,
                classes = Configuration.class)
)
public class AutoAppConfig {
}

 

위와 같이 설정하면 member 패키지만 컴포넌트 스캔에 대상이된다.

 

@ComponentScan(
	basePackages = "hello.core"
)

• basePackages : 탐색할 패키지의 시작 위치를 정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages : {"hello.core","hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
  • 만약 이런 지정된 위치가 없이 모든 java 코드(라이브러리 포)를 다 뒤지면 시간이 매우 오래 걸릴 것이다.
• basePackageClass : 지정한 클래스의 패키지 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 : @CoponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가된다.

 

*권장하는 방법*

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

 

예를 들어서 프로젝트가 다음과 같은 구조를 가지고 있다면

• com.hello
• com.hello.service
• com.hello.repository

com.hello →  프로젝트 시작 루트, 여기에 AppConfig같은 메인 설정 정보를 두고, @ComponentScan 어노테이션을 붙이고, basePackages 지정은 생략한다.

 

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

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

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Compnent 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.

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

 

해당 클래스의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있다.

@Component
public @interface Controller{
}

@Component
public @interface Service{
}

@Component
public @interface Configuration{
}

 

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

 

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

• @Controller : 스프링 MVC 컨트롤러로 인식
• @Repository : 스프링 데이터 접근 계층으로 인식하고,데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
• @Service : 사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비지니스 로직의 위치를 인식하는데 편의성을 제공한다.

➕참고
useDefaultFilters 옵션은 기본적으로 켜져있는데, 이 옵션을 끄면 스캔 대상들이 제외된다. 

 

 

[출처 - 스프링 핵심 원리 - 기본편]

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8

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