반응형
@ComponentScan
- 컴포넌트 스캔은
@Component가 붙은 클래스를 스캔해서스프링 빈에 등록한다. @Configuration도@Component가 포함되어 있어서 빈에 등록 된다.- Default 스캔 범위는 컴포넌트 스캔을 한 클래스의 패키지 이하 전부이다. 스프링 프로젝트의 메인 클래스인
@SpringBootApplication안에서도 컴포넌트 스캔이 있다.
@Configuration
@ComponentScan(
//member 패키지 이하만 컴포넌트 스캔의 대상이 된다.
basePackages = "hello.core.member",
// 스캔을 안할 대상을 지정 (수동 설정 정보랑 출동 방지)
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}excludeFilters를 통해 제외할 대상을 선택할 수 있다.basePackage는 해당 패키지 이하에서만 컴포넌트 스캔을 탐색하도록 지정할 수 있다. 모든 자바클래스를 탐색하는 것은 시간이 오래걸릴 수 있으니 해당 방식을 기억해두자.basePackageClasses로 클래스를 지정할 수도 있다.- 보통 설정 클래스를 최상위 디렉토리에 두고 사용하는 것을 권장한다.
@Component
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
@Autowired // 자동 의존관계 주입
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}@Component만 설정했을 경우 의존관계가 설정이 안된다.@Autowired를 통해 자동으로 의존관계를 주입할 수 있도록 설정한다.@Autowired는 ac.getBean(MemberRepository.class)를 통해 의존 관계를 주입해주는 기능이다.
@ComponentScan 동작과정
- 컴포넌트스캔 시작시
@Component를 모두 찾아서 빈으로 등록한다. - 스프링 빈의 기본 이름은 클래스명을 사용하되, 앞 글자만 소문자로 사용
- 직접 이름을 부여하고 싶으면
@Component("memberService2")와 같이 구현이 가능하다.
@Autowired 동작 과정
- 생성자에
@Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. - 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
- MemberRepository를 들어가서 타입에 맞는 MemoryMemberRepository를 가져와 등록한다.
- 같은 타입이 여러 개일 경우 등과 같은 내용은 나중에 다뤄보자.
@ComponentScan 테스트
package hello.core;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;
class AutoAppConfigTest {
@Test
void basicScan() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
MemberService memberService = ac.getBean(MemberService.class);
assertThat(memberService).isInstanceOf(MemberService.class);
}
}@Component와@Autowired설정을 통해 빈 주입이 정상적으로 주입됐는지 테스트
@ComponentScan 기본 대상
@Controller: 스프링 MVC 컨트롤러로 인식@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층(DB 접근)의 예외를 스프링 예외로 변환해준다.@Service: 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다. 보통 비즈니스로직이 시작할 때 트랜잭션을 관리한다.@Configuration: 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
애노테이션에는 상속 관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 것이 아닌, 스프링이 지원하는 기능이다. useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 이런 옵션이 있구나 정도 알고 넘어가자
필터
includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.
@Target(ElementType.TYPE) //TYPE : 클래스 LEVEL
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}- 필터 확인을 위한 커스텀 어노테이션 생성
- MyIncludeComponent 도 동일하게 생성
public class ComponentFilterAppConfigTest {
@Test
void filterScan() {
ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
BeanA beanA = ac.getBean("beanA", BeanA.class);
assertThat(beanA).isNotNull();
BeanB beanB = ac.getBean("beanB", BeanB.class);
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 패턴 사용 ex) org.example..*Service+ *
- REGEX: 정규 표현식 ex) org.example.Default.
- CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리 ex) org.example.MyTypeFilter
@Component면 충분하기 때문에 보통은 includeFilters는 사용할일이 없다. excludeFilter는 여러 이유로 간혹 사용할 때는 있지만 많지 않다는점만 알아두자. 최근에는 컴포넌트 스캔을 통해 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 선호하는 편이다.
중복 등록과 충돌
- 컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까? 두 가지 상황이 존재한다.
자동 빈 vs 자동 빈
- 이름이 같은 경우 스프링은 오류를 발생시킨다. ConflictingBeanDefinitionException 예외 발생
수동 빈 vs 자동 빈
- 해당 경우는 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)
- 최근 스프링 부트에서는 개발자의 의도라고 판단되지 않기 때문에 오류가 발생하도록 바꼈다.
즉, 빈 이름이 중복된다면 오류를 발생한다.
본 포스팅은 인프런 김영한님 강의(스프링 핵심원리 - 기본편)를 토대로 정리한 내용입니다.
반응형
