Spring 핵심 원리 기본편 - 6. 컴포넌트 스캔

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

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

- 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공

- 또 의존 관계도 자동 주입하는 @Autowired 라는 기능도 제공

 

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
        // 보통 설정 정보는 컴포넌트 스캔 대상에서 제외하지 않는다.
)
public class AutoAppConfig {
}

- 컴포넌트 스캔을 사용할려면 @ComponentScan 을 설정 정보에 붙여주면 된다.

- 컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

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

 

- 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 떄문에, 의존관계 주입도 이 클래스 안에서 해결해야한다.

- @Autowired는 의존관계를 자동으로 주입해준다.

- @Autowired를 사용하면 생성자에서 여러 의존관계도 한번 주입받을 수 있다.

 

1. @ComponentScan

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

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

     ㆍ* 빈 이름 기본 전략 : MemberServiceImpl 클래스 → memberServiceImpl

     ㆍ* 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("meberService2") 로 이름 부여

 

2. @Autowired

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

- 이떄 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다

     ㆍ 'getBean(MemberRepository.class)' 와 동일하다고 이해하면 된다

- 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다

 

---

탐색 위치와 기본 스캔 대상

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

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

- basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

     ㆍbasePackages = { "hello.core", "hello.service" } 이렇게 여러 시작 위치를 지정할 수 도 있음

- basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위로 지정한다

- 만약 지정하지 않는다면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

* 권장하는 방법 *

: 패키지 위치를지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.

     ㆍcom.hello → 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고,

                             @ComponentScan 애노테이션을 붙이고, 'basePackages' 지정은 생략

     ㆍ참고 : 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 프로젝트 

                  시작 루트 위치에 두는 것이 관례 ( 이 설정안에 바로 @ComponentScan이 들어 있다 )

 

컴포넌트 스캔 기본 대상

- @Component : 컴포넌트 스캔에서 사용

- @Controller : 스프링 MVC 컨트롤러에서 사용

     ㆍ스프링 MVC 컨트롤러를 인식

- @Service : 스프링 비즈니스 로직에서 사용

     ㆍ사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 비즈니스계층을 인식하는 도움된다.

- @Repository : 스프링 데이터 접근 계층에서 사용

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

- @Configuration : 스프링 설정 정보에서 사용

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

 

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

 

- 참고 : useDefaultFilters 옵션은 기본으로 켜져있는데 이 옵션을 끄면 기본 스캔 대상들이 제외된다. ( 몰라도 됨 )

 

---

필터

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

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

@ComponentScan(
            includeFilters = @Filter(type= FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @Filter(type= FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)

 

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

 

- 참고 : 사용할 일이 많지 않다.

 

---

중복 등록과 충돌

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

- 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.

     ㆍConflictingBeanDefinitionException 예외 발생

 

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

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

 

* 수동 빈 등록시 남는 로그 *

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

- 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 겨우가 대부분이다. * 그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다. *

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

 

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

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

 

 

 

출처 :

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

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/