[Spring] 조회 빈이 2개 이상일 때(오류) - @Autowired 필드 명, @Qualifier, @Primary

문제 발생 - 조회 빈이 2개 이상 

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

@Autowired // DiscountPolicy 타입으로 조회
private DiscountPolicy discountPolicy

 

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다. (실제로는 더 많은 기능을 제공한다.)

ac.getBean(DiscountPolicy.class)

 

타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생

DiscountPolicy타입에 2개의 빈이 등록되어 있다.

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

 

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

@Autowired
private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생

NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

 

이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.

그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.

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

 

 

---

 

문제해결 - @Autowired 필드 명, @Qualifier, @Primary

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

1. @Autowired 필드 명 매칭
2. @Qualifier → @Qualifier끼리 매칭 → 빈 이름 매칭
3. @Primary 사용

1. @Autowired 필드 명 매칭

@Autowired 는 타입 매칭을 시도하고,

이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

 

문제 - 기존 코드 

DiscountPolicy 타입으로 등록된 빈이 2개 이상으로 문제발생

@Autowired
private DiscountPolicy discountPolicy

 

해결 - 필드 명으로 빈 이름으로 변경

discountPolicy → rateDiscountPolicy 으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy // discountPolicy -> rateDiscountPolicy 으로 변경

 

필드 명이 rateDiscountPolicy 이므로 정상 주입된다.

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

 

 

📌  @Autowired 매칭 정리

• 순서 1. 타입 매칭
  • 예시 설명) DiscountPolicy로 타입으로 매칭
• 순서 2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 추가 매칭
  • 예시 설명) DiscountPolicy타입이 2개 이상이기 때문에 필드명으로 추가 매칭

 

2. @Qualifier 사용

@Qualifier 는 추가 구분자를 붙여주는 방법이다.

주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

 

1) @Qualifier 등록하기

빈 등록시 @Qualifier를 붙여 준다. (따로 추가적인 이름을 붙여준다고 생각하면 될 듯하다.)

@Component
@Qualifier("mainDiscountPolicy") // main으로 할 것이기 때문에 이름을 mainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

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

 

2) @Qualifier 사용하기

 

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

방법 1-1) 생성자 자동 주입 예시 

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

 

방법 1-2) 수정자 자동 주입 예시

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
 	this.discountPolicy = discountPolicy;
}

 

@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까?
그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
하지만 경험상 @Qualifier 는 @Qualifier 를 찾 는 용도로만 사용하는게 명확하고 좋다.

 

방법 2) 직접 빈 등록 시에도 @Qualifier를 동일하게 사용할 수 있다.

@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
 	return new ...
}

 

 

📌 @Qualifier 정리

• 순서 1. @Qualifier끼리 매칭
• 순서 2. 빈 이름 매칭
• 순서 3. 순서1, 순서2번에서 매칭되는 게 없을 때, NoSuchBeanDefinitionException 예외 발생

 

3. @Primary 사용

@Primary 는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.

 

1) @Primary 등록하기

rateDiscountPolicy가 우선권을 가지도록 해본다.

@Component
@Primary // @Primary 우선 순위 등록
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

 

2) @Primary 사용하기

따로 적어 줄 필요는 없다. 자동으로 rateDiscountPolicy이 우선권을 가진다.

생성자 자동 주입 예시

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

 

수정자 자동 주입 예시

//수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
 	this.discountPolicy = discountPolicy;
}

 

---

 

@Primary 와 @Qualifier 중에 어떤 것을 사용하면 좋을까?

@Qualifier 

@Qualifier을 등록하고 사용하는 곳에 모두 @Qualifier 을 붙여주어야 한다.

그만큼 상세하게 동작하는 뜻이다.

 

@Primary

등록만 하면 사용은 자동으로 우선순위를 반영하여 작동한다.

기본값처럼 동작하게 된다.

 

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고,
코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.

메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고,

서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.

 

 

@Primary 와 @Qualifier 중 우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다.

이런 경우 어떤 것이 우선권을 가져갈까?

스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다.

따라서 여기서도 @Qualifier 가 우선권이 높다.