Spring - 의존관계 자동 주입(@Autowired 필드 명, @Qualifier, @Primary, 어노테이션 직접 만들기

@Autowired 필드 명, @Qualifier, @Primary

조회 대상 빈이 2개 이상일 때 해결 방법으로 세 가지가 있다.

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

@Autowired 필드명 매칭

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

기존

@Autowired
private DiscountPolicy discountPolicy

필드명을 빈 이름으로 변경

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

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

@Autowired 필드명 매칭 정리

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

@Qualifier 사용

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

사용방법

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

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}
// and
@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

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

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

3. 수정자 주입에도 똑같이 사용하면 된다.

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

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

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

주의

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 찾지 못 하면 mainDiscountPolicy라는 이름을 가진 스프링 빈을 추가로 찾는다.
하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 좋다.

@Primary 사용

@Primary는 우선순위를 정하는 방법이다. @Autowired를 사용할 때 여러 빈이 매칭되면 @Primary를 가진 메소드가 우선권을 가진다.

사용 코드

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}
// and
@Component
public class FixDiscountPolicy implements DiscountPolicy {}

//생성자
@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를 사용할까?
예를 들면 메인 DB가 있고 보조 DB가 있을 때, 메인에서 데이터를 가져올 때는 @Primary를 사용해서 가독성 좋고 @Qualifier에 지장받지 않으면서 조회를 하고, 서브 DB에서는 @Qualifier를 지정해서 명시적으로 획득하는 방법을 사용하면 코드를 깔끔하게 유지할 수 있다.

그럼 우선순위는 어떤 것이 높을까?
@Primary는 기본값 처럼 동작하고, @Qualifier는 매우 상세하게 동작하기 때문에 @Qualifier의 우선권이 높다.
스프링은 자동보다 수동이, 넓은 범위(어중간한 것)의 선택권 보다는 명확하게 좁은 범위의 선택권(자세한 것)이 우선순위가 높기 때문이다.

어노테이션 직접 만들기

@Qualifier("mainDiscountPolicy")라고 문자를 적으면 컴파일시 타입 체크가 되지 않는다.

해결 방법은 우선 어노테이션을 만들어준다

package hello.core.annotation;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

그리고 다음과 같이 코드를 수정하자!

// 인터페이스 구현체
@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

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

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

번외

어노테이션은 상속이라는 개념이 없기 때문에 이런 방법으로 여러 어노테이션을 모아 사용하는 기능은 스프링이 지원한다.
@Qulifier뿐 아니라 다른 어노테이션들도 함께 조합해서 사용할 수 있다.
물론 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있기 때문에 확실하게 필요한 상황에서 사용하는 것이 좋다.

출처 : 인프런 김영한 지식공유자님의 스프링 완전 정복 로드맵 강의