컴포넌트 스캔

등록해야 할 스프링 빈이 수십, 수백개가 되면 관리가 힘들어진다. 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 또한 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

적용 예제

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

• 컴포넌트 스캔을 사용하려면 @ComponentScan 어노테이션을 설정 정보에 붙여준다.
• 컴포넌트 스킨은 이름 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
• excludeFilters는 컴포넌트 스캔의 제외 대상을 명시해준다.

동작원리

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

컴포넌트 적용 대상

@Component

• 컴포넌트 스캔에서 사용

@Controlller

• 스프링 MVC 컨트롤러에서 사용

@Service

• 스프링 비즈니스 로직에서 사용
• 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

@Repository

• 스프링 데이터 접근 계층에서 사용
• 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.

@Configuration

• 스프링 설정 정보에서 사용
• 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처 리를 한다.

@Autowired 의존관계 자동 주입

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

탐색 위치 선정 및 필터링

탐색위치 권장사항

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
• 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝 트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다)

탐색위치 지정 방법

@ComponentScan(
basePackages = "dev.highright96.core",
}

• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
• basePackages = {"dev.highright96.core", "dev.highright96.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다. 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

필터방법

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

예시

@Configuration
@ComponentScan(
        includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyIncludeAnnotation.class),
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyExcludeAnnotation.class)
)
class ComponentFilterAppConfig{

}

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 spring.main.allow-bean-definition-overriding=true