목차
컴포넌트 스캔과 의존관계 자동 주입 시작하기
컴포넌트 스캔
지금까지 학습을 진행하며 작성한 코드들에서는 스프링 빈을 등록하기 위해 @Bean 어노테이션을 붙혀주거나 <bean>이라는 XML 태그를 붙혀서 직접 설정 정보에 스프링 빈을 나열했다. 테스트는 성공적으로 되었으며, 문제도 없었다. 그런데 여기서 내가 만들어야 할 스프링 빈이 한두개가 아닌 수백개가 된다면 어떨까? 하나하나 @Bean 어노테이션을 붙혀주고 의존관계 주입을 직접 해주는게 맞을까?
스프링에서는 이런 문제를 해결하기위해 컴포넌트 스캔이라는 기능을 제공한다.
@ComponentScan이라는 어노테이션을 통해서 해당 기능을 사용하는데, 실제로 코드를 작성하며 살펴보자.
AutoAppConfig
해당 @ComponentScan은 @Component 어노테이션이 붙은 클래스를 스캔해 스프링 빈으로 등록한다.
그렇기에 그 다음으로 내가 등록해야 하는 스프링 빈 클래스들에 @Component를 붙혀주자.
MemberServiceImpl
OrderServiceImpl
RateDiscountPolicy
MemoryMemberRepository
코드를 잘 보면 @Autowired라는 어노테이션도 추가된 것을 확인할 수 있다. 이는 의존관계주입을 명시적으로 하질 않고있기 때문에 의존관계주입도 클래스내부에서 해결해야 하는데 이 @Autowired 어노테이션이 의존관계 주입을 자동으로 해주기 때문에 작성해준 것이며 차후 이 어노테이션에 대해서도 알아본다.
테스트 케이스 작성 및 확인
package scan;
import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.assertThat;
public class AutoAppConfigTest {
@Test
void basicScan() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
MemberService memberService = ac.getBean(MemberService.class);
assertThat(memberService).isInstanceOf(MemberService.class);
}
}
Java
복사
로그를 잘 살펴보면 컴포넌트 스캔이 컴포넌트 어노테이션이 붙은 스프링 빈을 잘 캐치해서 등록한 것을 확인할 수 있다.
@ComponentScan
이 어노테이션은 @Component 어노테이션이 붙은 모든 클래스를 스프링 빈으로 등록하는데, 이때 스프링 빈의 이름을 설정하는 기본 설정은 클래스명에서 앞글자를 소문자로 바꿔 사용하거나 직접 이름을 부여해서 등록할 수 있다.
•
만약 MemberServiceImpl이라는 클래스라면 memberSerivceImpl이라는 빈 이름으로 등록된다.
•
만약 해당 클래스에 @Component("service")처럼 속성이 설정되면 service라는 빈 이름으로 등록된다.
@Autowired
생성자(혹은 필드)에@Autowired 어노테이션을 지정하면 스프링 컨테이너에서는 자동으로 해당 스프링 빈을 찾아 등록해준다. 우리가 자주 사용한 ac.getBean(beanName, beanClazz)와 같다.
이 어노테이션을 사용하기에 이전에 설정정보에서 직접 필요한 의존관계 주입을 수동으로 해주던것을 자동으로 할 수 있게 된다.
탐색 위치와 기본 스캔 대상
@ComponentScan을 통해 @Component 어노테이션이 부여된 클래스를 탐색하여 등록할 수 있다고 했다.
그럼 어디서부터 탐색할지에 대해 알아야하는데, 기본 관례와 사용자 정의방법에 대해 모두 알아보자.
1.
속성(basePackages)을 이용한 탐색위치 지정
@ComponentScan(basePackages = "hello.core")
패키지 경로를 지정해 탐색할 패키지의 시작 경로를 지정할 수 있는데, 이 패키지를 포함해 하위 패키지를 모두 탐색한다. 더하여 {"hello.core", :"hello.servcie"} 이런식으로 시작위치를 여러군데 둘 수도 있다.
•
여기서 basePackageClasses 속성을 사용하면 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
2.
기본 관례
속성을 따로 지정하지 않으면 해당 @ComponentScan 어노테이션이 존재하는 현재 패키지가 시작 위치가 된다.
SpringBooApplication 어노테이션에는 ComponentScan 어노테이션이 부여되어있으며 보통 해당 어노테이션이 붙어있는 클래스는 프로젝트 루트 경로에 위치해있고, 그렇게 유지되는게 좋다.
컴포넌트 스캔 기본 대상
실무, 혹은 토이프로젝트를 진행하며 스프링 프로젝트로 진행하다보면 @Component 어노테이션을 붙히지 않았는데도 스프링빈에 제대로 등록되서 사용이 가능한경우가 있다. 이런 경우가 특정 어노테이션들은 기본적으로 같이 등록되기 때문인데, 사실 해당 기본 대상 어노테이션도 트레이싱해서 살펴보면 @Component 어노테이션이 부여되어 있다.
•
@Component : 컴포넌트 스캔 대상
•
@Controller: 스프링 MVC 컨트롤러에서 사용
⇒ 해당 어노테이션을 붙히면 스프링 MVC 컨트롤러로 인식된다.
•
@Serivce: 스프링 비즈니스 로직에서 사용
⇒ 특별한 처리는 하지 않고 그저 이 어노테이션이 부여된 클래스가 핵심 비즈니스 로직이 들어있다고 인식하도록 해주는 역할
•
@Repository: 스프링 데이터 접근 계층에서 사용
⇒ 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
•
@Configuration: 스프링 설정 정보에서 사용
⇒ 스프링 설정 정보로 인식하고 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
위 컴포넌트 스캔 기본 대상 어노테이션들은 스캔용도 뿐 아니라 각각의 목적에 맞는 부가 기능을 수행한다.
필터
필터에 대한 학습은 이제 하지만, 사실 우리는 이미 필터를 사용해봤다.
@Configuration
@ComponentScan(excludeFilters = @Filter(type = FilterType.ANNOTATION,
classes = Configuration.class))
public class AutoAppConfig {
}
Java
복사
AutoAppConfig 클래스를 작성하며 어노테이션에서 기존에 작성한 AppConfig를 탐색하지 않기위해 속성을 지정한적이 있는데, 이를 필터라 한다. 이처럼 컴포넌트 스캔 대상을 추가 및 제외할 수 있다.
•
includeFilters: 컴포넌트 스캔 대상을 추가로 지정한다.
•
excludeFilters: 컴포넌트 스캔에서 제외할 대상을 지정한다.
그럼 간단한 사용자정의 어노테이션을 직접 만들어서 해당 필터에 등록해서 컴포넌트 스캔 대상에서 추가, 제외를 해보자.
MyIncludeComponent
MyExcludeComponent
BeanA
BeanB
ComponentFilterAppConfigTest
테스트를 통해 우리는 includeFilters에 등록된 추가된 어노테이션(MyIncludeComponent)이 부여된 BeanA는 스프링 빈으로 등록되었고, excludeFilters에 등록된 추가된 어노테이션(MyExcludeComponent)이 부여된 BeanB는 스프링빈으로 등록되지 않은 것을 확인할 수 있다.
FilterType 옵션
include혹은 excludeFilters에서 추가할 필터의 타입을 지정해줄 수 있는데, 5가지 옵션을 제공한다.
•
ANNOTATION: 기본값, 애노테이션을 인색해서 동작한다.
•
ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
•
ASPECTJ: AspectJ 패턴 사용
•
REGEX: 정규 표현식 사용
•
CUSTOM: TypeFilter 인터페이스를 구현해서 처리한다.
중복 등록과 충돌
예전 @Bean 애노테이션을 등록할때와 마찮가지로 컴포넌트 스캔을 할 때 역시 빈 이름이 중복되는 상황이 생길 수 있다. 빈등록시 빈 이름은 관례에 따른 자동 빈 등록과, 수동으로 이름을 지정한 수동 빈 등록이 있을텐데, 모든 충돌상황에서 현재는 기본적으로 오류를 발생시킨다.
•
ConflictingBeanDefinitionException
이전에는 자동 빈등록과 수동 빈등록으로 빈 이름 충돌이 생길경우 수동 빈이 우선권을 가져서 수동빈이 자동빈을 오버라이딩 했으나 대부분 의도하지 않은 상태에서 오버라이딩이 되는 경우가 많기에 프로젝트에서 에러는 아니지만 의도한대로 동작하지않는 버그가 발생한다. 그렇기에 최근에는 기본적으로 오류를 발생하도록 변경되었다.
Application.properties에서 이 옵션을 꺼서 오버라이딩을 허용하면 에러가 발생하지 않지만, 끄지 않고 에러를 발생시키도록하는게 좋다.
