의존관계 주입 - 조회 빈이 2개 이상

 

@Autowired 는 타입(Type)으로 조회한다. 타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다. 

ac.getBean(DiscountPolicy.class)

타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다

 

예를 들어서 DiscountPolicy 타입의 빈 2개가 등록되고 DiscountPolicy 타입의 빈을 주입받으려고 한다고 하자

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

@Autowired
private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생한다.

 

@Autowired 필드 명, @Qualifier, @Primary

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

1. @Autowired 필드 명 매칭
2. @Qualifier → @Qualifier끼리 매칭 → 빈 이름 매칭
3. @Primary 사용

 

@Autowired 필드 명 매칭

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

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

 

필드 명을 빈 이름으로 변경

@Autowired
//private DiscountPolicy discountPolicy
private DiscountPolicy rateDiscountPolicy

흐름 정리

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

 

@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. (스프링 빈으로 등록할 때 @Qualifier를 사용안하고 주입할 때만 사용했을 경우)

@Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.

 

직접 빈 등록시에도 사용가능

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

 

흐름을 정리하자면 

1. @Qualifier끼리 매칭
2. 1번 실패하면 빈 이름 매칭
3. 2번도 실패하면 NoSuchBeanDefinitionException 예외 발생

 

@Primary 사용

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

 

//rateDiscountPolicy 가 우선권을 가지도록 설정
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

@Primary vs. @Qualifier

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

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

 

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다 ("mainDiscountPolicy"에서 오타가나면 오류를 찾기 힘들다)

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
    @MainDiscountPolicy DiscountPolicy discountPolicy) { 
    //@MainDiscountPolicy에 철자 오류가 나면 컴파일시 확인해준다
    
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

 

애노테이션에는 상속이라는 개념이 없는데 우리가 만든 애노테이션(@MainDiscountPolicy)이 @Qualifier의 기능을 어떻게 수행할 수 있는걸까?

→ 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원 해주는 기능이다.

 

물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.