컴포넌트 스캔

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

package com.abcdejoji.springbaisc;

import org.springframework.context.annotation.*;

@Configuration
@ComponentScan
public class AutoAppConfig {
}

• com.abcdejoji.springbaisc 하위의 @Component가 붙은 모든 클래스를 빈으로 등록

빈으로 등록할 클래스에 @Component 및 @Autowired 붙이기

• @Component: 빈으로 등록할 클래스에 붙임
• @Autowired: 의존 관계 주입을 자동으로 해줌

@Component
public class MemoryMemberRepository implements MemberRepository {
}

@Component
public class RateDiscountPolicy implements DiscountPolicy {
}

@Component
public class MemberServiceImpl implements MemberService {

  private final MemberRepository memberRepository;

  @Autowired
  public MemberServiceImpl(MemberRepository memberRepository) {
    this.memberRepository = memberRepository;
  }
}

@Component
public class OrderServiceImpl implements OrderService {

  private final MemberRepository memberRepository;
  private final DiscountPolicy discountPolicy;

  @Autowired
  public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
  }
}

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

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

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

탐색 위치와 기본 스캔 대상

@ComponentScan(
  basePackages = {"com.abcdejoji.springbaisc"}
)

• basePackages: 탐색할 패키지의 시작 위치를 지정. 이 패키지를 포함해서 하위 패키지를 모두 탐색
  • 여러 개도 지정 가능
• basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨

스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례입니다.

@SpringBootApplication에는 @ComponentScan이 들어 있습니다.

컴포넌트 스캔 기본 대상

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

해당 클래스의 소스 코드를 보면 @Component를 포함하고 있습니다.

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

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

• @Controller: 스프링 MVC 컨트롤러로 인식
• @Service: 특별한 처리 없음. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움
• @Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리

useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외 됨

필터

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

FilterType 옵션

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

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

• 수동 빈이 우선권을 가짐

하지만 대부분 이런 상황은 설정이 꼬여 만들어지는 상황이 대부분이기 때문에 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었습니다.

참고

• https://www.inflearn.com/course/스프링-핵심-원리-기본편