카테고리 없음
< 스프링 핵심 원리 - 기본편 > 섹션 6. 컴포넌트 스캔
정현3
2022. 4. 14. 23:44
섹션 6. 컴포넌트 스캔
1. 컴포넌트 스캔 - 컴포넌트 스캔과 의존관계 자동 주입 시작하기
2. 컴포넌트 스캔 - 탐색 위치와 기본 스캔 대상
3. 컴포넌트 스캔 - 필터
4. 컴포넌트 스캔 - 중복 등록과 충돌
< 1. 컴포넌트 스캔과 의존관계 자동 주입 시작하기>
-> 지금까지 스프링 빈을 등록할 때 는 자바 코드의 @Bean이나 XML의 <bean>등을 통해서 '설정 정보'에 직접 등록할 스프링 빈을 나열했다.
->예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 '스프링 빈'이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, '누락하는 문제'도 발생한다.
-> "그래서 스프링은 '설정 정보'가 없어도 자동으로 '스프링 빈'을 등록하는 '컴포넌트 스캔'이라는 기능을 제공한다."
-> "또 의존관계도 '자동으로 주입'하는 @Autowired라는 기능도 제공한다."
코드로 "컴포넌트 스캔"과 "의존관계 자동 주입"을 알아보자. 먼저 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고 , 새로운 AutoAppConfig.java를 만들자.
-> @ComponentScan은 AppConfig를 쓰지 않기때문에 설정정보 자체를 쓰지않는다 -> 의존관계 자동 주입이 필요하다 -> 타입을 기반으로 찾아서 주입한다
AutoAppConfig.java
package hello.core;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
@Configuration
@ComponentScan(
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION
, classes = Configuration.class)
//모두 다 포함할 수 없기에 Filter로 사전에 제외해준다.
)
public class AutoAppConfig {
}-> '컴포넌트 스캔'을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
-> "기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다."
참고 :" 컴포넌트 스캔을 사용하면 @Configuration이 붙은 '설정 정보'도 자동으로 등록되기 때문에, AppConfig,TestConfig 등 앞서 만들어 두었던 설정 정보도 함께 등록되고, 실행되어 버린다. 그래서 excludeFilters를 이용해서 '설정정보'는 '컴포넌트 스캔 대상'에서 제외했다.
보통 '설정 정보(AppConfig)'를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다."
"컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. @Component를 붙여주자"
참고 : @Configuration이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.
"이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 애노테이션을 붙여주자."
MemoryMemberRepository @Component 추가
package hello.core.member;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
@Component
public class MemoryMemberRepository implements MemberRepository {
private static Map<Long, Member> store = new ConcurrentHashMap<>();
@Override
public void save(Member member) {
store.put(member.getId(), member);
}
@Override
public Member findById(Long memberId) {
return store.get(memberId);
}
}RateDiscountPolicy @Component추가
package hello.core.discount;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.springframework.stereotype.Component;
@Component
public class RateDiscountPolicy implements DiscountPolicy { //새로운 정률 정책
private int discountPercent = 10;
@Override
public int discount(Member member, int price) {
if (member.getGrade() == Grade.VIP) {
return price * discountPercent / 100;
} else {
return 0;
}
}
}
MemberServiceImpl @Component, @Autowired 추가
package hello.corecore.member;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class MemberServiceImpl implements MemberService{ // 회원 서비스 구현법
// 구현체가 하나 있을떄는 관례로 인터페이스 뒤에 impl 이라고 많이 쓴다.
//private final MemberRepository memberRepository = new MemoryMemberRepository();
private final MemberRepository memberRepository;
// 생성자를 통해서 memberRepository에 무엇이 들어갈지를 결정한다.
@Autowired // 자동 의존관계 주입 -> 생성자 마치 ac.getBean(MemberRepository.class)
public MemberServiceImpl(MemberRepository memberRepository) { // 생성자 생성
this.memberRepository = memberRepository;
}
// "MemberServiceImpl은 MemberRepository(추상화)에도 의존하고, MemoryMemberRepository(구체화)에도 의존한다."
// DIP를 위반한다.
@Override
public void join(Member member) {
memberRepository.save(member);
}
@Override
public Member findMember(Long memberId) {
return memberRepository.findById(memberId);
}
//테스트 용도
public MemberRepository getMemberRepository(){
return memberRepository;
}
}-> 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
-> @Autowired는 '의존관계'를 자동으로 주입해준다. 자세한 룰은 조금 뒤에 설명하겠다.
-> @ComponentScan을 사용하면 자동으로 @AutoWired를 사용하게 된다. 빈이 자동으로 등록이 되지만, 의존관계설정을 해줄 수 있는 방법이 없기때문에 but 수동으로 등록할 장소가 없다
-> @ComponentScan은 AppConfig를 쓰지 않기때문에 설정정보 자체를 쓰지않는다 -> "의존관계 자동 주입이 필요하다"
OrderServiceImpl @Component,@Autowired 추가
package hello.corecore.order;
import hello.corecore.discount.DiscountPolicy;
import hello.corecore.member.Member;
import hello.corecore.member.MemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component //컴포넌트 스캔의 대상이 되며 스프링 빈으로 등록이 된다
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository; // 메모리 회원 저장소(구현체)
// private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); // 고정 할인 정책(구현체)
//private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
private final DiscountPolicy discountPolicy;
// 인터페이스인 DiscountPolicy에만 의존하여 구체화가 아닌 추상화에만 의존한다.
@Autowired // 생성자 위에 - applicationContext에서 매개변수들에게 주입해준다
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy){
this.memberRepository = memberRepository; // 위에 new객체를 지우고 따로 생성자를 통해서 할당한다.
this.discountPolicy = discountPolicy;
}
@Override
public Order createOrder(Long memberId, String itemName, int itemPrice){
Member member = memberRepository.findById(memberId); // 회원 정보 조회
int discountPrice = discountPolicy.discount(member, itemPrice); // 할인정책에 회원정보를 넘긴다.
// discountPolicy는 단일책임원칙을 잘 지키면서 설계되었다
return new Order(memberId, itemName, itemPrice, discountPrice);
// 반환값으로 최종적으로 할인된 물건의 값을 받았다.
}
//테스트 용도
public MemberRepository getMemberRepository(){
return memberRepository;
}
}-> @Autowired 를 사용하면 '생성자'에서 여러 의존관계도 한번에 주입받을 수 있다.
AutoAppConfigTest.java
package scan;
import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
public class AutoAppConfigTest {
@Test
void basicScan(){
AnnotationConfigApplicationContext ac =
new AnnotationConfigApplicationContext(AutoAppConfig.class);
MemberService memberService = ac.getBean(MemberService.class);
assertThat(memberService).isInstanceOf(MemberService.class);
}
}-> AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하다.
-> "설정 정보로 AutoAppConfig 클래스를 넘겨준다."
-> 실행해보면 기존과 같이 잘 동작하는것을 확인할 수 있다.
로그를 잘 보면 '컴포넌트 스캔'이 잘 동작하는 것을 확인할 수 있다
ClassPathBeanDefinitionScanner - Identified candidate component class:
.. RateDiscountPolicy.class
.. MemberServiceImpl.class
.. MemoryMemberRepository.class
.. OrderServiceImpl.class
-> autoAppConfig, rateDiscountPolicy, memberServiceImpl, memoryMemberRepository가 싱글톤 빈으로 생성되었다
컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.
1. @ComponentScan
--> @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다. '싱글톤'으로 등록한다.
--> 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다
--> 빈 이름 기본 전략 : MemberServiceImpl 클래스 -> memberServiceImpl
--> 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2")이런식으로 이름을 부여
2. @Autowired 의존관계 자동 주입
@Component
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
@Autowired
public MemberServiceImpl(MemberRepository memberRepository) { //생성자
this.memberRepository = memberRepository;
}-->" 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다."
--> 이때 기본 조회 전략은 '타입이 같은 빈'을 찾아서 주입한다
--> getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
--> 더 자세한 내용은 뒤에서 설명한다.
@Component
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}--> 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.
< 2. 탐색 위치와 기본 스캔 대상>
탐색할 패키지의 시작 위치 지정
: 모든 자바 클래스를 다 '컴포넌트 스캔' 하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.
package hello.corecore;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
@Configuration
@ComponentScan(
basePackages = "hello.corecore.member",
basePackageClasses = AutoAppConfig.class,
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION
, classes = Configuration.class)
)
public class AutoAppConfig {
}
-->backPackges : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 '하위 패키지'를 모두 탐색한다.
-->backPackages = { "hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
--> backPackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
--> 만약 지정하지 않으면 @ComponentScan이 붙은 '설정 정보 클래스'의 패키지가 시작 위치가 된다.
< 권장하는 방법 >
: "개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 '프로젝트 최상단' 에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다."
예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면
-com.hello
-com.hello.service
-com.hello.repository
com.hello --> 프로젝트 시작 루트, 여기에 AppConfig 같은 '메인 설정 정보'를 두고, @ComponentScan 애노테이션을 붙이고, backPackages 지정은 생략한다.
이렇게 하면 com.hello를 포함한 하위는 모두 자동으로' 컴포넌트 스캔'의 대상이 된다. 그리고 '프로젝트 메인 설정 정보'는 프로젝트를 대표하는 정보이기 때문에 '프로젝트 시작 루트 위치' 에 두는 것이 좋다 생각한다.
"참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. ( 그리고 이 설정안에 바로 @ComponentScan이 들어있다 !!)"
< 컴포넌트 스캔 기본 대상 >
"컴포넌트 스캔'은 @Component뿐만 아니라 다음과 내용도 추가로 대상에 포함한다."
--> @Component : '컴포넌트 스캔' 에서 사용
--> @Controller : '스프링 MVC 컨트롤러' 에서 사용
--> @Service : '스프링 비즈니스 로직' 에서 사용
--> @Repository : '스프링 데이터 접근 계층' 에서 사용 : JPA,JDBC
--> @Comfiguration : '스프링 설정 정보' 에서 사용
해당 클래스의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있다.
@Component
public @interface Controller {
}
@Component
public @interface Service {
}
@Component
public @interface Configuration {
}
참고 : 사실 애노테이션에는 상속관계라는것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.
--> '컴포넌트 스캔'의 용도뿐만 아니라 다음 '애노테이션(메타정보 )'이 있으면 '스프링은 부가 기능'을 수행한다.
@Controller : 스프링 MVC 컨트롤러로 인식
@Repository : 스프링 데이터 접근 계층으로 인식하고, '데이터 계층의 예외(DB에 접근하는 예외)' 를 '스프링 예외' 로 추상화해서 변환해준다. -> JPA, JDBC
@Configuration : 앞서 보았듯이 '스프링 설정 정보' 로 인식하고, 스프링 빈이 '싱글톤' 을 유지하도록 추가 처리를 한다.
@Service : 사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들이 '핵심 비즈니스 로직' 이 여기에 있겠구나 라고 비즈니스 계층을 '인식' 하는데 도움이 된다.
참고 : useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나 정도 알고 넘어가자.
< 3. 필터 >
includeFilters : 컴포넌트 스캔 대상을 '추가'로 지정한다.
excludeFilters : 컴포넌트 스캔에서 '제외'할 대상을 지정한다.
"모든 코드는 테스트 코드에 추가한다"
컴포넌트 스캔 대상에 추가할 애노테이션
package hello.corecore.scan.filter;
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent { // MyIncludeComponent를 포함한 클래스는 컴포넌트 스캔을 적용할것이다.
}컴포넌트 스캔 대상에서 제외할 애노테이션
package hello.corecore.scan.filter;
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent { // MyExcludeComponent가 붙으면 컴포넌트 스캔에서 제외할 것이다.
}컴포넌트 스캔 대상에 추가할 클래스
package scan.filter;
@MyIncludeComponent
public class BeanA {
}
컴포넌트 스캔 대상에서 제외할 클래스
package scan.filter;
@MyExcludeComponent
public class BeanB {
}
설정 정보와 전체 테스트 코드
package hello.corecore.scan.filter;
import org.assertj.core.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;
public class ComponentFilterAppConfigTest {
@Test
void filterScan() {
ApplicationContext ac =
new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
BeanA beanA = ac.getBean("beanA", BeanA.class);
Assertions.assertThat(beanA).isNotNull(); // 값이 null이면 안된다.
// ac.getBean("beanB", BeanB.class); --> MyExcludeComponent 이기에 존재하지않아서 실행하면 오류가 생긴다.
org.junit.jupiter.api.Assertions.assertThrows(
NoSuchBeanDefinitionException.class,
()-> ac.getBean("beanB, BeanB.class")); // 오류가 발생하도록 assertThrows를 하였다.
}
@Configuration
@ComponentScan(
includeFilters =
@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
excludeFilters =
@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
static class ComponentFilterAppConfig {
}
}--> includeFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
--> excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다. -> NoSuchBeanDefinition
< 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
예를 들어서 BeanA도 빼고 싶으면 다음과 같이 추가하면 된다.
@Configuration
@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
excludeFilters = {
@Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class),
@Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
}
)- 참고:" @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다."
- "특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다."
< 4.중복 등록과 충돌 >
: 컴포넌트 스캔에서 '같은 빈 이름'을 등록하면 어떻게 될까? 다음의 두가지 상황이 있다.
1. 자동 빈 등록 vs 자동 빈 등록
2. 수동 빈 등록 vs 자동 빈 등록
자동 빈 등록 vs 자동 빈 등록
--> 컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
--> ConflitingBeanDefinitionException 예외 발생
수동 빈 등록 vs 자동 빈 등록.
--> 만약 수동 빈 등록과 자동 빈 등록 에서 '빈 이름이 충돌'하면 어떻게 될까?
-
@Component public class MemoryMemberRepository implements MemberRepository {}
package hello.core;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
@Configuration
@ComponentScan(
basePackages = "hello.core.member",
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION
, classes = Configuration.class)
)
public class AutoAppConfig {
@Bean(name = " memoryMemberRepository")
MemberRepository memberRepository(){
return new MemoryMemberRepository();
}
}
--> 이 경우 수동 빈 등록이 우선권을 가진다. " 수동 빈이 자동 빈을 오버라이딩 해버린다."
Overriding Bean Definition
수동 빈 등록시 남는 로그
Overriding bean definition for bean 'memoryMemberRepository' with a different
definition: replacing
"물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 '수동'이 우선권을 가지는 것이 좋다. 하지만 현실은 개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다!
그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다."
" 그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 '오류가 발생하도록' 기본 값을 바꾸었다 "
개발은 명확하지 않은것은 하면 안된다. 애매한 상황이 발생하지 않도록 한다.
어설픈 추상화나 어설픈 우선순위들이 있으면 나중에 버그를 잡기위해 많은 시간을 투입해야 한다. 차라리 빠른 오류를 발생시켜 빨리 처리하는게 더 나은 방법이다.
수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러
Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true스프링 부트인 CoreApplication을 실행해보면 오류를 볼 수 있다.