Spring 시리즈는 혼자 공부하며 기록으로 남기고, 만약 잘못 학습 한 지식이 있다면 공유하며 피드백을 받고자 작성합니다.
스프링에 대해 깊게 공부해보고자 인프런의 김영한 강사님께서 강의를 진행하시는 (스프링 핵심 원리 - 기본편) 강의를 수강하며 정리하는 글입니다.
혹여나 글을 읽으시며 잘못 설명된 부분이 있다면 지적 부탁드리겠습니다.
조회할 빈이 2개 이상
문제점
@Autowired private DiscountPolicy discountPolicy;@Autowired는 타입으로 조회한다.- 타입으로 조회하기 때문에 다음 코드와 유사하게 동작한다.
ac.getBean(DiscountPolicy.class) - 스프링 빈 조회를 학습할 때 조회할 때 빈이 2가지 이상이 선택되면 문제가 발생했다.
DiscountPolicy의 구현체인FixDiscountPolicy와RateDiscountPolicy를 스프링 빈으로 등록해보자.
@Component
public class RateDiscountPolicy implements DiscountPolicy {}@Component
public class FixDiscountPolicy implements DiscountPolicy {}테스트 결과
Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy
- 테스트를 돌려보면 DiscountPolicy를 주입할때 하나의 빈을 기대했지만 두개의 빈을 조회하여
NoUniqueBeanDefinitionException예외가 발생하는걸 확인할 수 있다.
- 하위 타입으로 지정할 수는 있지만, 하위 타입으로 지정하여 조회하는 것은 DIP를 위반하고 유연성이 저하된다.
그리고 이름만 다르고 완전히 똑같은 타입의 스프링 빈이 2개가 존재할때는 해결이 안된다.
해결 방법
@Autowired 필드 명 매칭
@Autowired는 타입 매칭을 시도하고, 이때 여러개의 빈이 발견되면 필드 이름이나 파라미터 이름으로 빈 이름을 추가로 매칭한다.
기존 코드
@Autowired
private DiscountPolicy discountPolicy;필드명 매칭
@Autowired
private DiscountPolicy rateDiscountPolicy;@Autowired 매칭 정리
- 타입 매칭
- 타입으로 매칭을 하여 결과가 하나일 경우 빈을 주입을 해준다.
- 타입 매칭의 결과가 2개 이상일 때 필드 명으로 빈 이름 매칭
- 스프링은 본인과 같은 타입이거나 또는 그 타입의 자식들을 다 끌고온다.
- 조회된 결과에서 필드명 또는 파라미터 이름으로 빈 이름을 매칭하여 같은게 있으면 주입을 해준다.
@Qualifier
@Qualifier은 추가 구분자를 붙여주는 방식이다. (책갈피 느낌)- 주입 시 추가적인 방법을 제공하는 것일 뿐, 빈 이름을 변경하는것은 아니다.
빈 등록시 @Qualifier을 추가
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}생성자 주입 예시
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}@Qualifier로 주입시 만약mainDiscountPolicy를 찾지 못한다면 어떻게 될까?
-> mainDiscountPolicy 라는 스프링 빈을 추가로 찾는다.- 다음과 같이 직접 빈 등록시에도
@Qualifier를 사용할 수 있다.
@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
return new RateDiscountPolicy();
}Qualifier 정리
1. @Qualifier 구분자끼리 매칭
2. 구분자의 빈 이름으로 매칭
3. NoSuchBeanDefinitionException 예외 발생
@Primary 사용
@Primary는 우선순위를 결정하는 방식이다.@Autowired시에 여러 빈이 매칭되면@Primary가 우선권을 가진다.
rateDiscountPolicy에 우선권 추가
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}@Component
public class FixDiscountPolicy implements DiscountPolicy {}public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}- 코드를 실행해보면
RateDiscountPolicy가 주입되는걸 확인 할 수 있다.
@Primary, @Qualifier 활용
- 코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈과 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 가정해본다.
- 메인 데이터베이스의 커넥션을 획득하는 스프링 빈 = @Primary 적용
- 서브 데이터베이스의 커넥션을 획득하는 스프링 빈 = @Qualifier 적용
우선순위
@Primary는 기본값처럼 동작,@Qualifier는 매우 상세하게 동작한다.- 스프링은 자동보단 수동이, 넓은 범위보단 좁은 범위의 선택권이 우선 순위가 높다.
@Qualifier는 이름까지 하나하나 상세하게 지정해주기 때문에@Qualifier가 우선권이 더 높다.
애노테이션 직접 만들기(@Qualifier의 문제점)
@Qualifier("mainDiscountPolicy")처럼 문자열을 적게되면 컴파일 시점에 타입 체크가 안된다.
그래서 애노테이션을 새로 작성하여 문제를 해결할 수 있다.
MainDiscountPolicy 애노테이션 생성
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}애노테이션 적용
@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}생성자 자동 주입
@Component
public class OrderServiceImpl implements OrderService {
private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
}- 저번에 앞 게시글에서도 언급했다시피 자바에는 애노테이션 상속개념은 존재하지 않는다. 여러 애노테이션들을 상속구조처럼 도와주는건 스프링이 지원해주는 기능이다.
@Autowired도 재정의 할 수 있지만 스프링이 기본적으로 지원하는 기능을 뚜렷한 목적없이 재정의하는것은 유지보수에 더 혼란만 증가시킨다.
