스프링 핵심 원리 Section 6. 컴포넌트 스캔

Bae YuSeon·2024년 5월 16일

spring스터디

목록 보기

13/15

김영한 강사님이 제공하시는 인프런 - "스프링 입문 - 스프링 핵심 원리 - 기본편" 강의를 듣고 정리한 내용입니다
강의 링크
김영한 - 스프링 핵심 원리 - 기본편 (유료강의)

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

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열
만약 등록해야 할 스프링 빈이 수십, 수백개가 되면?
설정 정보가 커지고, 누락하는 문제 등이 발생
→ 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공.
→ 의존관계도 자동으로 주입하는 @Autowired 기능도 제공.

기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig.java를 만들어 실습

1. AutoAppConfig.java - @ComponentScan

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

@ComponentScan을 설정 정보에 붙여 컴포넌트 스캔 사용
기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스 X

2. @Component, @Autowired 추기
컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록
→ 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여줌

MemoryMemberRepository @Component 추가

@Component
		public class MemoryMemberRepository implements MemberRepository{
		...
		}

RateDiscountPolicy @Component 추가

@Component
		public class RateDiscountPolicy implements DiscountPolicy{
		...
		}

MemberServiceImpl @Component, @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository;

    // 의존관계 자동 주입(DI)
    @Autowired  
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    ...
}

@Autowired 의존관계를 자동으로 주입

OrderServiceImpl @Component, @Autowired 추가

@Component
public class OrderServiceImpl implements OrderService{
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    // 의존관계 자동 주입(DI)
    @Autowired   
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
    ...
}

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

3. AutoAppConfigTest.java

public class AutoAppConfigTest {

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

        // MemberService 조회
        MemberService memberService = ac.getBean(MemberService.class);
        // memberService 인스턴스가 MemberService 타입인지 검증
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

AnnotationConfigApplicationContext 사용하는 것은 기존과 동일
설정 정보로 AutoAppConfig 클래스를 넘겨줌
테스트를 실행하면

잘 작동하는 것을 확인

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

@ComponentScan은 @Component가 붙은 모든 클래스를 자동으로 스프링 빈으로 등록
@Configuration이 붙은 클래스도 스프링 빈으로 자동 등록 (@Configuration 내부에 @Component 있음)
스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용
- 이름 기본 전략: MemberServiceImpl 클래스 → memberServiceImpl
- 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여

생성자에 @Autowired 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
기본 조회 전략은 타입이 같은 빈을 찾아서 주입하는 것
- getBean(MemberRepository.class)와 동일
생성자에 파라미터가 많아도 다 찾아서 자동으로 주입

2강) 탐색 위치와 기본 스캔 대상

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

모든 자바 클래스를 컴포넌트 스캔하면 시간이 오래걸리므로 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정 가능
basePackages
- 탐색할 패키지의 시작 위치 지정(해당 패키지 + 하위 패키지)
- basePackages = {"hello.core", "hello.service"} 처럼 시작 위치 여러개로 지정 가능
```
package hello.core;

@Configuration
@ComponentScan	// 탐색 시작 위치 = hello.core
public class AutoAppConfig {
    basePackages = "hello.core"
}
```

basePackageClasses

지정한 클래스의 패키지를 탐색 시작 위치로 지정

package hello.core;

@Configuration
@ComponentScan	// 탐색 시작 위치 = hello.core(AutoAppConfig의 패키지)
public class AutoAppConfig {
    basePackageClasses = "AutoAppConfig.class"
}

시작 위치 지정하지 않는 경우
- @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치로 지정

탐색할 패키지의 시작 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장!

프로젝트 구조가 이와 같을 때,
프로젝트 최상단(시작 루트) = com.hello
com.hello에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 을 붙이고, basePackages 지정은 생략
⇒ com.hello를 포함한 하위 패키지는 모두 컴포넌트 스캔의 대상

컴포넌트 스캔 기본 대상

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

해당 클래스의 소스 코드를 보면 @Component 를 포함하고 있는 것을 알 수 있다.

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}

애노테이션의 컴포넌트 스캔 외 부가 기능

@Controller : 스프링 MVC 컨트롤러로 인식
@Repository : 스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환
@Configuration : 스프링 설정 정보로 인식, 스프링 빈이 싱글톤을 유지하도록 추가 처리
@Service : 특별한 처리 X, 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움
useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외

3강) 필터

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

src/test/hello.core/scan/filter 패키지에 파일 추가
1. 컴포넌트 스캔 대상에 추가할 애노테이션

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

컴포넌트 스캔 대상에서 제외할 애노테이션

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

컴포넌트 스캔 대상에 추가할 클래스
```
@MyIncludeComponent
public class BeanA {
}
```
- @MyIncludeComponent 적용
컴포넌트 스캔 대상에서 제외할 클래스
```
@MyExcludeComponent
public class BeanB {
}
```
- @MyExcludeComponent 적용
설정 정보와 전체 테스트 코드

    public class ComponentFilterAppConfigTest {

      @Test
      void filterScan() {
          ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

          // beanA 빈 조회 성공해야 함
          BeanA beanA = ac.getBean("beanA", BeanA.class);
          assertThat(beanA).isNotNull();

          // beanB 빈 조회 실패해야 함
          //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 {
        }
    }

includeFilters에 MyIncludeComponent 애노테이션을 추가 → BeanA가 스프링 빈에 등록 O
excludeFilters에 MyExcludeComponent 애노테이션을 추가 → BeanB는 스프링 빈에 등록 X

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

4강) 중복 등록과 충돌

1. 자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류 발생
→ ConflictingBeanDefinitionException 예외 발생

실습
MemberServiceImpl & OrderServiceImpl의 빈이름을 Service로 수정

@Component("service")
public class MemberServiceImpl implements MemberService{
...
}

@Component("service")
public class OrderServiceImpl implements OrderService{
...
}

2. 수동 빈 등록 vs 자동 빈 등록

수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌하는 경우
⇒ 수동 빈 등록이 우선권을 가짐. (수동 빈이 자동 빈을 오버라이딩 )

실습
AutoAppConfig에 빈 이름이 memoryMemberRepository인 빈을 수동으로 등록

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

    // 빈 이름이 memoryMemberRepository 인 수동 빈 등록
    @Bean(name = "memoryMemberRepository")
    MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}