[스프링 핵심 원리] - 컴포넌트 스캔

peeerr·2023년 1월 31일
Spring
0

Spring

목록 보기
5/10
post-thumbnail

이 글은 김영한님의 스프링 핵심 원리 - 기본편 강의를 수강하고 정리한 내용입니다.
강의 보러가기


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

  • 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

  • 예제에서는 빈 등록이 얼마 안됐지만, 실무에서는 등록해야할 스프링 빈이 수십, 수백개가 된다.

    • 일일이 다 등록하기도 귀찮고, 설정 정보도 커진다.

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

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


1) 컴포넌트 스캔이란?

코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자.

먼저 기존 AppConfig.java는 냅두고 새로운 AutoAppConfig.java를 만들어보자.

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

}

  • @ComponentScan을 사용하면 @Component가 붙은 클래스를 찾아서 자동으로 스프링 빈으로 등록해준다.

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

    • @Configuration이 붙은 클래스 빼고 스캔을 한다.

    • @Configuration안에 @Component가 붙어 있기 때문에 컴포넌트 스캔 대상이 된다.

    • AppConfig는 빈을 수동으로 등록을 이미 했기 때문에 충돌이 날 수 있으므로 위 코드를 적용해 제외시켜 주어야 한다.

보통 설정 정보를 제외시키지 않지만, 여기선 기존 예제 코드를 남겨두기 위해서 사용했다.


이제 @Component를 붙여주자

@Component
public class MemoryMemberRepository implements MemberRepository

위와 같은 형태로 MemoryMemberRepository , RateDiscountPolicy , MemberServiceImpl , OrderServiceImpl 클래스에 모두 붙여주었다.


2) 의존관계 자동 주입

기존 AppConfig 코드를 살짝 보면

@Bean
public MemberService memberService() {
    System.out.println("call AppConfig.memberService");
    return new MemberServiceImpl(memberRepository());
}
  • memberService는 memberRepository 의존관계를 주입한다는 명시가 있었다.

근데 지금은 이런 설정 정보 자체가 없는데 어떻게 의존관계를 주입할까?


바로 @Autowired를 사용하면 된다.

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    
	...
  • @Autowired를 생성자에 붙여주면 MemberRepository 타입에 맞는 것을 찾아와서 자동으로 의존관계 주입을 해준다.
    • 마치 ac.getBean(MemberRepository.class) 의 동작과 비슷하다.
    • @Autowired에 관한 자세한 내용은 뒤에서 자세히 다룬다.

이제 테스트해보자

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

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

  • AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.

  • AutoAppConfig.class를 설정 정보로 넘겨준다.


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

이제 각각의 동작 원리를 알아보자

1) @ComponentScan

principle

  • @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.

  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되, 맨 앞글자만 소문자를 사용한다.

    • 빈 이름 기본 전략 : MemberServiceImpl 클래스 -> memberServiceImpl
    • 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

2) @Autowired 의존관계 자동 주입

autowired

  • 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

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

    • getBean(MemberRepository.class) 코드와 동일하다고 이해하면 된다.

    • 더 자세한 내용은 뒤에서 설명한다.

전에 살펴보았듯이 MemoryMemberRepository는 MemberRepository의 자식 타입이기 때문에 조회가 되는 것이다.

  • 같은 타입이 여러 개 있으면 충돌 -> 에러 발생

add

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

📌 2. 탐색 위치와 기본 스캔 대상

1) 탐색할 패키지 시작 위치 지정

컴포넌트 스캔은 어디서부터 이루어질까?

  • 컴포넌트 스캔은 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정해 스캔 시간을 효율적으로 줄일 수 있다.

@ComponentScan(
	basePackages = "hello.core",
    basePackageClasses = AutoAppConfig.class
}

  • basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

    • basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

  • basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

  • ❗중요❗ 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.**


권장되는 방식

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

예를 들어 다음과 같은 구조가 있을 때

  • com.hello
  • com.hello.service
  • com.hello.repository

프로젝트 최상단은 com.hello이다.
여기에 AppConfig 같은 메인 설정 정보를 두며, @ComponentScan 을 붙이고 basePackages 지정은 생략하는 방식이다.

  • 이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.

  • 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

  • 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

@SpringBootApplication 안에 바로 @ComponentScan 이 들어있다!
-> 프로젝트 시작 루트에 위치하기 때문에 사실 @ComponentScan을 쓸 필요가 없다.


2) 컴포넌트 스캔 기본 대상

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

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

-> 해당 어노테이션들을 직접 들어가 코드를 보면 @Component이 붙어있기 때문이다.

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


컴포넌트 스캔의 용도뿐만 아니라 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.

  • @Controller : 스프링 MVC 컨트롤러로 인식한다.

  • @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
    -> 예를 들어 Repository 계층에서 A라는 DB를 사용하다가 갑자기 다른 DB를 바꿨다고 가정해보자.
    그럼 다른 DB에 맞는 예외가 올라와버려서 서비스 계층 같은 코드에 영향을 줄 수 있다.
    여기선 대충 그걸 막아주는구나 정도로만 이해하고 넘어가자.

  • @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

  • @Service : 사실 @Service 는 특별한 처리를 하지 않는다.
    대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.


📌 3. 필터

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

예제로 바로 확인해보자

  • 우선 컴포넌트 스캔 대상에 추가할 어노테이션을 만든다.
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}
  • 컴포넌트 스캔 대상에서 제외할 어노테이션을 만든다.
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

  • 이제 만든 어노테이션을 가지고 컴포넌트에 추가할 클래스, 제외할 클래스를 만든다.
@MyIncludeComponent
public class BeanA {
}
@MyExcludeComponent
public class BeanB {
}

이제 테스트를 해보자

import static org.springframework.context.annotation.ComponentScan.*;

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 {
    }

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

@Component 면 충분하기 때문에, includeFilters, excludeFilters를 사용할 일은 거의 없다.


📌 4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?

다음 두가지 상황이 있다.

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

1) 자동 빈 등록 vs 자동 빈 등록

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

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

  • 수동 빈이 우선권을 가진다.
    (수동 빈이 자동 빈을 오버라이드 해버린다.)
profile
peeerr
개발 공부
이전 포스트

[스프링 핵심 원리] - 싱글톤 컨테이너

다음 포스트

[스프링 핵심 원리] - 의존관계 자동 주입

0개의 댓글