(스프링 기본) 17 - 컴포넌트 스캔

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

의존관계도 자동으로 주입하는 @Autowired 기능도 제공한다.

 

컴포넌트 스캔은 스프링빈으로 자동으로 끌어올려 주는 것이다. 

이걸 하는게 @ComponentScan 어노테이션이다. 

 

@ComponentScan 어노테이션은 @Component 가 붙은 어노테이션을 자동으로 스프링 빈으로 등록해준다. 

 

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)

 

excludeFilters : 컴포넌트 스캔 중 뺄 것 고르기

여기서는 Configuration 을 제외시켜준다.

 

 

왜냐하면 다음과 같이 Configuration 에도 @Component 어노테이션이 붙어 있어서 빈으로 등록하게 되고,

이러면 지난 예제인 AppConfig 도 불러올 수 있기 때문이다. 

지금은 기존 예제 코드를 하고자 filter 처리 한 것이니 참고하자

 

 

이제 다음과 같이 빈으로 등록해야 할 class 로 가서 @Componet 어노테이션을 붙여주면 된다.

 

@Configuration
public class AppConfig {

    //@Bean memberService -> MemoryMemberRepository()
    //@Bean orderService -> MemoryMemberRepository()

    @Bean
    public MemberService memberService() {
        System.out.println("Call AppConfig.memberService");
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        System.out.println("Call AppConfig.memberRepository");
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        System.out.println("Call AppConfig.orderService");
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public DiscountPolicy discountPolicy() {
//        return new FixDiscountPolicy();
        return new RateDiscountPolicy();
    }


}

 

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)

public class AutoAppConfig {

}

 

이전 AppConfig 와 다르게 AutoConfig 는 의존관계를 주입시키지 않는다.

따라서 아래 사진과 같이 의존관계 주입이 필요한 생성자에 @Autowired 를 붙여준다.

 

 

이렇게 되면 스프링이 MemberRepository 에 맞는 타입을 찾아서 의존관계를 주입시켜 준다. 

다음 주석과 같은 역할을 하는 것이다. 

 

이전에는 @Bean 으로 직접 설정 정보를 저장하고 의존관계도 명시했지만,

지금은 설정 정보 자체가 없기 때문에 의존관계 주입도 클래스 안에서 해결해야 한다.

@Autowired 가 의존관계를 자동으로 주입해주는 것이다.

 

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

        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

 

Test 를 해보면 컴포넌트 스캔이 잘 돼서 객체가 싱글톤으로 만들어지고,

생성자 주입 또한 잘 된 것을 로그로 확인이 가능하다. 

 

 

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

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

※ 직접 지정하고 싶다면 @Component("memberService") 등록 가능

 

 

- @Autowired 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 조회

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

- getBean(MemberRepository.class) 와 동일하다고 이해하면 편하다.

 

 

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

 

■ 탐색 위치와 기본 스캔 대상

@Configuration
@ComponentScan(
        basePackages = "hello.core.member",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)

public class AutoAppConfig {
}

 

basePackages 를 등록 하면 탐색할 패키지의 시작을 지정할 수 있다.

이렇게 되면 hello.core.member 에 있는 것만 탐색하게 된다. 

 

basePackageClasses = AutoAppConfig.class, 

 

내 class 에 해당하는 패키지 시작으로 탐색한다.

만약 지정하지 않으면 @ComponentScan 을 붙인 클래스의 패키지와 그 하위를 탐색한다.

 

★ 권장방법

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

최근 스프링 부트도 이 방법을 기본으로 제공함.

 

메인 설정 정보는 프로젝트 시작 루트에 위치하는 것을 권장하며,

스프링 부트 대표 시작인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

(이 설정안에 @ComponentScan 이 들어있다.)

 

■ 컴포넌트 스캔 기본 대상

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

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

- @Service : 스프링 비즈니스 로직에서 사용 + 핵심 비즈니스 로직이 있다를 개발자들 인지하게 해

- @Repository : 스프링 데이터 접근 계층에서 사용 +데이터 계층의 예외를 스프링 예외로 변환

ex)JPA, JDBC

- @Configuration : 스프링 설정 정보에서 사용 + 스프링 빈이 싱글톤 유지하도록 추가 처

 

※ 애노테이션에는 상속관계가 없다.

따라서 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바가 아니라 스프링이 지원하는 기능이다.

 

※ useDefaultFilters (기본: 켜짐) : 끄게 되면 기본 스캔 대상들이 제외된다. 중요한 이야기는 x -> 참고만 하자

 

■ 필터

1. includeFilters : 컴포넌트 스캔 대상 추가 지정

2. excludeFilters : 컴포넌트 스캔 대상 제외 지정

 

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 {

    }

}

 

type = FilterType.ANNOTATION 은 애노테이션과 관련된 필터를 만드는 것이다.

해당 코드에서 컴포넌트 추가 대상과 제외를 지정해주고,

각각 해당하는 클래스에 애노테이션을 붙여준다.

 

코드에 따라서 BeanA는 객체 등록 되지만, BeanB는 등록되지 않는다. 

NoSuchBeanDefinitionException 이 터지게 된다. 

 

※ 필터 타입 5가지 

1. ANNOTATION : 기본값(생략가능), 애노테이션 인식해서 동작

2. ASSIGNABLE_TYPE : 지정한 타입과 자식 타입 인식해서 동작

3. ASPECTJ : AspectJ 패턴 사용

4. REGEX : 정규 표현식

5. CUSTOM : TypeFilter 인테페이스 구현해서 처리

 

■ 중복 등록과 충돌

* 자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈 등록 시 ConflictingBeanDefinitionException 예외가 생긴다.

 

* 수동 빈 등록

public class AutoAppConfig {

    @Bean(name = "memoryMemberRepository")
    MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

 

수동으로 빈을 등록하면 수동으로 등록한 빈이 우선권을 가진다.

(수동 빈이 자동 빈을 오버라이딩 한다.)

 

이렇게 되면 잡기 어려운 버그가 생길 가능성이 높아서

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

 

그러나 웬만하면 수동 빈을 등록해서 사용하는 것을 지양해야 한다. (고치기 어려운 에러가 될 가능성 높음)

 

출처 : 김영한 스프링 핵심 원리 - 기본편

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

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