섹션 6. 컴포넌트 스캔

Zion Yu·2021년 3월 31일

스프링 핵심 원리 - 기본편

목록 보기

7/10

본 시리즈는 우아한형제들 개발 팀장이신 김영한님의 스프링 핵심 원리 - 기본편 강의를 들으며 개인적으로 정리한 내용을 담고 있습니다. 제가 들은 강의는 인프런에 등록되어 있습니다. 모든 다이어그램을 포함한 사진의 출처는 위 강의의 강의록임을 밝힙니다. 개인적으로 정리한 내용이기 때문에 글 내용에 오류가 있을 수 있으며 이에 대한 피드백은 댓글로 부탁드립니다.

이번 섹션에서 다룰 내용

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

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

지금까지 스프링 빈을 등록할 때는 자바 코드(@Bean)나 XML(<bean>)을 이용해서 스프링 빈을 직접 등록했다.
그런데 등록할 빈이 많아지면 이게 상당히 귀찮은 일이 된다. 실수할 여지도 많다.
그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
더불어 의존관계를 자동으로 주입해주는 @Autowired도 지원한다.

코드로 실습해보자. 기존의 AppConfig는 냅둔 채로 같은 패키지에 새로운 AutoAppConfig를 만든다.

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

ComponentScan을 써주면 컴포넌트 스캔을 사용할 수 있다.
AppConfig와는 다르게 @Bean으로 등록된 클래스가 없다!

참고: 컴포넌트 스캔을 사용하면 @Configuration이 붙은 클래스도 자동으로 스캔된다. 그러면 기존에 작성했던 설정 정보에 따라 스프링 빈에 모두 등록되기 때문에 excludeFilters를 이용해 @Configuration을이 붙은 클래스는 컴포넌트 스캔에서 제외하도록 했다. 원래 실무에서는 이렇게 할 일이 별로 없는데 기존 예제 코드를 유지하기 위해서 이렇게 하는 것이다.

컴포넌트 스캔은 @Component가 붙은 클래스를 자동으로 스캔하여 스프링 빈으로 등록해준다! 따라서 우리가 할 일은 스프링 빈으로 등록하고 싶은 클래스에 @Component를 붙이는 것이다.

MemoryMemberRepository, RateDiscountPolicy 클래스 위에 @Component를 붙여준다.

MemberServiceImpl, OrderServiceImpl은 신경써줘야 할 게 하나 더 있는데,

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;
    
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    ...
}

컴포넌트 스캔에 의해 자동으로 스프링 빈으로 등록하게 되므로 의존관계 주입을 따로 설정할 수가 없다!
그래서 @Autowired를 이용한다. @Autowired를 생성자 위에 달면 스프링 컨테이너가 의존관계를 자동으로 주입해준다.

컴포넌트 스캔에 의해 스프링 빈이 잘 등록되는지, 의존관계 자동 주입이 잘 작동하는지 테스트해보자.

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

AnnotationConfigApplicationContext는 기존과 동일하게 이용하지만 설정 정보로 AutoAppConfig를 사용한다.
컴포넌트 스캔에 의해 스프링 빈이 잘 등록된 것을 확인할 수 있다.

정리

1. @ComponentScan

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
이 때 스프링 빈의 default 이름은 클래스명을 사용하되, 맨 앞글자만 소문자로 바꾼다.
- 예시: MemberServiceImpl 클래스 → memberServiceImpl
- 스프링 빈의 이름을 직접 지정해줄 수도 있다. @Component(원하는 이름)

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

생성자에 @Autowired를 달아주면 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입해준다.
이 때 스프링 컨테이너는 타입을 기준으로 스프링 빈을 찾아서 주입한다.
- getBean(MemberRepository.class)와 비슷하다.
생성자에 parameter가 많더라도 다 찾아서 자동으로 주입해준다.

탐색 위치와 기본 스캔 대상

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

컴포넌트 스캔을 할 때 모든 클래스를 다 뒤지면 시간이 너무 오래 걸린다. 그리고 탐색하고 싶지 않은 클래스가 있을 수도 있다. 그래서 탐색할 위치를 지정할 수 있다.

basePakages: 시작 패키지를 지정할 수 있다.

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

