[SPRING] @Autowired 필드명, @Qualifier, @Primary

문제 상황

조회 대상 빈이 2개 이상이어서 NoUniqueBeanDefinitionException이 발생하는 상황

해결 방법

1. Autowired 필드 명 매칭

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

기존 코드

@Autowired
private DiscountPolicy discountPolicy

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

필드 명이 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 {}

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

생성자 자동 주입 예시

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

수정자 자동 주입 예시

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
    return discountPolicy;
}

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

ComponentScan이 아닌, 직접 빈 등록 시에도 @Qualifier를 동일하게 사용할 수 있다.

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

@Qualifier 정리

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

3.🌟 @Primary 사용

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

우선권 부여

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

@Component
@Primary // 우선권을 가짐!
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

사용코드

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

// 수정자
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy){
    return discountPolicy;
}

🤔 무엇을 사용할까?

@Primary와 @Qualifier 중에 어떤 것을 사용하면 좋을 지 고민이 될 것이다.
@Qualifier의 단점은 주입 받을 때 모든 코드에 @Qualifier를 붙여주어야 한다는 점이다.
반면에 @Primary를 사용하면 이렇게 @Qualifier를 붙일 필요가 없다.

@Primary와 @Qualifier의 활용

자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스피링 빈이 있고, 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.
메인 db의 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 편리하게 조회하고, 서브 db의 커넥션 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
물론 메인 db의 스프링 빈을 등록할 때 @Qualifier를 지정해주는 것은 상관없다.

우선순위

@Primary는 기본값처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다.
따라서 @Primary보다 @Qualifier가 우선순위가 높다.

---

💛 개인 공부 기록용 블로그입니다. 👻

맨 위로 이동하기