minOS

의존관계 자동 주입(5) - 조회된 빈이 2개 이상일때 문제점과 해결 방법 본문

TIL/김영한의 스프링 핵심 원리

의존관계 자동 주입(5) - 조회된 빈이 2개 이상일때 문제점과 해결 방법

minOE 2024. 4. 22. 15:52
728x90

문제 - 조회된 빈이 두개 이상일때 

@Autowired는 타입으로 조회한다.
@Autowired
private final DiscountPolicy discountPolicy;​


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

@Component
public class RateDiscountPolicy implements DiscountPolicy{}

 

@Component
public class FixDiscountPolicy implements DiscountPolicy {}


이 상태에서 의존관계 자동 주입을 실행하면

@Autowired
private final DiscountPolicy discountPolicy;​



NoUniqueBeanDefinitionException 오류가 발생한다. - 하나의 빈을 기대했는데 2개가 발견되었다고 알려준다.

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


이때 하위 타입으로 지정할 수도 있지만 그럼 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈 2개가 있을 때 해결이 안된다.
스프링 빈을 수동 등록해서 문제를 해결해도 되지만 , 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

 

 

 

해결방법- @Autowired필드 명, @Quilifier, @primary

 

@Autowired 필드명 매칭

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

기존코드
@Autowired
private final DiscountPolicy discountPolicy;​


필드 명을 빈 이름으로 변경

@Autowired
private final DiscountPolicy rateDiscountPolicy;​

필드명이  rateDiscountPolicy이므로 주입된다.
필드명 매칭은 먼저 타입 매칭을 시도한 후, 그 결과 여러 빈이 있을 때 추가로 동작하는 기능이다.

@Autowired 매칭 정리
1. 타입 매칭
2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭

 

@Quilifier

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

빈 등록시 @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;
    }

수정자 예시
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository ;
    private final  DiscountPolicy discountPolicy;
    
    @Autowired
    public  DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")DiscountPolicy discountPolicy){
    	return discountPolicy;
   }

@Qualifier("mainDiscountPolicy")를 못찾으면 "mainDiscountPolicy"라는 이름의 스프링 빈을 찾는다.
하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다.

직접 빈 등록할 때도 @Qualifier사용 가능하다.

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


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

 

@Primary

@Primary는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.
RateDiscountPolicy가 우선권을 가지도록 하자
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{}​

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 


 생성자
@Component
//@RequiredArgsConstructor //final이 붙은 필드값에 대해 생성자를 만들어줌
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;
    }​


수정자

public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository ;
    private final  DiscountPolicy discountPolicy;
    
    @Autowired
    public  DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy){
    	return discountPolicy;
   }​




 

@Primary,@Quilifier활용

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

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