Spring

[Spring] 컴포넌트 스캔(@ComponentScan)

jelliclesu 2024. 9. 25. 22:52

컴포넌트 스캔

스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 @ComponentScan 이라는 기능을 제공

 

@ComponentScan 컴포넌트 스캔 동작

  • @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용
    • 빈 이름 기본 전략: MemberServiceImpl 클래스 ➡︎ memberServiceImpl
    • 빈 이름 직접 지정:  @Component("memberService2")이런식으로 이름을 부여

탐색 위치와 기본 스캔 대상 

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸림 ➡︎ 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정

@ComponentScan(
         basePackages = "hello.core",
 }
  •  basePackages: 탐색할 패키지의 시작 위치를 지정 - 이 패키지를 포함해서 하위 패키지를 모두 탐색
  •  basePackageClasses지정한 클래스의 패키지를 탐색 시작 위치로 지정
  •  지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치

‼️ 권장하는 방법
설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것

 


 

컴포넌트 스캔 기본 대상 및 부가 기능

  • @Component: 컴포넌트 스캔에서 사용
  • @Controller: 스프링 MVC 컨트롤러에서 사용 / 스프링 MVC 컨트롤러로 인식
  • @Service: 스프링 비즈니스 로직에서 사용 / 특별한 처리를 하지 않지만, 대신 개발자들이 비즈니스 계층을 인식하는데 도움
  • @Repository스프링 데이터 접근 계층에서 사용 / 스프링 데이터 접근 계층으로 인식데이터 계층의 예외를 스프링 예외로 변환
  • @Configuration스프링 설정 정보에서 사용 / 스프링 설정 정보로 인식하고스프링 빈이 싱글톤을 유지하도록 추가 처리

 

필터

  • includeFilters: 컴포넌트 스캔 대상을 추가로 지정
  • excludeFilters컴포넌트 스캔에서 제외할 대상을 지정

 

FilterType 옵션

  • 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

 

중복 등록과 충돌

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

 

  • 자동 빈 등록 vs 자동 빈 등록
    • 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생
      • ConflictingBeanDefinitionException 예외 발생
  • 수동 빈 등록 vs 자동 빈 등록
    • 수동 빈 등록이 우선권 - 수동 빈이 자동 빈을 오버라이딩

 

‼️ 같은 빈 이름 X 중요 - 스프링 부트는 수동 빈/자동 빈 충돌 시 오류 발생