본 게시글은 인프런 김영한 선생님 강의 스프링 핵심 원리를 완강하고 배운 것을 남기고자 적은 포스팅입니다.
강의 링크는 아래와 같습니다.
(강의 예제 코드는 웬만하면 적지 말라고 강의 공지사항에 적혀 있어서 이해 가능하게 코드를 짧게 남기겠습니다)
스프링 핵심 원리 - 기본편 - 인프런 | 강의
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., 스프링 핵심 원리를 이해하고, 성장하는 개발자가 되어보세요! 📢 수강 전
www.inflearn.com
지금까지 스프링 빈을 등록할 때는 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다. 실무에서는 스프링 빈이 어마어마하게 많으며 등록하기 귀찮고, 설정 정보도 커지고, 누락할 위험성이 존재한다.
그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
또 의존 관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.
코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자.
먼저 컴포넌트 스캔을 진행할 설정 클래스를 만들어보자.
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 {
}
애노테이션에 붙은 설정 값들에 대한 선생님의 설명
' 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다. '
컴포넌트 스캔을 시작하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.
이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여보자.
참고: @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.
@Component
public class MemoryMemberRepository implements MemberRepository {}
@Component
public class RateDiscountPolicy implements DiscountPolicy {}
@Component
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
@Autowired //Autowired 애노테이션은 의존관계를 자동으로 주입해준다.
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
}
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired //@Autowired를 사용하면 생성자에서 여러 의존관계를 한번에 주입 가능
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy
discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}
//이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는
//이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
이제 @ComponentScan을 사용한 설정 클래스를 AnnotationConfigApplicationContext에 넘겨보자. 그러면 정상적으로 잘 동작하는 것을 확인할 수 있다. 코드는 아래와 같다.
public class AutoAppConfigTest {
@Test
void basicScan() {
ApplicationContext ac = new
AnnotationConfigApplicationContext(AutoAppConfig.class);
MemberService memberService = ac.getBean(MemberService.class);
assertThat(memberService).isInstanceOf(MemberService.class);
}
}
그럼 이제 컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.
- @ComponentScan 은 @component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
- 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다. 예를 들면 MemberServiceImpl 클래스는 memberServiceImpl로 빈의 기본 이름을 정한다. 물론 @Component("xx") 이런 식으로 이름을 정할 수 있다.
다음은 의존관계 자동 주입이다.
생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
이때 기본 조회 전략은 타입이 같은 빈을 찾아서 조회한다. ac.getBean(MemberRepository.class)와 동일하다고 이해하면 된다. 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.
이번에는 탐색 위치와 기본 스캔 대상에 대해 알아보자.
모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.
@ComponentScan(
basePackages="hello.core",
)
basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
basePackages:{"hello.core", "hello.spring"}처럼 이렇게 여러 시작 위치를 지정할 수 있다.
만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
따라서 권장하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
최근 스프링 부트도 이 방법을 기본으로 제공한다.
컴포넌트 스캔 기본 대상은 @Controller, @Component, @Service, @Repository, @Configuration이 있다.
컴포넌트 스캔의 용도 뿐만 아니라 다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.
- @Controller : 스프링 MVC 컨트롤러로 인식
- Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
- @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
- @Service : 사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나라고 비즈니스 계층을 인식하는데 도움이 된다.
빈을 조회할 때 필터도 존재한다. 필터로는 2가지가 있다.
- includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
- excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
코드로 짧게 확인해보면 아래와 같다.
@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyIncludeComponent.class),//이것은 MyIncludeComponent.class를 필터링할 때 빈으로 추가하겠다는 뜻.
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
MyExcludeComponent.class) //이것은 MyExcludeComponent.class를 필터링할 때 빈으로 등록하지 않겠다는 뜻.
)
FilterType은 5가지 옵션이 있다.
- ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다. ex) org.example.SomeAnnotation
- ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다. ex) org.example.SomeClass
- ASPECTJ: AspectJ 패턴 사용 ex) org.example..*Service+
- REGEX: 정규 표현식 ex) org\.example\.Default.*
- CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리 ex) org.example.MyTypeFilter
참고로 @Component면 충분하기 때문에 includeFilters를 사용할 일은 거의 없다. excludeFilters는 여러 가지 이유로 간혹 사용할 때가 있지만 많지는 않다. 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장한다.
이번에는 클래스를 빈으로 등록할 때 생기는 중복 등록과 충돌에 대해 정리해보겠다.
중복에는 2가지 상황이 있다.
자동 빈 등록 VS 자동 빈 등록
수동 빈 등록 VS 수동 빈 등록
먼저 자동 빈 등록과 자동 빈 등록이다.
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
-> ConflictingBeanDefinitionException 예외 발생
수동 빈 등록 VS 자동 빈 등록은 어떨까?
이 경우에는 수동 빈 등록이 우선권을 가진다. 즉 수동 빈이 자동 빈을 오버 라이딩한다. 생각해보면 당연하다. 직접 이름을 지어서 등록했는데 자동으로 등록한 것보다는 우선권이 높아야 하지 않을까?ㅎㅎ..
물론 의도적인 이런 결과를 만들었더라도, 이렇게 설정하면 좋지 않다. 최근 스프링 부트는 수동 빈 등록과 자동 빈 등록이 충돌이 나면 오류가 발생하도록 기본 값을 바꾸었다.
수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러
Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true 스프링 부트인 CoreApplication을 실행해보면 오류를 볼 수 있다.
이상으로 포스팅을 마치겠습니다.
댓글