[Spring 핵심 원리 이해] 5. 컴포넌트 스캔

저번 시간 우리는 싱글톤 패턴이 무엇인지 그리고

스프링 컨테이너가 어떻게 싱글톤 패턴을 보장해줄 수 있는지에 대해 이야기 해보았다. 

스프링 컨테이너는 @Configuration이 붙은 클래스의 스프링 빈 메서드를 CGLIB 라이브러리를 통해서 같은 인스턴스 객체를 반화하도록 도와준다. 

 

이번 시간에는 스프링 빈을 등록할 때 설정 정보 없이 자동으로 스프링 빈을 등록할 수 있는 컴포넌트 스캔이라는 기능에 대해서 알아보도록 하겠다. 

또한 의존 관계를 자동으로 주입해주는 @Autowired 기능도 알아볼 것이다. 

 

1. 컴포넌트 스캔 시작 

 

먼저 AutoAppConfig.java 파일을 하나 만들어주자 

 

package hello.core_review;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

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

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

    }
}

 

ComponentScan은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록해준다. 

excludeFilter 를 설정한 이유는 ComponentScan이 @Configuration이 붙은 설정도 자동으로 등록하는데, 우리가 이미 작성해둔 AppConfig와 TestConfig와 같이 이미 작성해둔 설정 정보들이 등록되지 않도록 막아준 것이다. 

추가로 includeFilters를 사용하면 컴포넌트 스캔 대상을 추가로 지정할 수 있다 

 

includeFilters -> 컴포넌트 스캔 대상을 추가로 지정 

excludeFilter ->  컴포넌트 스캔에서 제외할 대상을 지정 

 

그럼 스프링 빈으로 등록해줄 클래스들(MemoryMemberRepository, RateDiscountPolicy, MemberServiceImpl, OrderServiceImpl)에 @Component 에노테이션을 붙여준다.

 

그리고 MemberServiceImpl, OrderServiceImpl에는 @Autowired 에노테이션도 붙여준다. 이는 의존관계를 주입해주기 위한 것인데, 원래는 AppConfig파일에서 직접 설정 정보와 의존관계 주입을 해주었지만 이제는 Autowire 에노테이션을 통해 이를 주입하는 것이다. 

 

생성자 위에 붙여주면 된다. 

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

 

Test를 진행해보면 

 

package hello.core_review.scan;

import hello.core_review.AutoAppConfig;
import hello.core_review.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class AutoAppConfigTest {

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

 

 

AutoAppConfig를 통해서 성공적으로 bean을 불러올 수 있음을 알 수 있다. 

 

컴포넌트 스캔을 사용하면 @Component 스캔이 붙은 모든 클래스가 스프링 빈으로 등록된다. 

 

출처 - 김영한 스프링 강의

이때 빈의 이름은 클래스의 이름의 첫 글자를 소문자로 한 것이다. 

만약 빈 이름을 직접 지정하고 싶다면 @Component("memberService2") 이런식으로 애노테이션 옆에 직접 추가하면 된다. 

 

@Autowired를 사용한 의존 관계 주입은 생성자에 @Autowired 가 지정되어 있다면, 스프링 컨테이너가 해당 스프링 빈을 찾아서 자동으로 주입해준다. 

이때 기본적인 조회 전력은 해당 생성자와 같은 타입의 빈을 찾아서 주입하는 것이다. 

이는 getBean() 메서드와 동일하다고 이해하면 된다. 

출처 - 김영한 스프링 강의

여기서 보면 MemberServiceImpl 생성자는 MemberRepositoty 타입을 갖는데, 이는 스프링 빈에 등록된 빈 중 memoryMemberRepository와 같은 타입이라고 볼 수 있다. 따라서 memoryMemberRepository가 의존관계 자동 주입이 되는 것이다. 

 

 

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

컴포넌트 스캔은 필요한 파일을 찾는데 모든 자바 클래스를 다 컴포넌트 스캔을 실시한다. 그렇기 때문에 탐색할 위치를 설정해주지 않으면 시간이 오래걸린다. 

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

이렇게 basePackages 를 지정해 탐색할 패키지의 시작 위치를 지정할 수 있다. 이 패키지를 포함해 하위패키지까지 모두 탐색한다. 

만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 패키지가 시작 위치가 된다.

 

그래서 설정 정보 클래스의 위치를 프로젝트 최상단에 두면 자연스럽게 프로젝트의 모든 패키지를 스캔하게 된다. 이 방법을 권장한다.

또한 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 싲가 루트 위치에 두는 것이 좋다!

 

컴포넌트 기본 스캔 대상 

컴포넌트는 @Configuration 이외에도 

@Component 

@Controller - 스프링 MVC 컨트롤러로 인식

@Service - 핵심 비즈니스 로직이 여기에 있다는 것을 암시해줌 

@Repository - 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해줌 

@Configuration - 스프링 설정 정보를 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 도와줌 

의 내용도 추가로 스캔 대상으로 포함한다. 

사실 해당 클래스의 소스 코드를 보면 모두 @Component 를 포함하고 있다.

 

참고로 애토네이션에는 상속 관계라는 것이 존재하지 않는다. 

 

 

FilterType 옵션 

FilterType은 5가지 옵션이 있다. 

• ANNOTAION : 기본값, 애노테이션을 인식해서 동작한다 
• ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다
• ASPECTJ : AspectJ  패턴 사용 
• REGEX : 정규 표현식 
• CUSTOM : TypeFilter라는 인터페이스를 구현해서 처리 

 

컴포넌트 중복 등록과 충돌 

그런데 컴포넌트 스캔을 통해 빈을 등록할 때 같은 빈 이름을 등록하게 되면 어떻게 될까? 

 

두 가지 상황이 있다 

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

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

 

자동 빈 등록 끼리 충돌이 난 경우에는

ConflictingBeanDefinitionException 에러가 발생한다. 

 

수동 빈 등록과 자동 빈 등록이 충돌한 경우에는 수동 빈 등록이 더 우선권을 갖는다. 수동 빈이 자동 빈을 오버라이딩 해버리기 때문이다. 

수동 등록 빈 등록시 

 

 Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

 

이런 로그가 남는다. 

 

하지만 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸고 있다. 개발자의 의도에 알맞게 동작하지 않는 경우를 방지하기 위해서이다.