meatsby.github.io

05. Spring Component Scan

5 min read

컴포넌트 스캔과 의존관계 자동 주입 시작하기

  • 지금까지 스프링 빈을 등록할 때는 @Bean 을 통해 설정 정보에 직접 등록할 빈을 나열했음
  • 빈이 수십 수백개가 되면 일일이 등록하기도 귀찮고 설정 정보도 커지고 누락되는 문제도 발생
  • 그래서 스프링은 설정정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공
  • 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공
  • @Component 가 붙어 있으면 스캔 대상이 됨

@ComponentScan

  • @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자로 사용
  • @Component 애너테이션이 있으면 스프링 빈이 자동 등록된다.
  • @Controller @Service @Repository 내부에 @Component 를 포함하기에 빈으로 자동 등록된다.

@Autowired 의존관계 자동 주입

  • 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치

@ComponentScan(
        basePackages = {"hello.core", "hello.service"},
        basePackageClasses = AutoAppConfig.class
)
  • 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸림 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있음
  • basePackages - 탐색할 패키지의 시작 위치를 지정. 이 패키지 포함 하위 패키지를 모두 탐색
  • basePackageClasses - 지정한 클래스의 패키지를 탐색 시작 위치로 지정
  • 만약 미지정 시 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨
    • 때문에 @SpringBootApplication 이 가장 최상위 패키지에 위치하는 것

컴포넌트 스캔 기본 대상

컴포넌트 스캔의 용도 뿐 아니라 어노테이션에 따른 부가 기능을 수행한다.

  • @Component
  • @Controller - 스프링 MVC 컨트롤러로 인식
  • @Service - 특별한 처리 x 대신 개발자들이 비즈니스 로직이 들어가는 곳으로 인식
  • @Repository - 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
  • @Configuration - 스프링 빈이 싱글톤을 유지하도록 추가 처리

필터

@ComponentScan(
        includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
  • includeFilters 에 MyIncludeComponent 어노테이션을 추가해서 BeanA 가 등록됨
  • excludeFilters 에 MyExcludeComponent 어노테이션을 추가해서 BeanB 가 등록되지 않음

FilterType 옵션

  • ANNOTATION - 기본값
  • ASSIGNABLE_TYPE - 지정한 타입과 자식 타입을 인식
  • ASPECTJ - AspectJ 패턴 사용
  • REGEX - 정규 표현식
  • CUSTOM - TypeFilter 라는 인터페이스를 구현해서 처리

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록한다면?

  1. 자동 빈 등록 vs 자동 빈 등록
  2. 수동 빈 등록 vs 자동 빈 등록

자동 빈 등록 vs 자동 빈 등록

  • 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 이름이 같은 경우 스프링은 예외를 발생시킴
    • ConflictingBeanDefinitionException 발생

수동 빈 등록 vs 자동 빈 등록

  • Spring Framework 에선 수동 등록 빈이 우선권을 가짐 수동 빈이 자동 빈을 오버라이딩함
  • 근데 Spring Boot 에선 예외를 발생시켜버림

Graph View