주니어 개발자 성장기

(22.11.21) 14. 의존관계 자동 주입(2) 본문

Spring/핵심

(22.11.21) 14. 의존관계 자동 주입(2)

Junpyo Lee 2022. 11. 21. 20:22

롬복과 최신 트랜드

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 다음과 같이 필드에 final 키워드를 사용하게 된다.

(final 키워드를 달면 생성자 호출 이후에는 변경이 불가능하다. - 상수)

하지만 생성자를 작성하는 것은 번거롭기 때문에 다음과 같은 방법을 쓴다.

  1. 생성자에 @Autowired 생략
    • 생성자가 1개라면 생략 가능하다.
  2. 롬복의 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

위의 두 방법을 동시에 사용하면 깔끔한 코딩이 가능하다.

 

조회 빈이 2개 이상 - 문제

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

따라서 같은 타입의 Bean이 두 개가 있으면 오류(NoUniqueBeanDefinitionException)가 발생한다.

 

이때 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 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를 붙여 준다.

예시 코드

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

 

생성자 자동 주입 예시

@Autowired
  public OrderServiceImpl(MemberRepository memberRepository,
                          @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
      this.memberRepository = memberRepository;
      this.discountPolicy = discountPolicy;
  }
  • 필드 주입, 생성자 주입에서도 사용 가능하다.
  • 같은 이름의 @Qualifier를 찾지 못하면 같은 이름의 스프링 빈을 추가로 찾는다.
    하지만, @Qualifier는 Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다. 

수동으로 빈을 등록하는 경우에도 @Qualifier를 동일하게 사용할 수 있다.

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

 

@Qualifier 정리

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

 

@Primary 사용

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

 

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}


@Component
public class FixDiscountPolicy implements DiscountPolicy {}

이렇게 하면 rateDiscountPolicy가 우선권을 갖게 된다.

  • @Qualifier보다 편리하다.
  • @Primary를 사용하는 것이 합리적이다.

우선순위

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

 

  • 실무 예시) 메인 DB 커넥션을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 DB 커넥션을 획득하는 빈은 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

 

출처: 스프링 핵심 원리 - 기본편 (김영한)