Section 7. 의존관계 자동 주입

지난 시간에 이어서 마저 공부하자!

✔ 조회 빈이 2개 이상 - 문제

@Autowired
private DiscountPolicy discountPolicy

@Autowired는 타입으로 조회하기 때문에, 위의 코드는 ac.getBean(DiscountPolicy.class) 이 코드와 유사하게 동작한다.

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

만약 DiscountPolicy의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘 다 스프링 빈으로 선언하고 의존관계 자동 주입을 실행해보면!

NoUniqueBeanDefinitionException 오류가 발생한다.
✔ NoUniqueBeanDefinitionException : 하나의 빈을 기대했는데, 두 개의 빈(FixDiscountPolicy , RateDiscountPolicy)이 발견되었다는 오류이다.

그래서 이 에러를 해결하기 위해서 DiscountPolicy가 아닌, FixDiscountPolicy나 RateDiscountPolicy로 지정할 수도 있다.
하지만 이렇게 하위 타입으로 지정하는 것은 DIP를 위배하며, 유연성도 떨어진다.😢

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

그럼 지금부터 해결방법에 대해 알아보자!

✔ @Autowired 필드명, @Qualifier, @Primary

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

• @Autowired 필드명 매칭
• @Qualifier → @Qualifier끼리 매칭 → 빈 이름 매칭
• @Primary 사용

1. @Autowired 필드명 매칭

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

기존 코드

@Autowired
private DiscountPolicy discountPolicy

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

필드명 매칭은 타입 매칭을 먼저 시도하고, 여러 빈이 조회되면 추가로 동작하는 기능이다.

2. @Qualifier 사용

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

빈 등록시 @Qualifiter를 붙여준다.

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

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

주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.
→ 이렇게 하면 RateDiscountPolicy가 호출되는 것!

생성자 자동 주입 예시

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

지금은 잘 찾았지만, 만약@Qualifier("mainDiscountPolicy")를 못 찾는다면 어떻게 될까?
바로! mainDiscountPolicy라는 이름의 스프링 빈을 추가적으로 찾는다.

🙅🏻‍♀️ 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 명확하므로 @Qualifiter끼리 비교하는 용도로만 사용하자!

매칭되는 빈도 없다면, NoSuchBeanDefinitionException 예외가 발생한다.

3. @Primary 사용

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

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

→ @Primary를 통해 RateDiscountPolicy가 우선권을 갖도록 하였다.

📌 정리

1. @Autowired 매칭

• 타입 매칭
• 타입 매칭 결과가 2개 이상이면 필드명, 파라미터명으로 빈 이름 매칭

2. @Qualifier 매칭

• @Qualifier끼리 매칭 → 없으면 빈 이름 매칭 → 없으면 NoSuchBeanDefinitionException 예외 발생
• 명확성을 위해 @Qualifiter끼리 비교하는 것이 좋음!

3. @Primary 사용

• @Primary 애노테이션을 통해 우선권을 부여한다.
  
  

+) @Qualifier, @Primary 우선순위

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

✔ 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 @Qualifier 애노테이션에 이름을 부여서 매칭할 때, 이름이 문자열이기 때문에 컴파일시 타입 체크가 안된다.

무슨 말이냐면,
이쪽에서는 mainDiscountPolicy이렇게 썼는데, 다른 코드에서는 maindiscountPolicy 이런 식으로 오타가 나도 에러를 뱉지 않는다는 말이다!

그래서 이런 경우에는 애노테이션을 직접 만들어보는 것으로 해결할 수 있다!

package hello.core.annotation;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.*;

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

이렇게 애노테이션을 직접 만들어서

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

이런식으로 사용할 수 있다!

📌 참고

@Qulifier뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있으며, @Autowired도 재정의 할 수 있다. 그렇다고 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하지는 말자🙅🏻‍♀️

🔗 코드 확인하기

✔ 조회한 빈이 모두 필요할 때, List, Map

지금까지 조회 빈이 2개 이상일 때 여러 방법을 통해서 하나를 선택하게끔 했다.

하지만 조건에 맞는 여러 빈이 모두 필요할 때도 있을 것이다.

예를 들어 점원이 고객에게
① 총 금액에서 1000원을 할인 (Fix)
② 총 금액의 10%를 할인 (Rate)
이 두 가지 중에서 고를 수 있는 선택권을 준다고 가정해보자.

🔗 코드 확인하기

1. 로직 분석

DisCountService는 Map으로 모든 DiscountPolicy(fixDiscountPolicy, rateDiscountPolicy)를 주입받는다.

discount() 메소드는
1. fixDiscountPolicy → map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행
2. rateDiscountPolicy → rateDiscountPolicy 실행

이렇게 경우에 따라 다른 스프링 빈을 찾아서 실행한다.

2. 주입 분석

• Map<String, DiscountPolicy>: map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• List<DiscountPolicy>: DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담는다.
• 만약 해당 타입 스프링 빈이 없다면, 빈 컬렉션이나 Map을 주입한다.

✔ 자동, 수동의 올바른 실무 운영 기준

지금까지 스프링 컨테이너에 스프링 빈을 등록하는 2가지 방법(자동/수동)에 대해 알아보았다.

• 자동: @Component Scan + @Component
• 수동: Appconfig 파일 + @Bean/<bean>

그렇다면 언제 어떤 방식을 사용하는 것이 좋을까?

⭐ 편리한 자동 기능을 기본으로 사용하자!

배우신 분들이 만드신 스프링은 @Component뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.

또한, 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 쉽고 간단하게 끝낼 수 있는 일을 굳~이~ 수동으로 하지는 말자🙄

결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

그렇다면 수동 빈 등록은 아예 안 쓰나요😢?

🙅🏻‍♀️ 아닙니다!

숫자도 많고, 한번 개발하면 유사한 패턴이 있는 업무 로직은 자동 기능을 사용하는 것이 좋다.

반면에 업무 로직보다 수도 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미치는 기술 지원 로직은 문제가 발생했는지 파악이 잘 안되는 문제가 있기 때문에 이런 경우에는 가급적 수동 빈 등록을 사용해서 명시적으로 드러내는 것이 좋다.

📌 업무 로직과 기술 지원 로직

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

• 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
• 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나 공통 로그 처리처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

💡 정리

애플리케이션에서 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수에 좋다!

그리고, 비즈니스 로직 중에서 다형성의 활용이 많은 경우도 수동 빈으로 등록하는 것이 좋다!

다형성의 활용이 많은 경우, 코드를 한번에 쉽게 파악하기 어렵다!
그래서 수동 빈으로 등록하거나, 자동으로 할 경우는 특정 패키지에 같이 묶어두는 것이 이해하기도 쉽고, 인수인계도 편하다!

📌 정리

자동 기능을 기본적으로 사용하자!
직접 등록하는 기술 지원 객체는 수동 등록을 하고, 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자😊

📘 오늘의 TIL 정리

스프링을 만드신 분들은 정말 천재들이신 것 같다,, 알면 알수록 너무 좋은 기능만 제공한다😮

드디어 의존관계 자동 주입 끝!