의존관계 자동 주입 - 조회 빈 이 2개 이상으로 충돌이 났을때

@Autowired는 타입(Type)으로 조회한다.

때문에 부모 클래스를 상속받은 자식 클래스라면 @Componet를 통해서 언제든지 충돌이 나는 경우가 발생한다.

아래 예를 보자.

package hello.core.order;

import hello.core.discount.DiscountPolicy;
import hello.core.member.*;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;


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

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member newMember = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(newMember, itemPrice);

        return new Order(memberId, itemName, itemPrice, discountPrice);
    }

    // 테스트 용도
    public MemberRepository getMemberRepository() {
        return memberRepository;
    }
}

package hello.core.discount;

import hello.core.member.Grade;
import hello.core.member.Member;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.stereotype.Component;

@Component
public class RateDiscountPolicy implements DiscountPolicy{

    ...
}

package hello.core.discount;

import hello.core.member.Grade;
import hello.core.member.Member;

@Componet
public class FixDiscountPolicy implements DiscountPolicy {
    private int discountFixAmount = 1000;

   ...
}

• 위와 같이 Autowired가 걸려있을 경우 현재 DiscountPolicy의 타입이 2개임으로 충돌이 발생할 것이다. NoUniqueBeanDefinitionException
• 오류 메세지도 친절하게 하나의 빈을 기대했는데 fixDiscountPolicy와 rateDiscountPolicy2개가 발견되었다고 알려준다.

이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.

 

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

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

[해결 방법 1] - @Autowired 필드 명 매칭

• @Autowired는 타입 매칭을 시도한 후 빈이 2개 이상일 경우 파라미터 이름으로 빈 이름을 매칭 한다. 
• 아래 예시를 보면 DiscountPolicy를 상속받은 두개의 클래스(fixDiscountPolicy와 rateDiscountPolicy)에 둘 다 @Componet를 등록하였지만, 2개가 발견이 된 후 필드명과 매칭이 되는 rateDiscountPolicy가 실행되는 것이다.

[결론] 스캔 순서 :  Type > 2개이상 발견 > 필드명과 매칭 되는 클래스 연결

package hello.core.order;

import hello.core.discount.DiscountPolicy;
import hello.core.member.*;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{
    private final MemberRepository memberRepository;
    private final DiscountPolicy rateDiscountPolicy; // 필드명을 수정

	...
}

 

[해결 방법 2] - @Qualifier 사용

@qualifier는 추가 구분자를 붙여주는 방법이다.

주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

 

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

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

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

[결론] 스캔 순서 : @Qualifier 끼리 매칭 > 빈 이름 매칭 > 없을 경우 NoSuchBeanDefinitionException 발생

 

[해결 방법 3] - @Primary 설정

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

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

2) 사용코드

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

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

코드를 실행시키면 @Primary를 등록한 것이 실행되는 것을 알 수 있을 것이다.

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

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

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

 

@Primary, @Qualifier 활용

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

우선순위

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

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

 

결론

오늘은 @Componet가 2개 이상으로 충돌이 났을 때 대처 방법을 알게 되었다.

하지만 강의 중에서 무엇보다 중요했던 것은 애매한 것보다 확실한 것을 사용해야 된다는 것이다.

예를 들면 위와 같이 @Qualifier를 끼리 매칭하고 없을 시 빈 이름으로 매칭 한다고 해서 빈 이름으로 등록할 경우 추후에 발생하는 오류를 찾기는 더 힘들 것이다.

 

 

 

이 글은 인프런의

제목 : 스프링 핵심 원리 - 기본편

강사 : 김영한 님의 동영상을 참조해 만들었습니다.