29주차 - 탐색 위치와 기본 스캔 대상

탐색 위치와 기본 스캔 대상

 

탐색할 패키지의 시작 위치 지정 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다.

그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

basePackages = "hello.core",

 

 

hello.core.member로 설정 → member 패키지 부터 하위 패키지까지 찾아간다.

member만 컴포넌트 스캔의 대상이 된다.

 

 

AutoAppConfigTest를 실행해보면

memberServiceImpl과 memoryMemberRepository 2개만 등록이 되었다.

 

 

 

지정하는 이유? 모든 자바 코드를 뒤지기 때문에(라이브러리 포함) 오래걸린다.

여러 라이브러리가 섞여있을 때 컴포넌트 스캔을 지정하고 싶지 않은 경우도 생길 수 있으므로

유연하게 사용할 수 있다.

 

 

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

basePackages : 탐색할 패키지의 시작 위치를 지정한다.

이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

 

basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

 

 

 

 

basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

 

basePackageClasses = AutoAppConfig.class,

 

AutoAppConfig의 패키지는 hello.core이므로 hello.core에서도 찾는다.

 

 

 

 

만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다

hello.core

 

 

---

권장하는 방법

개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고,

설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.

 

최근 스프링 부트도 이 방법을 기본으로 제공한다.

 

 

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

 

com.hello

com.hello.serivce

com.hello.repository

 

 

com.hello가 최상단 → 프로젝트 시작 루트,

여기에 AppConfig 같은 메인 설정 정보를 두고, (지금같은 경우에는 AutoAppConfig이다.)

@ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

 

이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에

프로젝트 시작 루트 위치에 두는 것이 좋다.

 

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를

이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

(그리고 이 설정안에 바로 @ComponentScan 이 들어있다)

 

 

 

 

그래서 스프링부트를 쓰면 자동으로 스프링 빈에 등록되고 하는 것이다.

* 불필요한 것들은 exclude에서 빼는 것을 권장

 

---

컴포넌트 스캔 기본 대상

 

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

 

ex

 

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

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

@Service : 스프링 비즈니스 로직에서 사용

@Repository : 스프링 데이터 접근 계층에서 사용

@Configuration : 스프링 설정 정보에서 사용

 

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

 

 

참고: 사실 애노테이션에는 상속관계라는 것이 없다.

그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은

자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

 

 

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

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

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

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

@Service : 사실 @Service 는 특별한 처리를 하지 않는다.

대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

 

 

 

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

그냥 이런 옵션이 있구나 정도 알고 넘어간다.