ComponentScan

황상익·2024년 4월 5일

Spring 기본

목록 보기
7/10

ComponentScan과 의존관계 자동 주입 시작

스프링 빈을 등록할때 자바의 코드 @Bean이나 XML bean 등을 통해서 설정 정보에 직접 등록 해서 스프링 나열
의존관계 자동 주입해주는 @Autowired라는 기능 제공

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter (type = FilterType.ANNOTATION, classes =
        Configuration.class) //filter -> 걸러서 scan
)
public class AutoAppConfig {

}

참고)
ComponentScan을 사용하면 @Configuration이 붙은 설정 정보 자동으로 등록
excludeFilters를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외,

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

각 클래스가 ComponentScan 대상이 되도록 @Component 애노테이션을 붙여준다.
MemoryMemberRepository @Component 추가
RateDiscountPolicy @Component 추가
MemberServiceImpl @Component, @Autowired 추가

이전에 AppConfig에서는 @Bean으로 직접 설정정보 작성했지만, @Autowired는 의존관계를 자동으로 주입

 @Autowired
    private final MemberRepository repository;
    @Autowired
    private final DiscountPolicy rateDiscountPolicy;

@Autowired를 사용하면 생성자에서 여러 의존관계 한번에 주입 가능

public class AutoAppConfigTest {
    
    @Test
    void basicScan(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링빈으로 자동 등록
빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl
빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면
@Component("memberService2") 이런식으로 이름을 부여하면 된다


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

탐색 위치와 기본 스캔 대상
탐색할 패키지의 시작 위치 지정
모든 클래스를 다 컴포넌트 스캔하면 시간이 오래걸린다.

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

basePackages: 탐색시 시작 위치를 지정, 하위 패키지 모두 탐색, 여러 위치 지정 가능
basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
만약 지정하지 않으면,
@ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다

컴포넌트 스캔 기본 대상
@Component 뿐만 아니라 다음 내용도 추가로 대상에 포함

@Component : 컴포넌트 스캔에서 사용
@Controlller : 스프링 MVC 컨트롤러에서 사용
@Service : 스프링 비즈니스 로직에서 사용
@Repository : 스프링 데이터 접근 계층에서 사용
@Configuration : 스프링 설정 정보에서 사용

사실 애노테이션에는 상속관계라는 의미 X 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바언어가 지원하는 기능X , 스프링이 지원하는 기능

@Controller : 스프링 MVC 컨트롤러로 인식
@Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가
처리를 한다.
@Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다

필터
includeFilters : 컴포넌트 스캔 대상을 추가로 지정
excludeFilters : 컴포턴트 스캔에서 제외할 대상을 지정

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}
@Target(ElementType.TYPE) // 클래스에 level이 붙는다
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}
@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();

        assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("beanB", BeanB.class));
    }

    @Configuration
    @ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {
    }
}

FitlerType 옵션

ANNOTATION : 기본값, 애노테이션을 인식 동작
ASSINGABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작
ASPECTJ : AspectJ 패턴을 사용
REGEX : 정규표현식
CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리

중복 등록과 충돌
같은 빈 이름 등록한다면??

  1. 자동 빈 등록 VS 자동 빈 등록
    ConflictingBeanDefinitionException 예외 발생

  2. 수동 빈 등록 VS 자동 빈 등록
    수동 빈이 우선권을 갖는다.

수동이 우선권을 갖는 것이 좋다. 하지만 현실적으로 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는, 여러 설정들이 꼬여서 만들어진다.

profile
개발자를 향해 가는 중입니다~! 항상 겸손

0개의 댓글