[스프링 핵심 원리] 07. 의존관계 자동 주입 - 조회 빈이 2개 이상(문제) & @Autowired 필드 명, @Qualifier, @Primary & 애노테이션 직접 만들기

(인프런) 김영한님의 스프링 핵심 원리-기본편을 공부하고 리뷰한 글입니다.

5. 조회 빈이 2개 이상(문제) 

1. @Autowired

@Autowired는 타입(Type)으로 조회해 의존관계를 주입해준다.

// ac.getBean(DiscountPolicy.class)
@Autowired
private DiscountPolicy discountPolicy

DiscountPolicy 타입으로 스프링 빈을 조회해 주석한 코드와 유사하게 동작한다. (실제로는 더 많은 기능 제공)

 

2. 조회 빈이 2개 이상일 때 문제 예시 코드 작성

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

해당 문제 상황을 만들기 위해 DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 두 개를 스프링 빈으로 등록해보자.

1) FixDiscountPolicy 스프링 빈 등록 - @Component 애노테이션 추가

@Component
public class FixDiscountPolicy implements DiscountPolicy {...}

2) RateDiscountPolicy 스프링 빈 등록 - @Component 애노테이션 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {...}

 

3. 전체 테스트 실행 결과

전체 테스트를 실행해보면 AutoAppConfigTest > basicScan()에서 오류가 발생한다.

basicScan()의 아래 코드에서 AutoAppConfig 설정정보로 스프링 컨테이너를 생성할 때, 컴포넌트 스캔으로 의존관계 주입을 하는 과정에서 오류가 발생하는 것이다.

의존 관계 자동 주입을 실행하면, NoUniqueBeanDefinitionException 오류가 발생한다.

• DiscountPolicy 타입의 빈 1개를 기대했는데, fixDiscountPolicy, rateDiscountPolicy 2개가 발견되었다고 알려줌

오류를 고치기 위해 하위 타입(FixDiscountPolicy, RateDiscountPolicy)로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 역할이 아닌 구현에 의존하여 DIP를 위배하고 유연성이 떨어진다. 또한 이름만 다르고 완전히 똑같은 타입의 스프링 빈이 2개 이상이면 여전히 해결이 불가능하다.

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

6. @Autowired 필드 명, @Qualifier, @Primary

<의존관계 주입을 할 때, 조회 대상 빈이 2개 이상일 때 해결 방법>

1) @Autowired 필드 명 매칭

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

3) @Primary 사용

 

1. @Autowired 필드 명 매칭

@Autowired는 타입 매칭을 시도하고 해당 타입의 조회 대상 빈이 2개 이상이면, 필드 이름(파라미터 이름)으로 빈 이름을 추가 매칭한다.

1) 기존 코드

@Autowired
private DiscountPolicy discountPolicy

 

2) 필드 명을 빈 이름으로 변경

필드 명을 rateDiscountPolicy로 변경한다. DiscountPolicy로 매칭한 결과가 fixDiscountPolicy, rateDiscountPolicy 2개이므로 필드명 매칭을 통해 rateDiscountPolicy 빈을 주입해준다.

@Autowired
private DiscountPolicy rateDiscountPolicy

 

<@Autowired 매칭 정리>

1) 타입 매칭

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

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

 

2. @Qualifier 사용

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

 

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

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

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

(참고) 직접 빈 등록시에도 @Qualifier를 사용할 수 있다. 

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

 

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

2-1) 생성자 자동 주입 예시

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

 

2-2) 수정자 자동 주입 예시

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
	return discoutnPolicy;
}

 

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하고 좋다.

 

<@Qualifier 정리>

1) @Qualifier끼리 매칭

2) 빈 이름 매칭

3) NoSuchBeanDefinitionException 예외 발생

 

3. @Primary 사용

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

1) 초기 상태

초기에 Ctrl+Alt+B 로 확인했을 때, FixDiscountPolicy가 RateDiscountPolicy 보다 위에 뜬다.

