조회한 빈이 2개 이상 - 문제

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

@Autowired
private DiscountPolicy discountPolicy

• 타입으로 조회하기 때문에 마치 다음 코드와 유사하게 동작한다.
  • ac.getBean(DiscountPolicy.class)
  • 실제로는 더 많은 기능을 제공한다.
• “스프링 빈 조회”에서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.
• DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 선언해보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy{
		...
}

@Component
public class RateDiscountPolicy implements DiscountPolicy{
		...
}

• 그리고 이렇게 의존관계 자동 주입을 실행하면 NoUniqueBeanDefinitionException 오류가 발생한다.

... : expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

• 오류 메세지도 하나의 빈을 기대했는데, fixDiscountPolicy, rateDiscountPolicy 두개가 발견되었음을 알려준다.
• 이때 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.
  • 이름만 다르고 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 불가능하다.
• 스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존관계 자동 주입에서 해결하는 여러 방법이 있다.

@Autowired 필드 명, @Qualifier, @Primary

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

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

@Autowired 필드 명 매칭

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

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy;

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

@Autowired 매칭 순서 정리

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

@Qualifier 사용

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

Qualifier 추가

@Component
@Qualified("mainDiscountPolicy")
public class RateDiscountPolicy impolements DiscountPolicy {...}

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

OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

		...
}

• @Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 찾지 못하면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
• 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋다.
• 생성자 주입 뿐만 아니라 수정자 주입에서도 사용 가능하다.
• 스프링 빈을 직접 등록할 때도 @Qualifier를 동일하게 사용할 수 있다.

@Qualifier 순서 정리

1. @Qualifier끼리 매칭
2. 스프링 빈 이름으로 매칭
3. 찾지 못하면 NoSuchBeanDefinitionException 예외 발생

@Primary 사용

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

RateDiscountPolicy

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{...}

• RateDiscountPolicy가 우선권을 갖는다.
• @Qualifier는 주입 받을 때 모든 코드에 @Qualifier를 붙여주어야 하는 단점이 있다.
• 반면 @Primary는 @Qualifier를 붙이지 않아도 된다.

@Primary, @Qualifier 활용

• 데이터베이스 컨넥션과 관련한 정보
  • 메인 데이터베이스가 95%
  • 서브 데이터베이스는 아주 가끔 사용함.
• 이런 경우에 @Qualifier를 사용하는 경우,
  • 메인 데이터베이스를 가져오는 경우에도 Qualifier를 해주고,
  • 서브 데이터베이스를 가져오는 경우에도 Qualifier를 해주는 경우에도 귀찮음.
• 팀에서 메인 DB를 Primary로 정하고, 특정 경우에 Qualifier로 사용.

우선순위

• @Primary는 기본값처럼 동작하는 것이고, @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 {
}

RateDiscountPolicy

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{
	...
}

OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

		...

}

• 애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
• @Qualifer뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.
• 단적으로 @Autowired도 재정의할 수 있다.
  • 물론스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의하는 것은 유지보수에 더 혼란만 가중할 수 있다.