[스프링 핵심 원리 - 기본편] @Autowired 필드 명, @Qualifier, @Primary

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

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

@Autowired 필드 명 매칭

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

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

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

@Autowired 매칭 정리

• 1. 타입 매칭
• 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를 찾는 용도로만 사용하는게 명확하고 좋습니다.

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

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

@Qualifier 정리

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

@Primary 사용

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {

    ...

}

@Component
public class FixDiscountPolicy implements DiscountPolicy {

    ...

}

여기까지 보면 @Primary와 @Qualifier 중에 어떤 것을 사용하면 좋을지 고민이 될 것입니다.
@Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier를 분여주어야 한다는 점입니다.

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

반면에 @Primary를 사용하면 이렇게 @Qualifier를 붙일 필요가 없습니다.

@Primary, @Qualifier 활용

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

우선순위

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

참조

• 스프링 핵심 원리 - 기본편