[섹션 7-6] @Autowired 필드 명, @Qualifier, @Primary

 

지난 글에서 @Autowired를 사용할 때 같은 타입으로 조회되는 빈이 2개인 경우 오류가 발생했었다. 

 

@Autowired 로 빈을 자동으로 주입할 때, 특정한 빈을 지정해주는 방법이 무엇인지 알아보자

 

---

 

 

 

조회 대상 빈이 2개 이상일 때 해결 방법은 크게 3가지가 있다. 

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

 

 

1.  @Autowired 필드명 매칭

 

: @Autowired 는 먼저 타입으로 빈을 찾고, 찾은 빈이 여러개라면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다. 

 

 

기존코드

@Autowired
private  final DiscountPolicy   discountPolicy;

 

필드명을 빈 이름으로 변경 

@Autowired
private  final DiscountPolicy rateDiscountPolicy;

 

다음코드와 같이 필드명을 주입받고자 하는 빈 이름으로 변경하면,

@Autowired가 타입으로 조회 후 rateDiscountPolicy와 fixDiscountPolicy 라는 2개의 빈을 찾고 나서 

필드 이름으로 추가 매칭하여 우리가 원하는 rateDiscountPolicy를 자동으로 주입해주게 된다. 

 

 

 

다시한번 테스트 코드를 수행하여 의존 관계가 자동으로 잘 주입되었는지 확인해보자

• 위의 설명에서는 필드 주입 방식으로 했지만, 우리의 코드는 생성자 주입 방식을 이용하고 있으므로
• 파라미터의 이름을 주입받고자하는 빈의 이름으로 바꿔주자

 

수정된 OrderServiceImpl 코드

@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;

    }

 

 

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

 

※ 참고 : 참고로 나는 필드명으로 주입 받는 코드를 짜도 주입이 안되는 오류가 발생했다.. 그래서 그냥  @Qualifier을 사용하여 테스트를 성공했지만 일단 이런 방법도 있다는 것을 알아두자

같은 오류가 발생한다면 아래의 질문 글을 참고해보자
인프런- 필드명으로 의존 관계 주입 받을때 발생하는 오류

 

 

 

 

2. Qualifier 사용 

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

 

빈 등록시 @Qualifier을 붙여준다

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

 

 

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

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

      @Autowired
      public OrderServiceImpl(@Qualifier("memorymemberRepository")MemberRepository memberRepository
      , @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {

        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;

    }

 

 

 

그런데,   @Qualifier  로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까?

그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.

 

 

하지만 @Qualifier은 @Qualifier을 찾는 용도로만 사용하는게 명확하고 좋다.

괜히 등록한 이름의 빈도 찾으니까.. 라며 생각하지말고  @Qualifier로 등록한 값이 들어가는 경우만 생각하자는 뜻이다. 

 

 

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

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

 

 

3. @Primary

@Primary는 우선수위를 정하는 방법이다. @Autowired로 여러개의 빈이 조회되었을 때 @Primary 가 우선권을 가진다.

 

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

@Component
@Primary 
public class RateDiscountPolicy implements DiscountPolicy {} 

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

OrderServiceImpl 코드

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

      @Autowired
      public OrderServiceImpl(@Qualifier("memorymemberRepository")MemberRepository memberRepository,DiscountPolicy discountPolicy) {

        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;

    }

 

 

이후에 테스트를 수행하면 discountPolicy의 값으로 RateDiscountPloicy가 잘 들어갔음을 알 수 있다. 

discountPolicy = hello.core.discount.RateDiscountPolicy@76a36b71

 

 

 

---

 

 

 

여기까지 보면 @Qualifier와 @Primary 중에서 어떤 것을 사용하면 좋을지 고민이 될 것이다. 

@Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier을 붙여줘야한다는 것이다. 

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

 

반면에 @Primary를 사용한다면 우선권을 주고 싶은 클래스에만 어노테이션을 추가해주면 된다. 

 

 

 

@Primary, @Qualifier 활용

 

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

메인 데이터베이스의 커넥션을 획득하 는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고,  서브 데이터베이스 커넥션 을 획득할 때에는 @Qualifier 을 지정해서 명시적으로 획득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

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

 

 

우선순위

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

이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier 가 우선권이 높다.