스프링 핵심원리 : 기본편 - 조회 빈이 2개 이상인 경우 문제해결

"인프런의 스프링 핵심원리 - 기본편 강의를 듣고 작성한 글 입니다."

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

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

의존관계 자동 주입 - 조회 빈이 2개 이상인 경우

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

@Autowired
private DiscountPolicy discountPolicy

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

ac.getBean(DiscountPolicy.class)

 

스프링 빈 조회에서 학습했듯이, 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

DiscountPolicy 의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 선언해보자.

- FixDiscountPolicy.java

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

- RateDiscountPolicy.java

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

그리고 아래와 같이 의존관계 자동 주입을 실행하면 NoUniqueBeanDefinitionException 오류가 발생한다.

@Autowired
private DiscountPolicy discountPolicy

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

오류 메시지가 친절하게도 하나의 빈을 기대했는데 fixDiscountPolicy, rateDiscountPolicy 2개가 발견 되었다고 알려준다.

 

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

그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.

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

 

@Autowired 필드 명, @Qualifier, @Primary

해결 방법을 하나씩 알아보자.

 

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

- @Autowired 필드 명 매칭

- @Qualifier -> @Qualifier 끼리 매칭 -> 빈 이름 매칭

- @Primary 사용

 

* @Autowired 필드 명 매칭

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

- 기존코드

@Autowired
private DiscountPolicy discountPolicy

- 필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

 

필드 명이 rateDiscountPolicy 이므로 정상 주입된다.

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

 

* @Autowired 매칭 정리

- 1. 타입 매칭

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

 

* @Qualifier 사용

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

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

- RateDiscountPolicy.java

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

- FixDiscountPolicy.java

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

 

주입 시에 @Qualifier 를 붙여주고 등록한 이름을 적어준다.

- OrderServiceImpl.java

생성자 자동 주입 예시

@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. @Qualifier 끼리 매칭했을 때 찾지 못한 경우 빈 이름으로 매칭한다.

3. 빈 이름으로도 매칭이 되지 않은 경우 NoSuchBeanDefinitionException 예외를 발생시킨다.

 

* @Primary 사용

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

rateDiscountPolicy 가 우선권을 가지도록 하자.

- RateDiscountPolicy.java

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

- FixDiscountPolicy.java

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

- OrderServiceImpl.java

생성자 자동 주입의 경우

@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 를 붙여주어야 한다는 점이다.

- OrderServiceImpl.java

@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 가 우선권이 높다.

 

 

어노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자열을 적으면 컴파일 시 타입 체크가 안된다. 다음과 같은 어노테이션을 만들어서 문제를 해결할 수 있다.

main 폴더 hello.core.annotation 패키지 아래 MainDiscountPolicy 클래스를 만들고 다음과 같이 코드를 작성하자.

- MainDiscountPolicy.java

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

이렇게 만든 어노테이션을 RateDiscountPolicy 와 OrderServiceImpl 클래스에 사용해보자.

- RateDiscountPolicy.java

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

- OrderServiceImpl.java

생성자 자동 주입의 경우

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

수정자 자동 주입의 경우

@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
    return discountPolicy;
}

 

어노테이션에는 상속이라는 개념이 없다. 이렇게 여러 어노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.

@Qualifier 뿐만 아니라 다른 어노테이션들도 함께 조합해서 사용할 수 있다. 단적으로 @Autowired 도 재정의 할 수 있다.

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