기록하는 습관

스프링 핵심 원리 - 기본편 (5) - 컴포넌트 스캔 본문

개발/Spring

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

로그뉴 2021. 6. 27. 21:24

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

지금까지는 스프링 빈을 등록할 때 자바 코드의 @Bean이나 XML <bean> 등을 통해서 설정 정보에 직 접 등록할 스프링 빈을 나열했다.

만약 등록해야 할 빈이 수백개가 된다면 관리하기 번거로워진다.

따라서, 스프링은 설정 정보가 없어도 자동으로! 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공한다.

의존 관계도 자동으로 주입해주는 @Autowired 기능도 제공한다.

컴포넌트 스캔(Component Scan)

@Component 어노테이션이 붙은 모든 클래스를 스캔해서 스프링 빈으로 등록한다.

이 때, 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

  • 빈 이름 기본 전략: MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 같이 이름을 부여하면 된다.

2. @Autowired 의존관계 자동 주입

생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

  • 기본 조회 전략은 타입이 같은 빈을 찾아서 주입하는 것!!

 

[ 탐색 위치와 기본 스캔 대상 ]

컴포넌트 탐색 위치

모든 클래스를 스캔하면 시간이 오래 걸리므로 탐색할 시작 위치를 지정할 수 있다.

 

  • basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
  • 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다. → 성능 저하

 

권장하는 방법

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상 단에 두는 것. 스프링 부트도 이 방법을 기본으로 제공한다.

 

기본 스캔 대상

  • @Component : 컴포넌트 스캔에서 사용
  • @Controller : 스프링 MVC 컨트롤러에서 사용
  • @Service : 스프링 비즈니스 로직에서 사용
  • @Repository : 스프링 데이터 접근 계층에서 사용 (JPA, JDBC 등..)
  • @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 자동 빈 등록

이 경우 수동 빈이 자동 빈을 오버라이딩 해서 수동 빈 등록이 우선권을 가진다.

 

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

Consider renaming one of the beans or enabling overriding by setting

 

++ 어설픈 추상화나 어설픈 코드보다 코드가 길더라도 명확한 코드를 작성하는 것이 오류 잡기 훨씬 좋다!!! 명심할 것.

Comments