컴포넌트 스캔

• 컴포넌트 스캔과 의존관계 자동 주입 시작하기

지금까지는 @Bean으로 직접 빈을 등록해줬지만 등록할 빈이 많아지면 이 방법에는 한계가 있다..

스프링에는 자동으로 빈을 등록하는 컴포넌트 스캔 기능이 있다!

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

AutoAppConfig클래스를 만들어서 자동으로 빈 등록하는 걸 해보자

 

컴포넌트 스캔을 사용하면 `@Configuration` 이 붙은 설정 정보도 자동으로 등록되기 때문에,
AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서
`excludeFilters` 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다.

 

컴포넌트 스캔의 대상이 될 클래스에 @Component 어노테이션을 붙이고 구현체의 생성자에 @Autowired를 붙여서 의존관계를 자동 주입시킨다

 

public class AutoAppConfigTest {

    @Test
    void basicScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

`@ComponentScan` 은 `@Component` 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다

 

생성자에 `@Autowired` 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
`getBean(MemberRepository.class)` 와 동일하다고 이해하면 된다

 

요약 - ComponetScan은 Component가 걸 자동으로 빈에 등록한다, 의존관계도 따로 설정하지 않고 @AutoWirde 어노테이션을 생성자에 붙이면 자동으로 의존성 주입을 해준다

 

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

@ComponentScan(
        //탐색할 패키지 시작 위치점
        basePackages =  "hello.core.member",
        //Configuration을 자동으로 가져오면 Appconfig등 다른 설정 어노테이션 붙은 클래스도 스프링에 등록해버린다
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes =
        Configuration.class)
)

 

basePackages` : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
`basePackages = {"hello.core", "hello.service"} ` 이렇게 여러 시작 위치를 지정할 수도있다.
`basePackageClasses` : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
만약 지정하지 않으면 `@ComponentScan` 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법
개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것
이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

com.hello 프로젝트 시작 루트에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이
션을 붙이고, `basePackages` 지정은 생략

 

컴포넌트 스캔 

컴포넌트 스캔은 `@Component` 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다, 뒤에 어노테이션도 자동으로 스캔된다
`@Component` : 컴포넌트 스캔에서 사용
`@Controller` : 스프링 MVC 컨트롤러에서 사용
`@Service` : 스프링 비즈니스 로직에서 사용
`@Repository` : 스프링 데이터 접근 계층에서 사용
`@Configuration` : 스프링 설정 정보에서 사용

 

*애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는
것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

 

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

 

•필터

`includeFilters` : 컴포넌트 스캔 대상을 추가로 지정한다.
`excludeFilters` : 컴포넌트 스캔에서 제외할 대상을 지정한다.

 

컴포넌트 스캔의 대상을 어노테이션을 추가해서 어노테이션이 붙은 대상을 스캔하게 해준다

//이 어노테이션이 붙은 것은 컴포넌트 스캔에 추가됨, 사용자가 만든 어노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

 

컴포넌트 스캔 대상에 추가하는 어노테이션

package hello.core.Scan.filter;
import java.lang.annotation.*;

//이 어노테이션이 붙은 것은 컴포넌트 스캔에 추가됨, 사용자가 만든 어노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

컴포넌트 스캔 대상에 제외하는 어노테이션

package hello.core.Scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {

}

이렇게 만들어둔 어노테이션을 붙인 클래스도 생성해준다

@MyIncludeComponent
public class BeanA {
}

@MyExcludeComponent
public class BeanB {
}

어노테이션으로 필터 기능이 제대로 동작하는지 ComponetFilterAppConfigTest에서 테스트

public class ComponetFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();
        assertThrows(
                //beanB는 스캔에서 제외했기에 나오지 않음
                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{
    }
}

include에 넣어준 어노테이션을 붙인 BeanA 클래스는 잘 조회되고

exclude에 넣어준 어노테이션을 붙인 BeanB 클래스는 찾을수 없어서 assertThrow로 테스트하면 통과된다.

includeFilters` 에 `MyIncludeComponent` 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
`excludeFilters` 에 `MyExcludeComponent` 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는
다.

 

•FilterType 옵션

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 자동 빈 등록
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
`ConflictingBeanDefinitionException` 예외 발생

 

수동으로 @Bean(name = 중복된 빈 이름) 형태로 등록한게 자동으로 등록한 빈과 겹치게 되면 수동으로 입력한 빈이

자동으로 입력한 빈을 오버라이딩해버린다

*이런식으로 오버라이딩 되서 실행이 되버리면 정말 버그를 잡기 어려워지기에 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다