컴포넌트 스캔과 의존관계 자동 주입 시작하기
- Class가 수백개가 되면 AppConfig에서 설정하는걸 누락하거나 중복하는 문제가 발생할 수 있다.
- 그리고 귀찮다.
- 따라서, 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
- 의존 관계를 자동 주입해주는
@Autowired라는 기능도 제공한다.
@Configuration
@ComponentScan(
excludeFilters = @ComponentScan.Filter(type=FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig{
}- 컴포넌트 스캔을 사용하려면
@ComponentScan을 설정 정보에 붙여주면 된다.
- 기존의 AppConfig과 다르게 @Bean으로 등록한 클래스가 하나도 없다!
- 컴포넌트 스캔을 사용하면
@Configuration이 붙은 설정 정보도 자동 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어 둔 설정정보도 함께 등록되고, 실행되버린다. 그래서 무시하기 위해excludeFilter로 제외함. 다만, 현업에서 잘 쓰진 않음.
@Component
public class RateDiscountPolicy implements DiscountPolicy@Component
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
@Autowired
public MemberServiceImpl(MemberRepository memberRepository){
this.memberRepository = memberRepository;
}
}@Component
public class MemoryMemberRepository implements MemberRepository@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy){
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}- 컴포넌트 스캔은 말 그대로
@Component가 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
@Autowired는 의존 관계를 자동으로 주입해준다. 자세한 룰은 나중에
컴포넌트 스캔과 자동주입 동작
1. @ComponentScan
@ComponentScan은@Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
- 이때 스프링 빈의 기본 이름은 클래스 명을 사용하되, 맨앞 글자만 소문자로 사용한다.
- 직접 지정도 가능하다.
2. @Autowried 의존관계 자동 주입
- 생성자에
@Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 빈을 찾아서 주입한다.
- 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
- 이름을 수동으로 설정하거나 타입이 중복되는 경우는… 나중에!
탐색 위치와 기본 스캔 대상
@ComponentScan(
basePackages = "hello.core"
}- 탐색할 패키지의 시작 위치를 지정할 수 있다. 모든 클래스를 다 탐색하면 오래걸리므로 필요한 위치에서부터 탐색하도록 설정해주자. (심지어 라이브러리도 다 탐색한다)
basePackages: 탐색할 패키지의 시작위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.basePackages = {”hello.core”, “hello.service”}이렇게 여러개지정도 가능하다.
basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
- 만약 지정하지 않으면,
@ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
권장하는 방법
- 패키지 위치를 지정하지말고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두자. 최근 스프링 부트도 이 방법을 default로 제공한다.
컴포넌트 스캔 기본 대상
@Component: 컴포넌트 스캔에서 사용되는 기본 애노테이션
@Controller: 스프링 MVC 컨트롤러에서 사용
@Service: 스프링 비지니스 로직에서 사용
@Repository: 스프링 데이터 접근 계층에서 사용
@Configuration: 스프링 설정 정보에서 사용
👉
사실 애노테이션에는 상속관계가 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바의 기능이 아니라 스프링의 기능이다.
컴포넌트 스캔뿐 아니라 다음 부가 기능도 한다.
@Controller: 스프링 MVC 컨트롤러로 인식.
@Service: 아무 특별한 처리를 하지 않음. 그냥 개발자가 비지니스 로직임을 인식하는데에 도움을 줌.
@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다. (⇒ DB가 바뀌면 예외 자체가 바뀔 수 있기 때문에 다른 계층도 변할 수 있다. 따라서 추상화해서 반환해준다.)
@Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를함.
필터
IncludeFilter
- 컴포넌트 스캔 대상에 포함
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent{
}ExcludeFilter
- 컴포넌트 스캔 대상에 제외
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent{
}
필터 등록
@Test
void filterScan() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
BeanA beanA = ac.getBean(BeanA.class);
Assertions.assertThat(beanA).isNotNull();
assertThrows(NoSuchBeanDefinitionException.class, () -> {
BeanB beanB = ac.getBean(BeanB.class);
});
}
@Configuration
@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
static class ComponentFilterAppConfig
{
}
FilterType옵션
ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
ASPECTJ: AspectJ 패턴 사용
REGEX: 정규표현식 사용
CUSTOM:TypeFilter이라는 인터페이스를 구현해서 처리
정리
- 사실
@Component면 충분하기 때문에includeFilter를 사용할 일은 거의 없다.excludeFilter은 여러 이유로 간혹 사용할 일이 있지만, 많지는 않다.
중복 등록과 층돌
자동 빈 등록 vs 자동 빈 등록
- 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
ConflictingBeanDefinitionException예외 발생
수동 빈 등록 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을 실행해보면 이런 오류를볼 수 있다.
Uploaded by N2T
(23.05.31 22:36)에 작성된 글 입니다.
