기록하는 공간

스프링 핵심 원리 정리 -5

02 Oct 2020

컴포넌트 스캔과 의존관계 자동 주입

  • 스프링 빈을 등록할 때 자바 코드의 @Bean 또는 xml의 <bean>을 통해 설정 정보에 직접 등록할 스프링 빈을 나열하는 방법을 사용할 수 있지만 반복되고 누락될 수 있다는 단점이 있음
  • 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 @ComponentScan기능 제공
  • 컴포넌트 스캔은 @Component가 붙어 있으면 자동으로 스프링 빈으로 등록
  • @Configuration 도 Configuration 인터페이스에 @Component가 있으므로 컴포넌트 스캔의 대상이 됨
  • @Bean으로 직접 설정 정보를 작성하고 의존 관계를 명시하는 방법과 달리, 의존 관계 주입을 클래스 안에서 해결하기 위해 의존관계도 자동으로 주입하는 @Autowired 기능 제공
  • @Autowired를 통해 생성자에서 여러 의존 관계를 한 번에 주입받게 됨

컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록된다. excludeFilters 를 이용하면 스캔 제외 대상을 설정할 수 있다.

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리므로 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

@ComponentScan(basePackages = "spring.sample")
  • basePackages: 탐색할 패키지의 시작 위치를 지정하며 이 패키지를 포함하여 하위 패키지를 모두 탐색
    • 여러 위치도 지정 가능 basePackages = {"spring.sample1", "spring.sample2"}
  • basePackagesClasses: 지정한 클래스의 패키지를 탐색 시작 위로 지정
  • 지정하지 않을 경우, @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨

권장 방법

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

컴포넌트 스캔 기본 대상

  • @Component: 컴포넌트 스캔에서 사용, 아래의 애노테이션 모두 @Component 포함
  • @Controller: 스프링 MVC 컨트롤러에서 사용
  • @Service: 스프링 비즈니스 로직에서 사용
  • @Repository: 스프링 데이터 접근 계층에서 사용
  • @Configuration: 스프링 설정 정보에서 사용

애노테이션은 상속관계라는 것이 없으며 애노테이션이 특정 애노테이션을 포함하는 것을 인식하는 것은 스프링이 지원 하는 기능이다.

컴포넌트 스캔의 용도 외에도 각 애노테이션에 따라 스프링이 부가 기능을 수행한다.

  • @Controller: 스프링 MVC 컨트롤러로 인식
  • @Repository: 스프링 데이터 접근 계층으로 인식하고 데이터 계층의 예외를 스프링 예외로 변환
  • @Configuration: 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 처리
  • @Service: 특별한 처리 없이 개발자가 비즈니스 계층을 인식하는데 도움

필터

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

FilterType 옵션

  • ANNOTATION: 기본값으로 애노테이션을 인식
  • ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식
  • ASPECTJ: AspectJ 패턴 사용
  • REGEX: 정규 표현식
  • CUSTOM: TypeFilter 인터페이스를 구현해서 처리

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하는 상황은 두 가지가 있다.

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

// MemoryMemberRepository 

@Component
public class MemoryMemberRepository implements MemberRepository {
  
}

// AutoAppConfig

@Configuration
@ComponentScan
public class AutoAppConfig {
  
  @Bean(name = "memoryMemberRepository")
  public MemberRepository memberRepository() {
    return new MemoryMemberRepository();
  }
}
  • 이럴 경우에는 수동 빈 등록이 우선권을 가져 자동 빈을 오버라이딩 하게 된다.
  • 여러 설정이 얽혀서 이런 결과가 나오게 될 경우 발생한 버그는 정말 잡기 어렵다.
  • 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.
    • application.properties에 spring.main.allow-bean-definition-overriding=true 추가하면 오버라이딩 허용
    Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

Related Posts