2) rateDiscountPolicy가 우선권을 가지도록 변경

RateDiscountPolicy 앞에 @Primary를 붙여주고, FixDiscountPolicy는 그대로 둔다.

@Component
@Primary	// 우선권 부여
public class RateDiscountPolicy implements DiscountPolicy{...}

@Component
public class FixDiscountPolicy implements DiscountPolicy{...}

 

2) 사용 코드

우선권을 가질 빈의 클래스 앞에 @Primary를 붙여주면, 생성자/수정자 주입 코드는 수정할 필요없이 자동으로 우선권을 가진 빈이 의존관계 주입된다. 실행해보면 문제없이 잘 동작하는 것을 확인할 수 있다.

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

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

 

4. @Primary, @Qualifier 비교

1) @Qualifier 는 주입 받을 때 모든 코드에 @Qualifier를 붙여야한다는 단점이 있다.

2) @Primary 는 주입 받을 때 기존 코드를 건드릴 필요가 없다. 그렇기 때문에 실무에서도 자주 사용한다.

 

<@Primary, @Qualifier 활용>

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 하자. 

1) 메인 데이터베이스의 커넥션을 획득하는 스프링

- @Primary 적용: 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회한다.

2) 서브 데이터베이스의 커넥션을 획득하는 스프링 빈

- @Qualifier 지정: 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

 

5. @Autowired 필드명 매칭 vs @Qualifier vs @Primary 우선 순위

스프링은 자동보다는 수동, 넓은 범위의 선택권보다 좁은 범위의 선택권이 우선 순위가 높다.

1) @Primary vs @Qualifier

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

그래서 @Qualifier가 @Primary보다 우선권이 높다.

2) @Autowired 필드명 매칭 vs @Primary

@Primary 가 @Autowired 필드명 매칭 보다 우선권이 높다.

3) 정리

@Qualifier > @Primary > @Autowired 필드명 매칭

---

7-6. @Autowired 필드 명, @Qualifier, @Primary 질문 모음

Q. Lombok 라이브러리의 @RequiredArgsConstructor를 사용할 때는 생성자 파라미터 명을 명시할 수 없는데, 어떻게 해야하나?

OrderServiceImpl에 @RequiredArgsConstructor가 붙어있으면, 생성자가 자동으로 생성되기 때문에 생성자 파라미터 이름을 조회하고자 하는 빈 이름으로 변경해줄 수 없다. Lombok 라이브러리를 사용할 때, 필드 명을 빈 이름으로 변경해주면 된다. 롬복에서 필드명을 기준으로 생성자 파라미터 명을 생성하기 때문이다.

[출처] https://www.inflearn.com/questions/535475

 

Q. @Autowired 필드 명 매칭, @Primary 방식 중 우선순위가 더 높은 것은?

A. 우선순위: @Primary > @Autowired 필드명 매칭

@Autowired는 먼저 타입으로 조회 후, 같은 타입이 2개 이상 있을 경우 필드명에 해당하는 빈을 조회한다.

@Primary를 설정하면 타입으로 조회하는 부분에서 문제가 해결되기 때문에 필드 이름으로 빈을 찾을 필요가 아예 없다. 그러므로 결론적으로 @Autowired 필드명에 해당하는 빈이 있다고 하더라도 @Primary 가 붙은 스프링 빈이 주입되는 것이다.

[참고] https://www.inflearn.com/questions/129469

 

Q. @Qualifier, @Primary 방식 중 우선순위가 더 높은 것은?

A. 우선순위: @Qualifier > @Primary

- rateDiscountPolicy : @Primary 적용

- fixDiscountPolicy: @Qualifier("subDiscountPolicy") 적용

실제로 두 개를 다 적용해보면, @Qualifier를 설정한 스프링 빈이 주입되는 것을 확인할 수 있다.

[참고] https://www.inflearn.com/questions/541579