[스프링 핵심 원리 - 기본편] 컴포넌트 스캔

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

• 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능을 제공
• 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공

@ComponentScan

@Component 애너테이션이 붙은 클래스를 찾아 자동으로 스프링 빈에 등록

AutoAppConfig.java

@Configuration
@ComponentScan(
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))
public class AutoAppConfig {
 
}

• excludeFilters 자동으로 스프링 빈에 등록할 때 뺄것을 지정해주는 것
• 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애너테이션을 붙여줘야 함
• 이전에는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시
• AutoAppConfig 클래스에는 이런 설정 정보 자체가 없으므로 자동 의존관계를 설정 해줘야함

MemberServiceImpl.java

@Component
public class MemberServiceImpl implements MemberService {
 private final MemberRepository memberRepository;
 
 @Autowired //ac.getBean(MemberRepository.class)와 비슷한 역할
 //MemberRepository타입에 맞는 스프링빈을 자동으로 주입
 public MemberServiceImpl(MemberRepository memberRepository) {
 this.memberRepository = memberRepository;
 }
}

컴포넌트 스캔의 대상이 되는 클래스 안에서 @Autowired 를 생성자에 붙여주어 의존관계를 자동으로 주입

컴포넌트 스캔과 자동 의존관계 동작 방법

1. @ComponentScan

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

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

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
• 기본적으로 타입으로 조회, getBean(MemberRepository.class) 와 비슷
• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입

탐색 위치와 기본 스캔 대상

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

@ComponentScan(
 basePackages = "hello.core",
}

• basePackages 탐색할 패키지의 시작 위치를 지정, 이 패키지를 포함해서 하위 패키지를 모두 탐색 > 시간 절약, 유연한 사용 가능
  basePackages = {"hello.core", "hello.service"} 처럼 여러 시작 위치 지정 가능
• basePackageClasses 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 아무것도 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨
• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함

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

필터

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

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록될 때 그 이름이 같은 경우 ConflictingBeanDefinitionException 예외 발생

수동 빈 등록 vs 자동 빈 등록

수동 빈 등록이 우선권을 가짐(수동 빈이 자동 빈을 오버라이딩)

잡기 어려운 버그가 만들어 질 수 있음!!
그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꿈

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

Consider renaming one of the beans or enabling overriding by setting 
spring.main.allow-bean-definition-overriding=true

출처
스프링 핵심 원리 - 기본편