[Spring Boot][2] 7-2. 의존관계 자동 주입

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

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

DiscountPolicy 의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘 다 스프링 빈으로 선언해보면 어떻게 될까❓

@Component
  public class FixDiscountPolicy implements DiscountPolicy {}

@Component
  public class RateDiscountPolicy implements DiscountPolicy {}

의존관계도 자동 주입 해준다!

@Component
  private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException 오류가 발생한다!

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

⬆️ 오류메세지에서 보다시피 하나의 빈을 기대했는데 2개가 발견되었다고 알려준다!

이때 하위 타입으로 지정하는 방법도 있지만, 이건것은 DIP를 위배하고 유연성이 떨어진다.
그리고 이름만 다르고 완전히 똑같은 타입의 스프링 빈이 2개 있을 경우 해결이 안된다!
이와 같은 문제가 생길 경우, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.
지금부터 알아보도록 하자 😉

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

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

---

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

1️⃣ @Autowired 필드 명 매칭

@Autowired 는 처음에 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름이나 파라미터 이름으로 빈 이름을 추가 매칭한다!
-> 필드명이나 파라미터 이름을 보고 두개 빈 중에서 똑같은 것이 있으면 그걸 찾아온다

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

💡 @Autowired 매칭 정리
1. 타입 매칭 (빈이 하나일 경우)
2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭

2️⃣ @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 정리
1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. NoSuchBeanDefinitionException 예외 발생

📌 헷갈리기 때문에 그냥, @Qualifier는 @Qualifier를 사용하는 애들이랑 만 쓸 수 있다 라고만 기억하자!!

3️⃣ @Primary

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

  @Component
  @Primary
  public class RateDiscountPolicy implements DiscountPolicy {}

⬆️ rateDiscountPolicy 가 우선권을 가지도록 하려면 위와 같이 하면 된다!

---

🏷 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 라고 하면 컴파일 할 때 타입 체크가 안 된다.

✔️ hello.core/annotation/MainDiscountPolicy Annotation 생성

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

✔️ RateDiscountPolicy 수정

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

✔️ OrderServiceImpl 수정

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

애노테이션에는 상속이라는 개념이 없다
이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능!
@Qulifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.
단적으로 @Autowired도 재정의 할 수 있다
물론, 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있으므로 조심🤭

---

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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보자!
스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다🤭

✔️ test/../autowired/AllBeanTest.java 생성

package hello.core.autowired;
import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import java.util.List;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;

public class AllBeanTest {
    @Test
    void findAllBean() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
        DiscountService discountService = ac.getBean(DiscountService.class);
        Member member = new Member(1L, "userA", Grade.VIP);
        int discountPrice = discountService.discount(member, 10000,
                "fixDiscountPolicy");
        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).isEqualTo(1000);
    }

    static class DiscountService {
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policies;

        public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
            this.policyMap = policyMap;
            this.policies = policies;
            System.out.println("policyMap = " + policyMap);
            System.out.println("policies = " + policies);
        }

        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);
            return discountPolicy.discount(member, price);
        }
    }
}

✔️ 로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy 를 주입받는다.
• 이때 fixDiscountPolicy, rateDiscountPolicy 가 주입된다.
• discount() 메서드는 discountCode로 fixDiscountPolicy가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다.
  물론 rateDiscountPolicy가 넘어온다면 rateDiscountPolicy 스프링 빈을 찾아서 실행한다.

✔️ 주입 분석

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

💡 이렇게 사용하면 편리하게 쓸 수 있는 경우가 많다!
동적으로 빈을 선택해야 할 때, 맵으로 받아서 위와같이 코드를 짜면 정말 편리하게 (다형성 코드도 유지하면서) 사용할 수 있다!

---

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

✔️ 편리한 자동 기능을 기본으로 사용하자
근데 대체! 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용해야 하고, 어떤 경우에 설정 정보를 통해서 수동으로 빈을 등록해야(의존관계도 수동으로 주입)하는지 고민이 될 것이다🤔

결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세이다 !

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 사실 이상적이지만, 개발자 입장에서는 초큼,, 귀찮다,,ㅎ
스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을 하나하나 적는 것은 귀찮은 일😂
또 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.
그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다 !

✔️ 그러면 수동 빈 등록은 언제 사용하면 좋을까?
애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

1️⃣ 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 관련 로직을 처리하는 리포지토리 등이 모두 업무 로직에 포함된다. 보통 비즈니스 요구사항을 맞춰 개발할 때 추가되거나 변경된다.

• 업무 로직은 숫자가 굉장히 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느 정도 유사한 패턴이 있다.
• 이런 경우 자동 기능을 적극 사용하는 것이 좋다(너무 뻔하기 때문)🤷🏻‍♀️. 보통 문제가 발생해도 어느 부분에서 문제가 발생했는지 명확하게 파악하기 쉽다.

2️⃣ 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 등 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

• 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, (수는 적지만)보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다.
• 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 들어나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다.
• 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

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

✔️ 비즈니스 로직 중에서 다형성을 적극 활용할 때
비즈니스 로직 중에서도 수동 빈이 유리할 때도 있다!
바로 비즈니스 로직 중에서 다형성을 적극 활용할 때!!!!

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 봐보자🤔

DiscountService 가 의존관계 자동 주입으로 Map<String, DiscountPolicy> 에 주입을 받는 상황을 생각해보자.
여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한방에 파악할 수 있을까❓
자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다.
수동으로 등록하면 한번에 파악이 가능하다❗️
이런 경우 수동 빈으로 등록하거나 또는 자동으로 한다면 특정 패키지에 같이 묶어두는게 좋다!
핵심은 딱 보고 이해가 되어야 한다!

✔️ 정리
1️⃣ 편리한 자동 기능을 기본으로 사용하자
2️⃣ 직접 등록하는 기술 지원 객체는 수동 등록
3️⃣ 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자

---

스프링...참..조타...!
거짓말 치지 마