조회 빈이 2개 이상 존재할 때 해결법

@Autowired는 타입(Type)으로 조회한다.

@Autowired
private DiscountPolicy discountpolicy;

 

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다.

ac.getBean(DiscountPolicy.class)

 

스프링 빈 조회에서 배웠듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

(조회했을 때 존재하지 않는 타입이면 그 때도 문제 발생, 이를 피하기 위해서 "required = false"를 넣어주어야 한다.)

DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘다 스프링 빈으로 선언해보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy{}

@Component
public class RateDiscountPolicy implements DiscountPolicy{}

 

그리고 이렇게 의존관계 자동 주입을 실행하면

@Autowired
private DiscountPolicy discountPolicy;

밑에 보이듯이 NoUniqueBeanDefinitionException 에러가 발생하였다.

오류메시지를 해석해보면 하나의 빈을 기대했는데 fixDiscountPolicy, rateDiscountPolicy 2개가 발견되었다고 한다.

 

이떄 하위 타입으로 정확한 클래스명을 지정해줄 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을때는 해결이 안된다.

스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 방법들이 있다.

 

---

 

@Autowired 필드명, @Qualifier, @Primary

조회 대상 빈이 2개 이상일 때 해결 방법

• @Autowired 필드 명 매칭
• @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
• @Primary 사용

 

 

 

@Autowired 필드 명 매칭

@Autowired는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

 

< 기존 코드 >

@Autowired
private DiscountPolicy discountPolicy​

 

< 필드 명을 빈 이름으로 변경 >

@Autowired
private DiscountPolicy rateDiscountPolicy

-> 필드 명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능

 

@Autowired 매칭 정리

• 1. 타입 매칭
• 2. 타입 매칭의 결과가 2개 이상일 때 필드명, 파라미터 명으로 빈 이름 매칭

 

---

 

@Qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방법. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

 

빈 등록시 @Qualifier를 붙여준다.

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.

 

 

< 생성자 자동 주입 예시 >

@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
						@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy){
       this.memberRepository = memberRepository;
       this.discountPolicy = discountPolicy;
}

 

< 수정자 자동 주입 예시 >

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy){
         return discountPolicy;
}

 

 

@Qualifier 매칭 정리

• 1. @Qualifier끼리 매칭
• 2. 빈 이름 매칭
• 3. NoSuchBeanDefinitionException 예외 발생

---

 

@Primary 매칭 사용 (★)

@Primary는 우선순위를 정하는 방법이다.

@Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.

 

rateDiscountPolicy가 우선권을 가지도록 하자.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

 

사용 코드

// 생성자
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy){
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

// 수정자
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy){
	return discountPolicy;
}

 

---

 

@Qualifier vs @Primary

@Primary, @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자. 메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다. 물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.

-> 기본값으로 우선순위를 두어야하는 것에 @Primary를 선언하고, 특별히 지정해주어야 하는 경우 @Qualifer를 활용하자

 

기본적으로 우선순위는 @Primary보다 @Qualifier가 더 좁은 범위이므로 우선권이 높다.