[Spring] 컴포넌트 스캔

1. 컴포넌트 스캔

• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔(Component Scan)이라는 기능을 제공함
• 의존관계도 자동으로 주입하는 @Autowired 기능도 제공함

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

}

• 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버림
  -> excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외함
• 컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록함

  참고: @Configuration 이 컴포넌트 스캔의 대상이 된 이유는 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문임

Component Scan

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

Autowired

• 생성자에 @Autowired 지정 시 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입함
• 기본 조회 전략은 타입이 같은 빈을 찾아서 주입함
  -> getBean(MemberRepository.class)와 동일

2. 탐색 위치와 기본 스캔 대상

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

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

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

• basePackages : 탐색할 패키지의 시작 위치 지정, 이 패키지를 포함해서 하위 패키지 모두 탐색
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 권장하는 방법 : 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것, 최근 스프링 부트도 이 방법을 기본으로 제공함
• 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례(그리고 이 설정안에 @ComponentScan이 들어있음!)

기본 스캔 대상

@Component : 컴포넌트 스캔에서 사용
아래 애노테이션 모두 @Component 애노테이션을 포함하고 있음
@Controlller : 스프링 MVC 컨트롤러에서 사용
@Service : 스프링 비즈니스 로직에서 사용
@Repository : 스프링 데이터 접근 계층에서 사용, 데이터 계층의 예외를 스프링 예외로 변환해줌
@Configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리함

• 애노테이션에는 상속관계라는 것이 없음 -> 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바가 아닌 스프링이 지원하는 기능
• 참고 : useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외됨

3. 필터

• 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

• 참고 : @Component로 충분하기 때문에, includeFilters 를 사용할 일은 거의 없음, excludeFilters는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않음
  -> 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장

4. 중복 등록과 충돌

• 만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?
  -> 이 경우 수동 빈 등록이 우선권을 가짐(수동 빈이 자동 빈을 오버라이딩 해버림)
  -> 수동 빈 등록시 남는 로그

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

• 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꿈
• 수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러(스프링 부트 실행 시 오류 볼 수 있음)

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

자료 출처