이 코드는 hello.core.member 패키지부터 탐색을 시작한다. hello.core 하위의 member를 제외한 다른 패키지는 탐색하지 않는다.
basePackages = {"hello.core", "hello.service"}처럼 여러 패키지를 지정할 수도 있다.
basePackageClasses: 지정한 클래스가 속한 패키지를 시작 위치로 정한다.
그럼 아무것도 지정하지 않으면?
- @ComponentScan이 붙어있는 클래스가 속한 패키지가 탐색 시작 위치가 된다.

김영한님이 권장하는 방법

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

예를 들어서 프로젝트가 다음과 같은 구조라면

com.hello

com.hello.service

com.hello.repository

com.hello에 AppConfig같은 메인 설정 정보를 두고 @CompoenntScan 어노테이션을 붙이고 basePackage 지정은 생략한다.

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 루트 위치에 두는 게 좋다고 생각한다.

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (이 설정 안에 @ComponentScan이 들어있다.)

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component만 스캔하는 것이 아니라 다음과 같은 것들도 스캔한다.

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

위 모든 애노테이션의 소스코드를 보면 결국 @Component를 포함한다.

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

컴포넌트 스캔의 용도 뿐만 아니라 애노테이션에 따라 스프링은 부가 기능을 수행한다.

@Controller: 스프링 MVC 컨트롤러로 인식
@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
- DB가 교체되더라도 각기 다른 예외가 터지지 않도록 스프링 예외로 변환하여 올려보내준다.
@Configuration: 스프링 설정 정보로 인식, 스프링 빈이 싱글톤을 유지하도록 추가 처리
@Service: 특별한 처리를 하지 않는다. 그냥 써놓으면 개발자들이 비즈니스 계층을 인지하는 데 도움이 된다.

참고: useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 참고로만 알아두자.

필터

includeFilter: 컴포넌트 스캔 대상을 추가로 지정한다.

excludeFilter: 컴포넌트 스캔에서 제외할 대상을 지정한다.

public class ComponentFilterAppConfigTest {
    @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 {
    }
}

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

FilterType 옵션

FilterType은 다섯 가지 옵션이 있다.

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

참고: @Component로 충분하기 때문에 includeFilters를 사용할 일은 거의 없다. excludeFilters는 가끔 사용한다.요즘 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 옵션을 변경하면서 사용하기 보다는 스프링 기본 설정에 최대한 맞춰서 사용하는 게 좋다.

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름이 중복되면 어떻게 될까? 다음 두 가지 상황을 상정해볼 수 있다.

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

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

컴포넌트 스캔에 의해 자동으로 스프링 빈을 등록하다가 이름 충돌이 발생하면 오류가 발생한다.
- ConflictingBeanDefinitionException 예외 발생

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

이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 한다.) 코드로 테스트해보자.

@Configuration
@ComponentScan(
        basePackages = "hello.core.member",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
    @Bean(name = "memoryMemberRepository")	// 자동 등록되는 빈인 MemoryMemberRepository와 이름이 겹친다.
    MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

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

테스트를 수행하면 다음과 같은 콘솔 출력을 볼 수 있다.

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing [Generic bean: class [hello.core.member.MemoryMemberRepository]; ...(중략)... defined in hello.core.AutoAppConfig]

수동 등록한 빈이 오버라이딩했다는 것을 알 수 있다.

물론 개발자가 의도적으로 이런 결과를 기대했다면 수동 등록 빈이 우선권을 가지는 것이 좋지만 현실적으로는 여러 설정이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다. 그리고 실수로 이런 상황이 초래되었을 경우 디버깅이 너무 힘들다.

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌할 시 오류가 발생하도록 기본값을 바꾸었다. 스프링 부트를 통해 컨테이너를 실행해보자. (CoreApplication의 main함수를 실행하면 된다.)

Description:
The bean 'memoryMemberRepository', defined in class path resource [hello/core/AutoAppConfig.class], could not be registered. A bean with that name has already been defined in file [대충 경로\hello\core\member\MemoryMemberRepository.class] and overriding is disabled.

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

스프링 프레임워크 자체는 overriding하도록 되어있지만 스프링 부트의 경우 기본적으로 오류가 나도록 설정되어 있다.
spring.main.allow-bean-definition-overriding=true를 application.properties에 등록해주면 원래 스프링 프레임워크의 동작대로 overriding을 할 수 있다.
이걸로 관련된 문제가 많으니까 스프링 부트에선 이렇게 기본 설정을 바꾼 것이다!