@ComponentScan의 탐색 위치와 대상

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다.

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

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

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • 예를 들어 basePackages = "hello.core.member"라고 한다면 member 패키지를 포함한 하위 패키지들만 탐색한다.
  basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

  basePackageClasses = AutoAppConfig.class
  
  라고 한다면 AutoAppConfig가 있는 패키지(package hello.core;)를 시작 위치로 지정한다. 
  

• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.

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

 

[예시]

다음과 같은 프로젝트 구조가 있다고 가정하자

com.hello(최상단)
com.hello.serivce
com.hello.repository

 

 

com.hello 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고,

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

이렇게 하면 com.hello 를 포함한 하위(com.hello.serivce, com.hello.repository)는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 이에 벗어나는 위치에 두게 되면 컴포넌트 스캔의 대상이 되지 않는다. 

그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다 생각한다.

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

그래서 스프링 부트(@SpringBootApplication )를 쓰면 패키지 전부(루트위치에 있으므로) Component 어노테이션에 의해서 컴포넌트 스캔을 하고 자동으로 빈으로 등록되게 되는 것이다. 그래서 따로 컴포넌트 스캔을 선언하지 않아도 된다.

컴포넌트 스캔 대상

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

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

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

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

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

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

그래서 위의 어노테이션을 사용하면 자동으로 컴포넌트 스캔에 의해서 스프링 빈으로 등록되는 것이다.

 

[참고]

• 참고: 사실 애노테이션에는 상속관계라는 것이 없다. (위치가 붙어있다고 해서 서로 연동되는 건 없다)그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다. 그래서 커스텀한 애노테이션도 만들 수 있을 정도로 유연하게 제공된다.
• 컴포넌트 스캔의 용도 뿐만 아니라 다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.(원래 애노테이션은 메타정보이다)

[ @Controller ]

: (컴포넌트 스캔의 대상일 뿐만 아니라 ) 스프링 MVC 컨트롤러로 인식한다.

-역할 :

         사용자의 요청이 진입하는 지점이며

                 ->  요청에 따라 적합한 Service에 넘긴다

                -> Service에서 로직을 통해 요청을 처리한

                -> 처리한 내용을  View에게 넘겨준다. 

 

-@Controller 필요성 :

           많은 서비스들을 하나의 클래스에서 처리하지 않고  Controller라는 중간자 역할을 두어 관리가 용이

 

- 종류 :

            컨트롤러에는 1) @Controller와 2) @RestController

            전통적인 Spring MVC의 컨트롤러인 @Controller는 주로 View를 반환하기 위해 사용한다. 
            그리고 @RestController는  @Controller 기능 + @ResponseBody 어노테이션이다. 

           즉,  JSON/XML형태로 객체 데이터 반환을 하는 기능이 추가된 것이라고 할 수 있다. 

 

[ @Repository ]

: 스프링 데이터 접근 계층으로 인식하고(DB 접근), 데이터 계층의 예외를 스프링 예외(스프링의 추상화된 예외)로 변환해준다.

혹시 DB 변경으로 인해 서비스층에서 사용하는 예외가 바뀌게 된다면 안되니까 스프링이 예외를 추상화해주어서 변경으로 인해 예외가 바뀌는 일이 없게 한다.

즉, DB접근 예외를 스프링 예외로 변환해준다. 

 

 

[ @Configuration ]

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

 

[ @Service ]

: 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

 

• 참고: useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다.
• 그냥 이런 옵션이 있구나 정도 알고 넘어가자.