컴포넌트 스캔 & 의존관계 자동 주입
- 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 bean 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
- 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
- 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
- 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.
- 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다. 이는 자동으로 @Bean을 등록하기 위함이다.
- 그럼 이렇게 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다
※ 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에,
AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트
스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택하면 된다.- 컴포넌트 스캔은 이름 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로
등록한다. @Component 를 붙여주자.※ @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 어노테이션이 붙어있기 때문이다.
즉, 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 어노테이션을 붙면된다.
- 이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는
이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.- @Autowired 는 의존관계를 자동으로 주입해준다.
- @Autowired를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.
- 즉,생성자에 파라미터가 많아도 다 찾아 자동으로 주입한다.
- AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하고, 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
- 그럼 기존과 동일하게 동작한다.
- 정리
- @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
- 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다
- ex) MemberServiceImpl 클래스 memberServiceImpl
- 만약 스프링 빈의 이름을 직접 지정하고 싶으면
@Component("name") 으로 이름을 부여하면 된다.- 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
- 이때 기본는 타입이 같은 빈을 찾아서 주입한다.
getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.
탐색 위치와 기본 스캔 대상
- 탐색할 패키지의 시작 위치 지정
- 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다.
- 그래서 꼭 필요한 위치부터 탐색하도록 시작위치를 지정할 수 있다.
- basePackages :
- 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
- basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
- basePackageClasses :
- 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
- 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
- ※ 권장하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
- ※※ 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.
(그리고 이 설정안에 바로 @ComponentScan 이 들어있다.)
- 컴포넌트 스캔 기본 대상
- 컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.
- @Component : 컴포넌트 스캔에서 사용
- @Controlller : 스프링 MVC 컨트롤러에서 사용
- @Service : 스프링 비즈니스 로직에서 사용
- @Repository : 스프링 데이터 접근 계층에서 사용
- @Configuration : 스프링 설정 정보에서 사용
※: 사실 어노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 어노테이션이 특정 어노테이션을 들고
있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
- 컴포넌트 스캔의 용도 뿐만 아니라 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.
- @Controller : 스프링 MVC 컨트롤러로 인식
- @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
- @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가
처리를 한다.- @Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에
있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.
필터(Filter)
- includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다
- 순서
- MyIncluedComponent의 interface에 @target...과 같은 컴포넌트 스캔 대상에 추가할 어노테이션 기능을 추가하고 (어노테이션이 중요한게 X)
- 컴포넌트 스캔 대상인 추가할 클래스(ex.BeanA)에 @MyIncludeComponent를 붙이고,
- 설정 정보와 코드에 @fiter로 붙여 사용하면된다.
- 그럼 includeFilters에 MyIncludeComponent 어노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
- FilterType 옵션
- ANNOTATION :
- 기본값, 어노테이션을 인식해서 동작한다.(기본 옵션이라 '.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는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
- 특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기
보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장한다.
중복 등록과 충돌
- 컴포넌트 스캔에서 같은 빈 이름을 등록하면
- 자동 빈 등록 vs 자동 빈 등록
- 수동 빈 등록 vs 자동 빈 등록
- 이 두 상황에서 오류가 발생할 수 있다.
1. 자동 빈 등록 vs 자동 빈 등록
- 흔히 일어날 일은 없지만 만약 오류가 난다면,
- ConflictingBeanDefinitionException 예외 발생
2. 수동 빈 등록 vs 자동 빈 등록
- 수동 빈 등록이 우선권을 가지기 때문에, 수동 빈이 자동 빈을 오버라이딩 해버린다.
- 수동 빈 등록 시 남겨지는 로그는
"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" 이다.
- CoreApplication를 실행해보면 오류를 볼 수 있다.
까먹지말자