[Spring] 컴포넌트 스캔

- 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

- 등록해야 할 스프링 빈이 많아지면 반복해야 하는 코드의 양도 많아지고 누락하는 문제 등이 발생할 수 있다.

- 이 때 컴포넌트 스캔과 의존관계 자동 주입 기능을 사용할 수 있다.

 

 

컴포넌트 스캔 예제 코드

- basePackages를 이용하여 컴포넌트 스캔의 시작 지점을 설정할 수 있다.(모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리기 때문)

- 시작 위치를 여러 개 지정할수도 있으며 지정하지 않는다면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

- 권장되는 방법으로는 프로젝트 시작 루트에 설정 정보 클래스를 위치시키는 것이다.(스프링 부트도 @SpringBootApplication을 이용하여 이 방법을 사용한다.)

- excludeFilters를 이용하여 스캔 대상에서 제외시킬 수 있다. 여기에서는 @Configuration 애너테이션이 붙은 클래스들을 제외시켰다.

 

 

컴포넌트 스캔과 자동 의존관계 주입(@Autowired) 동작원리

- @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.

- 이 때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

 

- 생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

- 이 때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다. (getBean(클래스명.class)과 동일하다고 이해하면 된다.)

 

 

컴포넌트 스캔 기본 대상: @Component, @Controller, @Service, @Repository, @Configuration

- 해당 클래스의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있다.

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

 

해당 애너테이션에 대한 스프링의 부가 기능

@Controller: 스프링 MVC 컨트롤러로 인식

@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.

@Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

@Service: 특별한 처리는 하지 않고 다른 개발자들이 비즈니스 계층을 인식하는데 도움이 된다.

 

 

필터

includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.

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

 

예제 코드

 

임의로 두 개의 애너테이션을 만든다.

 

만든 애너테이션을 각각 클래스에 붙여준다.

 

아래와 같이 필터 기능을 추가할 수 있다.

 

FilterType 옵션

ANNOTATION: 기본값, 애너테이션을 인식해서 동작한다.

ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.

ASPECTJ: AspectJ 패턴 사용

REGEX: 정규 표현식

CUSTOM: TypeFilter라는 인터페이스를 구현해서 처리

 

 

중복 등록과 충돌

1. 자동 빈 등록 vs 자동 빈 등록

- 빈 이름이 같은 경우 ConflictingBeanDefinitionException 예외 발생

 

2. 수동 빈 등록 vs 자동 빈 등록

- 이 경우 수동 빈 등록이 우선권을 가진다.(수동 빈이 자동 빈을 오버라이딩 해버린다.)

- 개발자가 의도한 것이 아니라 여러 설정들이 꼬여서 이런 상황이 발생한다면 잡기 어려운 버그가 만들어진다.

- 따라서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

- 이러한 설정은 application.properties 에서 아래와 같이 변경 가능하다.

spring.main.allow-bean-definition-overriding=true

 

 

 

출처: 인프런 김영한님의 스프링 핵심 원리 - 기본편

스프링 핵심 원리 - 기본편 - 인프런 | 강의