지금까지의 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>을 통해서 설정 정보에 직접 등록할 빈을 나열했습니다. 실제 등록한 빈은 몇개 없었지만, 등록해야할 빈이 수백개가 된다면 일일이 등록하는 번거로움, 누락하는 문제가 생길 수 있습니다.
그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공합니다. 또 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공합니다.
코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보고자 합니다. 기존 AppConfig는 과거 코드와 테스트를 유지하기 위해 남겨두고 새로운 객체를 만들어서 테스트 해보도록 하겠습니다.
AutoAppConfig
@Configuration
// excludeFilters : 컴포넌트 스캔으로 스프링 빈에 등록할 데이터 중 뺄 것들을 미리 지정
@ComponentScan(
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
Configuration.class))
public class AutoAppConfig {
}컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 추가하면 됩니다. 코드를 보시면 기존의 AppConfig와 다르게 @Bean으로 등록한 클래스가 없는 것을 볼 수 있습니다.
참고로 @ComponentScan을 사용하면 @Configuraion이 붙은 설정 정보도 자동으로 등록되기 떄문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되며 실행되어 버립니다. 그래서 excludeFilters를 이용하여 @Configuration으로 등록되는 객체를 스캔 대상에서 제외시켜 주었습니다.
컴포넌트 스캔은 이름 그대로 @Component가 붙은 클래스를 스캔해서 스프링 빈으로 등록합니다.
참고로 @Configuration이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component가 설정정보로 붙어있기 떄문입니다.
이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component를 붙여주도록 하겠습니다. 또한 의존관계를 자동으로 주입해야하기 떄문에 의존관계를 주입하는 메서드였던 생성자에 @Autowired를 붙여주었습니다. 대표적으로 두 클래스의 코드만 보여주도록 하겠습니다.
MemoryMemberRepository 객체에 @Component 추가
@Component
public class MemoryMemberRepository implements MemberRepository {}
MemberServiceImpl 객체에 @Component, @Autowired 추가
@Component
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
// @Autowired를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있습니다.
@Autowired
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
}
테스트 코드
public class AutoAppConfigTest {
@Test
void basicScan() {
ApplicationContext ac = new
AnnotationConfigApplicationContext(AutoAppConfig.class);
MemberService memberService = ac.getBean(MemberService.class);
assertThat(memberService).isInstanceOf(MemberService.class);
}
}
출력
shared instance of singleton bean 'autoAppConfig'
shared instance of singleton bean 'rateDiscountPolicy'
shared instance of singleton bean 'memberServiceImpl'
shared instance of singleton bean 'memoryMemberRepository'
shared instance of singleton bean 'orderServiceImpl'실제 출력되는 것을 보면 @Component의 설정정보를 추가한 객체들이 스프링 빈에 등록된 것을 볼 수 있습니다.
컴포넌트 스캔은 알겠지만, 자동 의존관계 주입이 어떻게 동작되는지 감이 잘 오지 않을텐데요. 그림으로 한번 알아보도록 하겠습니다.
1. @ComponentScan
- @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록합니다.
- 이때, 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자롤 사용합니다. (카멜표기법)
- 만약, 빈 이름을 직접 지정하고 싶다면 @Component("지정하고 싶은 이름")을 사용하면 됩니다.
2. @Auowired 의존관계 자동 주입
- 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입합니다.
- 이때, 기본 조회 전략은 타입이 같은 빈을 찾아서 주입합니다.
- getBean(MemberRepository.class)와 동일하다고 이해하면 좋을 것 같습니다.
- 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입합니다.
탐색위치와 기본 스캔 대상
탐색할 패키지의 시작 위치 지정
모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸립니다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있습니다.
@ComponentScan(
basePackages = "hello.core",
}- basePackages : 탐색할 패키지의 시작 위치를 지정합니다. 이 패키지를 포함해서 해당 패키지부터 하위 패키지의 모든 객체를 탐색합니다.
- basePackages = {"hello.core", "hello.service"} 이런 식으로 시작 위치를 여러개 지정할 수도 있습니다.
- basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정합니다. (예를들어, AppConfig.class를 지정했을 때 AppConfig가 있는 패키지인 hello.core부터 모든 하위패키지의 객체를 탐색합니다.)
- 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됩니다.
권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것 입니다. 최근 스프링 부트도 해당 방법을 기본으로 제공한다고 합니다.
예를 들어서 프로젝트가 아래와 같은 구조로 되어있다면
- hello.core
- hello.core.service
- hello.core.repository
hello.core를 프로젝트 시작 루트, 해당 패키지에 AppConfig와 같은 메인 설정 정보를 둔 뒤 @ComponentScan을 붙이고 basePackages는 생략하는 것 입니다.
참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위에 두는 것이 관례입니다. (그리고 해당 설정안에 바로 @ComponentScan이 들어있다고합니다.)
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {}
컴포넌트 스캔 기본 대상
참고로 컴포넌트 스캔은 @Component 뿐만 아니라 아래와 같은 내용도 추가로 포함됩니다.
- @Component : 컴포넌트 스캔에서 사용
- @Controller : 스프링 MVC 컨트롤러에서 사용
- @Service : 스프링 비즈니스 로직에서 사용
- @Repository : 스프링 데이터 접근 계층에서 사용
- @Configuration : 스프링 설정 정보에서 사용
@Component
public @interface Controller {
}
@Component
public @interface Service {
}
@Component
public @interface Configuration {
}위의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있습니다.
참고로 어노테이션에는 사실 상속관계라는 것이 없습니다. 그래서 어떤 어노테이션이 특정 어노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능입니다.
필터
- includeFilters : 컴포넌트 스캔 대상을 추가로 지정합니다.
- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정합니다.
빠르게 예제로 확인해보도록 하겠습니다.
컴포넌트 스캔 대상을 추가할 어노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}
컴포넌트 스캔 대상에서 제외할 어노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}
컴포넌트 스캔 대상에 추가할 클래스
@MyIncludeComponent
public class BeanA {
}
컴포넌트 스캔 대상에서 제외할 클래스
@MyExcludeComponent
public class BeanB {
}
테스트 코드
public class ComponentFilterAppConfigTest {
@Test
void filterScan() {
ApplicationContext ac = new
AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
BeanA beanA = ac.getBean("beanA", BeanA.class);
assertThat(beanA).isNotNull();
// 빈이 없기떄문에 터짐
//ac.getBean("beanB", BeanB.class);
Assertions.assertThrows(
NoSuchBeanDefinitionException.class,
() -> ac.getBean("beanB", BeanB.class));
}
@Configuration
@ComponentScan(
includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes =
MyIncludeComponent.class),
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class)
)
static class ComponentFilterAppConfig {
}
}
FilterType은 5가지 옵션이 있습니다.
- 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 자동 빈 등록
- 수동 빈 등록 vs 자동 빈 등록
자동 빈 등록 vs 자동 빈 등록
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류(ConflictingBeanDefinitionException)를 발생시킵니다.
수동 빈 등록 vs 자동 빈 등록
만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까요?
@Component
public class MemoryMemberRepository implements MemberRepository {}@Configuration
@ComponentScan(
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
Configuration.class)
)
public class AutoAppConfig {
@Bean(name = "memoryMemberRepository")
public MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
}이 경우 수동 빈 등록이 우선권을 가집니다. (수동 빈이 자동 빈을 오버라이딩 해버립니다.)
출력
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
스프링 부트에서 실행해보면 오류를 볼 수 있습니다.
출처
스프링 핵심 원리 - 기본편 - 인프런 | 강의
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...
www.inflearn.com
'spring > 인프런 강의 정리' 카테고리의 다른 글
| [Spring/기본편] 7. 빈 생명주기 콜백 (0) | 2021.12.26 |
|---|---|
| [Spring/기본편] 6. 의존관계 자동 주입 (0) | 2021.12.25 |
| [Spring/기본편] 4. 싱글톤 컨테이너 (0) | 2021.12.23 |
| [Spring/기본편] 3. 순수한 자바 프로젝트를 Spring으로 변경(Bean) (0) | 2021.12.22 |
| [Spring/기본편] 2. 순수한 자바로 SOLID특징 지키며 설계하기 (0) | 2021.12.22 |
