5) RateDiscountPolicy 를 의존관계로 주입하려는 클래스 OrderServiceImpl코드를 열어보자.
DiscountPolicy 에 @Qualifier 를 지정하되, 방금 만든 @MainDiscountPolicy를 쓰자.
6) 로그를 보면 정상적으로 스프링 빈이 등록되고 의존관계도 주입됬음을 확인할 수 있다.
Creating shared instance of singleton bean 'orderServiceImpl'
Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'
OrderServiceImpl 싱글톤 빈이 생성됬고,
생성자를 통해 memoryMemberRepository와 rateDiscountPolicy 빈이 의존관계 주입이 됬다.
다음 강의에서는조회한 빈이 모두 필요할 때 List, Map 으로 처리하는 방법을 배운다.
1. 조회할 빈이 2개 이상일 때의 문제를 어떻게 처리해야 할지 배운다. 2. @Autowired 필드 명을 매칭, @Qualifier, @Primary 사용법을 배운다.
'의존관계 자동 주입' 목차
1. 다양한 의존관계 주입 방법
2. 옵션 처리
3. 생성자 주입을 선택해라!
4. 롬복과 최신 트랜드
5. 조회 빈이 2개 이상 - 문제 (이번 포스팅)
6. @Autowired 필드 명, @Qualifier, @Primary
7. 애노테이션 직접 만들기
8. 조회한 빈이 모두 필요할 때, List, Map
9. 자동, 수동의 올바른 실무 운영 기준
5. 조회할 빈이 2개 이상일 때의 문제 해결하기
@Autowired 는 타입으로 빈을 조회한다.
1) 만약 타입이 같은 빈이 2개가 조회되면 문제가 생길까?
인터페이스 DiscountPolicy의 구현체 2개가 있다. RateDiscountPolicy와 FixDiscountPolicy 는 타입이 같다.
RateDiscountPolicy 만 컴포넌트 스캔으로 스프링 빈 등록했었는데. FixDiscountPolicy도 스프링 빈 등록하려고 한다.
스프링 빈 등록을 위해 컴포넌트 스캔을 하자.
2) orderServiceImple 에서 의존성 예외 발생했는데, DiscountPolicy 싱글 빈이 매칭되기를 기대했는데, 2개가 발견됬기 때문이다.
beans.factory.UnsatisfiedDependencyException:
Error creating bean with name 'orderServiceImpl' Unsatisfied dependency
nested exception is NoUniqueBeanDefinitionException:
No qualifying bean of type 'DiscountPolicy' available:
expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
@Autowired 로 의존관계를 주입하려고 DiscountPolicy 타입의 스프링 빈을 뒤져봤더니
1개 매칭을 기대했는데, 2개의 스프링 빈이 RateDiscountPolicy와 FixDiscountPolicy 발견되서 에러가 났다.
3) 하위 타입인 fixDiscountPolicy 나 rateDiscountPolicy 를 적어야 할까? 아니다. 하위타입에 의존하면 DIP를 위반한다.
다음 시간에 해결책을 배워보자.
6. @Autowired 필드 명, @Qualifier, @Primary
타입이 같은 빈이 여러개 조회되면, 3가지 방법으로 해결할 수 있다.
1) @Autowired 필드 명을 매칭한다
@Autowired 의 스프링 빈 조회 순서-> 1. 타입 매칭, 2. 필드 명 또는 파라미터 명을 매칭
@Autowired 는 가장 먼저 스프링 빈의 타입을 매칭해보고. 빈이 2개 이상 조회되면 필드 명을 확인해서 매칭되는 하나를 조회한다.
이전 코드
@Autowired 필드 명을 매칭시키도록 변경한 코드
2) @Qualifier 추가 구분자를 붙여주기
추가적인 방법을 제공하는 것이지 빈 이름을 변경하는건 아니다.
예를 들어, RateDiscountPolicy 에 @Qualifier("mainDiscountPolicy")를 지정하고,
FixDiscountPolicy 에는 @Qualifier("fixDiscountPolicy")를 지정한다.
생성자 주입을 할 때 @Qualifier를 써주면 된다.
만약 해당 @Qualifier를 못찾으면 스프링은 그 이름으로 등록된 빈을 찾아본다.
@Qualifier의 스프링 빈 조회 순서-> 1. @Qualifier 끼리 매칭, 2. 빈 이름 매칭
@Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다. 헷갈리게 하는 요소를 만들지 말자.
3) @Primary 우선순위를 지정하기 [ 편하고 자주 사용한다 ]
rate 할인정책을 항상 먼저 적용하고 싶다면, RateDiscountPolicy에 @Primary 를 붙인다.
생성자에는 DiscountPolicy 타입 그대로 둔다.
[ 참고 ] @Primary 는 언제 사용할까?
예를 들어, 메인 DB connection 을 주로 사용하고, 백업용 DB connection 이 있는 상황에서,
메인 DB connection 에 @Primary 를 걸어두자고 팀내에서 룰을 지정할 수 있다.
@ComponentScan 에 includeFilters와 excludeFilters를 적용할 수 있다.
includeFilters 에는 포함할 애노테이션인 MyIncludeComponent.class를 써주고,
excludeFilters 에는 제외하는 필터 애노테이션이니까 MyExcludeComponent.class를 써주자.
3) 필터가 적용된 컴포넌트 스캔을 하되, 스프링 빈이 생성됬는지 확인하자.
BeanA만 컴포넌트 스캔에 포함되어야 한다. BeanA 스프링 빈으로 등록되고, BeanB 라는 빈은 찾을 수 없어야 테스트 성공이다.
3) FilterType 옵션 5가지를 알아보자.
* ANNOTATION : 기본값. 애노테이션을 인식해서 동작하는 것이 기본이다.
" type = FilterType.ANNOTATION "을 지워도 똑같이 동작한다.
* ASSIONABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다
org.example.SomeClass
* ASPECTJ : AspectJ 패턴을 사용한다
org.example..*Service+
* REGEX : 정규표현식을 줄 수 있다
org\.example\.Default.*
* CUSTOM : TypeFilter 라는 인터페이스를 구현해서 처리한다
org.example.MyTypeFilter
[ 참고 ]
@Component 애노테이션으로 충분하기 때문에 includeFilters 를 사용할 일은 드물다. excludeFilters는 아주 가끔 쓴다.
스프링 부트가 기본으로 제공하는 컴포넌트 스캔을 사용하는 것을 권장한다.
4. 중복 등록과 충돌
컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?
다음 두 가지 상황이 있다.
1) 자동 빈 등록 vs 자동 빈 등록
컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록될 때 이름이 같으면 오류가 발생한다.
예를 들어, 2개의 빈에 service라고 이름 붙여보자.
MemberServiceImpl 과 OrderServiceImpl에 둘 다 @Component("service")라고 붙이자.
컴포넌트 스캔을 해보면, 빈이 충돌난다고 ConflictingBeanDefinitionException 에러가 난다.
org.springframework.beans.factory.BeanDefinitionStoreException:
Failed to parse configuration class [hello.corebasic.AutoAppConfig];
nested exception is org.springframework.context.annotation.ConflictingBeanDefinitionException:
Annotation-specified bean name 'service' for bean class [hello.corebasic.order.OrderServiceImpl] conflicts with existing,
non-compatible bean definition of same name and class [hello.corebasic.member.MemberServiceImpl]
에러 내용이 굉장히 친절하다. 애노테이션으로 이름지어진 'service'라는 빈 이름이 있는데,
MemberServiceImpl 에도 정의되어 있고, OrderServiceImpl 에도 같은 이름으로 정의되어 있다는 내용이다.
2) 수동 빈 등록 vs 자동 빈 등록
이 경우, 수동 빈 등록이 우선권을 가진다. 수동 빈이 자동 빈을 오버라이딩한다.
예를 들어, MemoryMemberRepository는 @Component 를 달아놔서 컴포넌트 스캔의 대상이되고
빈 이름은 기본으로 클래스 명 앞글자 하나만 소문자로 바꿔서 memoryMemberRepository 로 이름지어진다.
@ComponentScan 하는 설정에서 memoryMemberRepository라는 똑같은 이름으로 MemoryMemberRepository 빈 등록을 시도해보자.
컴포넌트 스캔 하는 테스트를 실행하면? 성공하긴 한다.
수동 빈이 자동 빈을 오버라이딩 한다고 로그 메시지가 출력된다.
Overriding bean definition for bean 'memoryMemberRepository' with a different definition:
replacing [Generic bean: class [hello.corebasic.member.MemoryMemberRepository];
하지만 현실은 개발자가 의도적으로 설정해서 이런 결과를 낳기보다는 여러 설정들이 꼬여서 이렇게 되는 경우가 다반사다!
이러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.
3) 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 이름 충돌이 나면 아래 내용의 오류를 내도록 바뀌었다.
스프링 부트를 실행해보자.
"이미 AutoAppConfig.class 에 정의된(수동으로 등록한) 'memoryMemberRepository' 빈이 등록되지 못했다.
MemoryMemberRepository 에 정의된 이름으로 빈이 등록되었기 때문이다. 그리고 오버라이딩이 불가능하다. "
The bean 'memoryMemberRepository',
defined in class path resource [hello/corebasic/AutoAppConfig.class],
could not be registered.
A bean with that name has already been defined in file [/Users/.../hello/corebasic
/member/MemoryMemberRepository.class] and overriding is disabled.
스프링 부트의 기본 설정으로는 이렇게 오류를 내지만,
application.yml 애플리케이션 프로퍼티 파일에 옵션을 아래처럼 바꾸면 수동 등록 빈 오버라이딩을 허용해준다.
Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true
[ 참고 ]
어설픈 추상화를 하지 말자. 코드 양이 좀더 나오더라도 명확하게 코딩하는 것이 낫다.
애매한 상황과 코드는 피해야 한다. 애매한 버그가 제일 잡기 어렵기 때문이다. 그리고 개발은 혼자하는 것이 아니기 때문이다.
* 로그에서 의존관계 주입을 확인할 수 있다. memoryMemberRepository 이름의 빈이 생성자를 통해 자동주입됨.
Creating shared instance of singleton bean 'orderServiceImpl'
Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'
6) 컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.
@ComponentScan은 @Component가 붙은 클래스를 찾아서 전부 스프링 빈으로 등록한다.
스프링 빈의 기본 이름은 클래스명을 쓰는데 앞글자만 소문자로 바꿔서 쓴다. 직접 빈 이름을 지정할 수 도 있다.
MemberServiceImpl - > memberServiceImpl
생성자에 @Autowired 를 붙이면, 스프링 컨테이너가 자동으로 해당 빈을 찾아서 주입한다.
기본 조회 전략은 타입이 같은 빈을 찾는 것이다.
아래 코드를 보면 MemberRepository 빈을 의존관계로 주입해야 하는 상황이다.
MemberRepository와 타입이 같은 것을 찾는다.
memoryMemberRepository 가 MemberRepository의 구현체니까 타입이 맞다.
그래서 memoryMemberRepository를 꺼내서 주입한다.
getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
2. 탐색 위치와 기본 스캔 대상
컴포넌트 스캔을 시작하는 위치와 대상에 대해 알아보자.
1) 탐색할 패키지의 시작 위치 지정 : 탐색 위치를 지정 할 수 있다!
AutoAppConfig.class 파일을 열어보자. 어떤 패키지부터 탐색할 지 basePackages 를 지정할 수 있다.
모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸리기 때문이다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.
현재 프로젝트 네비게이션은 아래와 같이 여러개의 패키지로 구성되어 있다.
member 패키지를 basePackages 로 지정하고 컴포넌트 스캔하면 어떻게 될까?
basePackages = member 패키지를 포함해서 하위 패키지를 모두 탐색한다.
그래서 memberServiceImpl, memoryMemberRepository 만 스프링 빈으로 등록됬다.
orderServiceImpl같은 다른 패키지의 빈은 제외됬다.
2) 탐색 위치를 지정하지 않으면 어떻게 될까?
@ComponentScan이 붙은 설정 정보 클래스의 위치 부터 하위 패키지를 모두 탐색한다.
hello.corebasic 패키지 하위의 모든 자바 파일에 @Component가 붙었는지 검사한다.
3) 권장하는 방법 : @ComponentScan이 붙은 설정 정보 클래스의 위치를 최상단에 두자 !
최근 스프링부트도 이 방법을 기본으로 제공한다.
예를 들어, 패키지가 아래와 같은 구조라면, hello.corebasic 여기가 프로젝트 시작 루트가 된다. (지금 AutoAppConfig.class위치)
프로젝트 시작 루트에 @ComponentScan 를 붙인 메인 설정 정보 클래스를 두고 basePackage 지정은 생략한다.
이렇게 하면 hello.corebasic 를 포함한 하위는 모두 컴포넌트 스캔의 대상이 된다.
[ 참고 ] 스프링 부트를 사용하는 경우
스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.
스프링 부트 프로젝트를 만들면 main() 메서드가 있는 프로젝트명으로 된 클래스가 자동 생성되어 있다.
이 클래스에 이미 @SpringBootApplication 가 붙어있다.
@SpringBootApplication 애노테이션이 뭔지 싶어서 ctrl 을 누르고 들어가보면, @ComponentScan 이 붙어있음을 확인할 수 있다.
그래서 스프링 부트를 실행하면 hello.corebasic 위치 부터 하위까지 다 스프링 빈이 등록된다.
스프링 부트를 쓰면 @ComponentScan 을 따로 달아줄 필요가 없다.
4) 컴포넌트 스캔의 기본 대상
@ComponentScan뿐만 아니라 아래 내용도 컴포넌트 스캔 대상에 포함된다.
* @Component
* @Controller
* @Service
* @Repository
* @Configuration
스프링 MVC를 다뤄봤다면 몇개는 익숙한 애노테이션일 것이다. 해당 클래스의 소스코드를 열어보면 @Component를 포함하고 있음을 확인할 수 있다.
[ 참고 ] 애노테이션에는 상속관계 라는 것이 없다.
애노테이션이 특정 애노테이션을 인식할 수 있는 것인 자바 언어가 지원하는게 아니라, 스프링이 지원하는 기능임을 인지하고 넘어가자.
컴포넌트 스캔의 대상이 되면서도 아래의 애노테이션이 있으면 스프링은 부가 기능을 수행한다.
예를 들어, @Controller 라면, MVC 컨트롤러로 인식한다. @Repository라면 데이터 계층의 예외를 스프링 예외로 변환해준다.
