의존관계 자동 주입 [@Autowired 필드 명, @Qualifier, @Primary, 애노테이션 생성]

조회 빈이 2개 이상 - 문제

private final DiscountPolicy discountPolicy;

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

 

• @Autowired는 Type으로 조회한다. == ac.getBean(DiscountPolicy.class);
• 타입으로 조회하면 선택된 빈이 2개 이상일 때, 문제가 발생한다.
• DiscountPolicy의 하위 타입인 FixDiscountPolicy와 RateDiscountPolicy 둘다 스프링 빈으로 선언하면 오류가 발생한다.
• 두개 다 @Component 등록

NoUniqueBeanDefinitionException: DiscountPolicy가 두개가 등록되어 타입으로 찾을 수 없다.

• 하위 타입으로 지정할 수 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 또한 이름만 다르고 똑같은 타입의 스프링 빈이 있는 경우 해결되지 않는다.
• 스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존관계 자동 주입에서 해결하는 여러 방법이 있다.

 

@Autowired 필드 명, @Qualifier, @Primary

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

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

1. @Autowired 필드 명 매칭

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

 

필드 명을 빈 이름으로 변경

@Autowired // 생성자가 하나라면 @Autowired 생략가능
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = rateDiscountPolicy;
}

// or

@Autowired
private final DiscountPolicy rateDiscountPolicy;

 

🐤 @Autowired 매칭 정리

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

 

2. @Qualifier사용

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

 

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

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

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

@Component
public class OrderServiceImpl implements OrderService{

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

Qualifier를 보고 mainDiscountPolicy를 찾아 반환해 준다.

 

💡 Quailifier로 주입할 때, mainDiscountPolicy를 못찾으면 어떻게 될까?

• mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋다.
• 추가적으로 Bean 등록시 @Qualifier를 동일하게 사용할 수 있다.

 

✔️ 정리

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

 

3. @Primary

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

 

🐤 @Primary와 @Qualifier둘 중 무엇을 사용할까?

• @Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier를 붙여주어야 한다는 것.
• @Primary를 사용하면 @Qualifier를 붙일 필요가 없다.

 

@Primary, @Qualifier 활용

메인 db 커넥션은 @primary를 사용 서브 db 커넥션은 @Qualifier로 지정하자.

 

✔️ 우선순위 

• 스프링은 자동보다는 수동이 우선순위다.
• @Primary는 기본값 처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다.
• 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 @Qualifier가 우선권이 높다.

 

애노테이션 직접 만들기

@Qualifier("mainDiscount")로 작성시 문자이기 때문에 컴파일 시 타입 체크가 되지 않는다. 애노테이션을 만들어서 문제를 해결할 수 있다.

 

애노테이션 생성

package hello.core.annotation;

@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 final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

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