[스프링 핵심 원리 - 기본편] #6. 컴포넌트 스캔

[cyzlcyzl]

컴포넌트 스캔과 의존관계 자동 주입

• 지금까지 예제에서는 자바 코드의 @Bean 애노테이션이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열함
• 등록해야 할 빈이 많아질수록 일일이 등록하기도 번거럽고 누락되는 문제 발생
• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공함
• 또한 의존관게도 자동으로 주입하는 @Autowired라는 기능도 제공함

AutoAppConfig.java

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

• 컴포넌트 스캔을 사용하기 위해 @ComponentScan을 설정 정보에 붙여주면 됨
• 직접 등록한 @Bean이 하나도 없음

보통은 설정 정보를 컴포넌트 스캔 대상에서 제외하지 않지만, 해당 예제에서는 수동으로 등록한 AppConfig 파일이 존재하여 중복되기 때문에 excludeFilters를 이용해서 스캔 대상에서 제외했다.

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

MemoryMemberRepository, RateDiscountPolicy, MemberServiceImpl에 @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);
    }
}

• AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일함
• 설정 정보로 AutoAppConfig 클래스를 넘겨줌
• 로그를 확인해보면 @Component로 등록한 빈들이 잘 등록된 것을 확인할 수 있음

@ComponentScan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록함
• 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용
  • 빈 이름 기본 전략: MemberServiceImpl 클래스 -> memberServiceImpl
  • 빈 이름 직접 지정: @Component("memberService2")

@Autowired 의존 관계 주입

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

• 생성자에 파라미터가 많아도 전부 다 자동으로 주입함

탐색 위치와 기본 스캔 대상

탐색할 패키지의 시작 위치 지정

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

• 모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리기 때문에 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있음
• basePakages: 이 패키지를 포함해서 하위 패키지를 모두 탐색함
  • 여러 시작 위치를 지정할 수도 있음
• basePakageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정함
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됨

⭐️ 권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스 위치를 프로젝트 최상단에 두는 것
스프링 부트도 이 방법을 기본으로 제공함 (@SpringBootApplication)

컴포넌트 스캔 기본 대상

• @Component: 컴포넌트 스캔에서 사용
• @Controller: 스프링 MVC 컨트롤러에서 사용
• Service: 스프링 비즈니스 로직에서 사용 (별다른 기능은 없음)
• Repository: 스프링 데이터 접근 계층에서 사용
  • 스프링 데이터 접근 계층으로 인식하고 데이터 계층의 예외를 스프링 예외로 변환
• Configuration: 스프링 설정 정보에서 사용
  • 스프링 빈이 싱글톤을 유지하도록 추가 처리

필터

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

컴포넌트 스캔 대상에 추가할 애노테이션과 제외할 애노테이션으로 MyIncludeComponet와 MyExcludeComponent를 만들어주고 각각 BeanA는 추가, BeanB는 제외해준다.

설정 정보와 전체 테스트 코드

public class ComponentFilterAppConfingTest {

    @Test
    void filterScan() {
        AnnotationConfigApplicationContext 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 {

    }
}

• 스프링 빈에 포함한 BeanA는 등록, BeanB는 제외된 것을 확인할 수 있다.

FilterType 옵션

• ANNOTATION
• ASSIGNABLE_TYPE
• ASPECTJ
• REGEX
• CUSTOM

주로 기본값인 ANNOTATION을 사용한다. (따로 명시해주지 않아도 됨)

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

ConflictingBeanDefinitionException 예외 발생

수동 빈 등록 vs 자동 빈 등록

이 경우 수동 빈 등록이 우선권을 가진다 (수동 빈이 자동 빈을 오버라이딩함) - 에러는 발생하지 않음

개발자가 일부러 의도해서 이런 상황이 만들어지기 보다는 현실에서는 여러 설정들이 꼬여서 이런 경우가 발생하기 때문에 최근 스프링부트에서는 스동 빈 등록과 자동 빈 등록이 충돌나면 그냥 오류가 발생하도록 기본 값을 바꾸었다.

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

onsider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true