[Spring core basic] 36 - 주입 받을 타입의 빈이 2개 이상인 경우

참고

Spring core basic 시리즈는 김영한 님의 "스프링 핵심 원리 - 기본편" 강의를 정리한 글입니다. 글에 첨부된 사진은 해당 강의의 강의 자료에서 캡쳐한 것입니다. 제 Github에만 올려뒀다가, 정보 공유와 강의 홍보(?)를 위해 블로그에도 업로드합니다. 마크다운을 잘 쓰지 못해서 가독성이 조금 떨어지는 점 양해 바랍니다.

 

스프링 핵심 원리 - 기본편 - 인프런 | 강의

주입 받을 타입의 빈이 2개 이상인 경우

@Autowired 는 타입으로 주입 받을 빈을 조회한다.

@Autowired
private DiscountPolicy discountPolicy;

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다 (실제로는 더 많은 기능을 제공한다).

ac.getBean(DiscountPolicy.class)

문제가 발생하는 경우

스프링 빈 조회에서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다. DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy을 둘 다 스프링 빈으로 등록해보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy{ }

@Component
public class RateDiscountPolicy implements DiscountPolicy{ }

그리고 의존관계 자동 주입을 테스트 해 보면,

AutoAppConfigTest.java

//package, import 생략

public class AutoAppConfigTest {

    @Test
    void basicScan() {
        ApplicationContext ac =
        new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberServiceImpl.class);

        OrderServiceImpl bean = ac.getBean(OrderServiceImpl.class);
        MemberRepository memberRepository = bean.getMemberRepository();
        System.out.println("memberRepository = " + memberRepository);
    }
}

ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class); 이 코드에서, 즉 빈을 등록하고 의존관계를 주입하는 단계에서 오류가 발생한다.

OrderServiceImpl .java

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    //생략...
}

discountPolicy에 빈을 주입하는 단계에서 에러가 난 것이다.

No qualifying bean of type 'com.kloong.corebasic1.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

오류 메세지를 보면, 하나의 대응하는 빈을 기대했는데, fixDiscountPolicy와 rateDiscountPolicy 2개를 발견했다고 한다.

이때 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 역할이 아닌 구현에 의존해서는 안된다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.

스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

문제 해결

크게 3가지 방법이 있다.

• @Autowired 필드 명 매칭
• @Quilifier 사용
• @Primary 사용

1. @Autowired 필드 명 매칭

@Autowired 는 기본적으로 타입 매칭을 시도하고, 이때 타입이 동일한 빈이 여러개 존재하면, 필드 이름/파라미터 이름으로 빈을 매칭한다.

즉 기존 코드를,

@Autowired
private DiscountPolicy discountPolicy

다음과 같이 고치면

@Autowired
private DiscountPolicy rateDiscountPolicy

의존관계 주입 시 먼저 타입 매칭으로 fixDiscountPolicy와 rateDiscountPolicy 빈을 찾고, 같은 타입의 빈이 여러개 이므로 필드 명으로 매칭을 시도해서 rateDiscountPolicy를 주입받는다.

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

@Autowired 매칭 정리

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

2. @Quilifier 사용

@Qualifier annotation을 사용하면 추가 구분자(쉽게 말하면 별명)를 붙여줄 수 있다. 빈 이름을 변경하는 것은 아니고, 빈에 일종의 별칭을 붙여주는 것이라고 이해하면 된다.

등록할 빈에 @Quilifier 를 붙여주고, 추가 구분자를 정해준다.

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

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

빈을 주입 받는 코드 (생성자, 수정자 등)에 @Quilifier 와 함께 주입할 빈에 해당하는 구분자를 적어준다.

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

@Qualifier 로 빈을 주입받을 때, 구분자에 해당하는 빈을 못 찾으면 어떻게 될까?

해당 구분자의 이름을 가진 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다 (앞에서 언급했지만 @Quilifier 는 빈 이름을 변경하는 것이 아니라 추가적인 구분자를 붙여주는 것이기 때문에 헷갈릴 여지가 크다).

컴포넌트 스캔이 아닌 수동 빈 등록시에도 @Qulifier 를 사용할 수 있다.

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

@Qulifier 정리

1. @Qualifier 로 매칭 시도
2. 해당 구분자를 가진 빈이 없는 경우, 구분자와 동일한 이름을 가진 빈 매칭
3. 실패 시 NoSuchBeanDefinitionException 예외 발생

3. @Primary 사용

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

컴포넌트 스캔에 의해 DiscountPolicy 타입의 빈이 2개 등록되지만, DiscountPolicy 타입의 의존관계 자동 주입을 하면 @Primary 에 의해 rateDiscountPolicy 빈이 주입된다.

@Qualifier 는 해당 빈을 주입 받는 모든 코드에 @Qualifier를 붙여주어야 한다는 단점이 있기 때문에, 타입이 같은 빈이 2개가 존재하고, 2개의 빈 중 하나의 빈을 거의 대부분의 경우에 의존관계 주입하는 경우 @Primary 를 사용하면 편하다.

@Primary, @Qualifier 활용 예시

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

@Primary, @Qualifier 우선순위

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