스프링 핵심원리 기본편 6 - 컴포넌트 스캔

최창수·2024년 8월 22일
0
  1. 컴포넌트 스캔과 의존관계 자동 주입
    스프링은 설정정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 제공.
    또한 의존관계 자동 주입을 위한 @Autowired 제공.

  2. @Component가 붙은 모든 클래스를 스프링 빈으로 등록.
    스프링 빈의 기본 이름은 구체 클래스명의 카멜케이스(맨 앞만 소문자로 변경)
    이름 지정 가능 @Component("이름")

  3. @Autowired로 의존관계 자동 주입.
    컴포넌트 스캔 사용 시 설정에서 의존주입을 하지 않으므로 필요하다.
    타입이 같은 빈을 찾아서 주입한다.
    ac.getBean(MemberService.class);와 동일
    같은 타입의 빈이 여러개 일 경우 추후 추가 설명
    생성자에 파라미터가 여러개 있어도 자동으로 찾아서 주입해준다.

  1. 탐색 위치와 기본 스캔 대상
    꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.
@ComponentScan(
         basePackages = "hello.core",
}

탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
권장: 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것. (최근 스프링 부트도 이 방법을 기본으로 제공)
프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보 이므로 프로젝트 시작 루트 위치에 두는 것이 좋다.
스프링 부트: @SpringBootApplication이 프로젝트 시작 루트 위치에 두는 것이 관례.

  1. 컴포넌트 스캔은 @Component 뿐이 아니라 다음도 스캔.

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

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

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

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

  • @Controller : 스프링 MVC 컨트롤러로 인식
  • @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
    를 한다.
  • @Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직을 찾고 비즈니스 계층을 인식하는데 도움이 된다.
  • 참고: useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나 정도 알고 넘어가자.
  1. 컴포넌트 스캔의 필터기능
  • includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
  • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.

FilterType 옵션: FilterType은 5가지 옵션이 있다.
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 자동빈등록: 이름이 같은 경우 스프링은 오류를 발생
  • 수동빈등록 vs 자동빈등록: 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩)

최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

수동 빈 등록 + 자동 빈 등록 오류시 스프링 부트 에러:

Action: Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true

스프링 부트인 CoreApplication 을 실행해보면 위 오류를 볼 수 있다.

애매한 추상화 보다는 명확한 오류를 지향하자.

profile
Hallow Word!

0개의 댓글