[Spring] 컴포넌트 스캔

안녕하세요 이번 포스팅은 컴포넌트 스캔에 대해서 알아보겠습니다!!!

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

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

예제에서는 몇 개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백 개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생합니다.

역시 개발자는 반복을 싫어합니다. (무엇보다 귀찮다 ㅠㅠ) 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공합니다.

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

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

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

 

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을 설정 정보여 붙여주면 됩니다.

기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없습니다!!!!!!!!!!!!!!!! 너무 좋아요 ㅎㅎ^^

 

참고: 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버립니다. 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했습니다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했습니다.

 

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록하기 때문에 클래스에다가 @Component를 써주면 됩니다.

 

참고: @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문입니다.

 

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여줍니다.

 

 

 

이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했습니다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 합니다.

@Autowired는 의존관계를 자동으로 주입해줍니다. 자세한 룰은 조금 뒤에 설명하겠습니다.

 

@Autowired를 사용하면 생성자에서 여러 의존관계도 한 번에 주입받을 수 있습니다.

 

AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하고 설정 정보로 AutoAppConfig를 넘겨줍니다. 그리고 이 테스트를 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있습니다.

 

로그를 보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있습니다.

 

그럼 컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보겠습니다.

 

@ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록합니다. 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용합니다.

빈 이름을 만약 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 됩니다.

 

2. @의존관계 자동 주입

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

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

getBean(MemberRepository.class)와 동일하다고 이해하면 됩니다.

 

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

 

탐색 위치와 기본 스캔 대상

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

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래걸립니다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있습니다.

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

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

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

만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 됩니다.

 

권장하는 방법

설정 정보 크래스의 위치를 프로젝트 최상단에 두는것을 권장합니다. 최근 스프링 부트도 이 방법을 기본으로 제공합니다.

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

com.hello -> 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략합니다.

 

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

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

 

컴포넌트 스캔 기본 대상

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

 

@Component : 컴포넌트 스캔에서 사용

@Controller : 스프링 MVC 컨트롤러에서 사용

@Service : 스프링 비즈니스 로직에서 사용

@Repository : 스프링 데이터 접근 계층에서 사용

@Configuration : 스프링 설정 정보에서 사용

 

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

 

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

 

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

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

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

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

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

 

 

필터

includeFilters : 컴포넌트 스캔 대상을 추가로 지정합니다.

excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정합니다.

 

예제로 확인해 보겠습니다.

Annotation을 직접 만들어서 쓰기 위해서 위의 @Target, @Retention, @Documented 을 사용자 지정 어노테이션에 붙여줍니다.

 

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

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.context.annotation.ComponentScan.Filter;

public class ComponentFilterAppConfigTest {
     @Test
     void filterScan() {
         ApplicationContext ac = new
                AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
         BeanA beanA = ac.getBean("beanA", BeanA.class);

         assertThat(beanA).isNotNull();
         Assertions.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 {

     }
}

 

incldueFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록됩니다.

excludeFilters에 M yExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않습니다.

 

중복 등록과 충돌

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

다음 두가지 상황이 있습니다.

 

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

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

 

 

자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데 그 이름이 같은 경우 스프링은 오류를 발생시킵니다.

ConflictingBeanDefinitionException 예외가 발생합니다.

 

수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까요?

 

이 경우에는 수동 빈 등록이 우선권을 가집니다 (수동 빈이 자동 빈을 오버라이딩 해버립니다).

 

수동 빈 등록 시 남는 로그

 

물론 개발자가 의도적으로 이런 결과를 기대했다면 자동보다는 수동이 우선권을 가지는 것이 좋습니다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이라 합니다.

그러면 정말 잡기 어려운 버그가 발생하겠죠?

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌 나면 오류가 발생하도록 기본 값을 바꾸었습니다.

 

스프링 부트인 CoreApplication을 실행해보면 오류를 볼 수 있습니다.